fiftyone.properties.MatchMethods Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of device-detection-core Show documentation
The newest version!
/* *********************************************************************
 * This Source Code Form is copyright of 51Degrees Mobile Experts Limited. 
 * Copyright © 2017 51Degrees Mobile Experts Limited, 5 Charlotte Close,
 * Caversham, Reading, Berkshire, United Kingdom RG4 7BY
 * 
 * This Source Code Form is the subject of the following patents and patent
 * applications, owned by 51Degrees Mobile Experts Limited of 5 Charlotte
 * Close, Caversham, Reading, Berkshire, United Kingdom RG4 7BY: 
 * European Patent No. 2871816;
 * European Patent Application No. 17184134.9;
 * United States Patent Nos. 9,332,086 and 9,350,823; and
 * United States Patent Application No. 15/686,066.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0.
 * 
 * If a copy of the MPL was not distributed with this file, You can obtain
 * one at http://mozilla.org/MPL/2.0/.
 * 
 * This Source Code Form is "Incompatible With Secondary Licenses", as
 * defined by the Mozilla Public License, v. 2.0.
 * ********************************************************************* */
package fiftyone.properties;

/**
 * Enumerator of possible methods used to obtain the match. Modified to also 
 * return a numeric value associated with the ENUM entry.
 * 
 *  NONE No match could be determined between the target User-Agent and
 *  the list of signatures. Defaults were used.
 *  
EXACT The signature returned matches precisely with the target 
 *  User-Agent.
 *  
NUMERIC The signature returned matches the target User-Agent with only
 *  minor differences between numeric numbers.
 *  
CLOSEST No signature matched precisely and some relevant characters
 *  may be different between the returned signature and the target User-Agent.
 *  The Match.Confidence property should be used to determine the degree of
 *  difference.
 *  
NEAREST The signature returned contains all the same sub strings as
 *  the target User-Agent, but there are minor differences in position.
 * 
 */
public enum MatchMethods {
    /**
     * No match could be determined between the target User-Agent and the list 
     * of signatures. Defaults were used.
     */
    NONE(0),
    /**
     * The signature returned matches precisely with the target User-Agent.
     */
    EXACT(1),
    /**
     * The signature returned matches the target User-Agent with only minor 
     * differences between numeric numbers.
     */
    NUMERIC(2),
    /**
     * NEAREST The signature returned contains all the same sub strings as
     *  the target User-Agent, but there are minor differences in position.
     */
    NEAREST(3),
    /**
     * No signature matched precisely and some relevant characters may be 
     * different between the returned signature and the target User-Agent.
     * The Match.Confidence property should be used to determine the degree 
     * of difference.
     */
    CLOSEST(4);
    
    private final int method;
    
    MatchMethods(int method) {
        this.method = method;
    }
    
    public int getMatchMethods() {
        return method;
    }
}