/*
 * This class was automatically generated with 
 * <a href="http://www.castor.org">Castor 1.1</a>, using an XML
 * Schema.
 * $Id$
 */

package jalview.binding.types;

  //---------------------------------/
 //- Imported classes and packages -/
//---------------------------------/

import java.util.Hashtable;

/**
 * Class FeatureMatcherByType.
 * 
 * @version $Revision$ $Date$
 */
public class FeatureMatcherByType implements java.io.Serializable {


      //--------------------------/
     //- Class/Member Variables -/
    //--------------------------/

    /**
     * The byLabel type
     */
    public static final int BYLABEL_TYPE = 0;

    /**
     * The instance of the byLabel type
     */
    public static final FeatureMatcherByType BYLABEL = new FeatureMatcherByType(BYLABEL_TYPE, "byLabel");

    /**
     * The byScore type
     */
    public static final int BYSCORE_TYPE = 1;

    /**
     * The instance of the byScore type
     */
    public static final FeatureMatcherByType BYSCORE = new FeatureMatcherByType(BYSCORE_TYPE, "byScore");

    /**
     * The byAttribute type
     */
    public static final int BYATTRIBUTE_TYPE = 2;

    /**
     * The instance of the byAttribute type
     */
    public static final FeatureMatcherByType BYATTRIBUTE = new FeatureMatcherByType(BYATTRIBUTE_TYPE, "byAttribute");

    /**
     * Field _memberTable.
     */
    private static java.util.Hashtable _memberTable = init();

    /**
     * Field type.
     */
    private int type = -1;

    /**
     * Field stringValue.
     */
    private java.lang.String stringValue = null;


      //----------------/
     //- Constructors -/
    //----------------/

    private FeatureMatcherByType(final int type, final java.lang.String value) {
        super();
        this.type = type;
        this.stringValue = value;
    }


      //-----------/
     //- Methods -/
    //-----------/

    /**
     * Method enumerate.Returns an enumeration of all possible
     * instances of FeatureMatcherByType
     * 
     * @return an Enumeration over all possible instances of
     * FeatureMatcherByType
     */
    public static java.util.Enumeration enumerate(
    ) {
        return _memberTable.elements();
    }

    /**
     * Method getType.Returns the type of this FeatureMatcherByType
     * 
     * @return the type of this FeatureMatcherByType
     */
    public int getType(
    ) {
        return this.type;
    }

    /**
     * Method init.
     * 
     * @return the initialized Hashtable for the member table
     */
    private static java.util.Hashtable init(
    ) {
        Hashtable members = new Hashtable();
        members.put("byLabel", BYLABEL);
        members.put("byScore", BYSCORE);
        members.put("byAttribute", BYATTRIBUTE);
        return members;
    }

    /**
     * Method readResolve. will be called during deserialization to
     * replace the deserialized object with the correct constant
     * instance.
     * 
     * @return this deserialized object
     */
    private java.lang.Object readResolve(
    ) {
        return valueOf(this.stringValue);
    }

    /**
     * Method toString.Returns the String representation of this
     * FeatureMatcherByType
     * 
     * @return the String representation of this FeatureMatcherByTyp
     */
    public java.lang.String toString(
    ) {
        return this.stringValue;
    }

    /**
     * Method valueOf.Returns a new FeatureMatcherByType based on
     * the given String value.
     * 
     * @param string
     * @return the FeatureMatcherByType value of parameter 'string'
     */
    public static jalview.binding.types.FeatureMatcherByType valueOf(
            final java.lang.String string) {
        java.lang.Object obj = null;
        if (string != null) {
            obj = _memberTable.get(string);
        }
        if (obj == null) {
            String err = "" + string + " is not a valid FeatureMatcherByType";
            throw new IllegalArgumentException(err);
        }
        return (FeatureMatcherByType) obj;
    }

}