UserAgentStringParserImpl.java

/*******************************************************************************
 * Copyright 2012 André Rouél
 * 
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *   http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 ******************************************************************************/
package net.sf.uadetector.parser;

import javax.annotation.Nonnull;

import net.sf.qualitycheck.Check;
import net.sf.uadetector.datastore.DataStore;

/**
 * This parser is an implementation of {@code UserAgentStringParser} interface and can detect user agents. The analysis
 * is based on the read {@code Data} of the given data source.
 * 
 * @author André Rouél
 */
public class UserAgentStringParserImpl<T extends DataStore> extends AbstractUserAgentStringParser {

    /**
     * Storage for all detection informations for <i>UASparsers</i> from <a
     * href="http://user-agent-string.info/">http://user-agent-string.info</a>.
     */
    @Nonnull
    private final T store;

    /**
     * Constructs an {@code UserAgentStringParser} using the given UAS data as detection source.
     * 
     * @param store
     *            store for UAS data
     * @throws net.sf.qualitycheck.exception.IllegalNullArgumentException
     *             if the given argument is {@code null}
     */
    public UserAgentStringParserImpl(@Nonnull final T store) {
        super();
        Check.notNull(store, "store");

        this.store = store;
    }

    @Nonnull
    @Override
    protected T getDataStore() {
        return store;
    }

}