package .classifiers;
 
public class LegalStatusClassifier 
    implements java.io.Serializable, iapp.services.Classifier {
 
    public static final LegalStatusClassifier CITIZEN = new LegalStatusClassifier("CT");
    public static final LegalStatusClassifier NONCITIZEN = new LegalStatusClassifier("NC");
    public static final LegalStatusClassifier PERMANENT_RESIDENT = new LegalStatusClassifier("PR");
    public static final LegalStatusClassifier AUTHORIZED_ALIEN = new LegalStatusClassifier("AA");
    public static final LegalStatusClassifier CITIZEN = new LegalStatusClassifier("CT");
    public static final LegalStatusClassifier NONCITIZEN = new LegalStatusClassifier("NC");
    public static final LegalStatusClassifier PERMANENT_RESIDENT = new LegalStatusClassifier("PR");
    public static final LegalStatusClassifier AUTHORIZED_ALIEN = new LegalStatusClassifier("AA");
    public static final LegalStatusClassifier CITIZEN = new LegalStatusClassifier("CT");
    public static final LegalStatusClassifier NONCITIZEN = new LegalStatusClassifier("NC");
    public static final LegalStatusClassifier PERMANENT_RESIDENT = new LegalStatusClassifier("PR");
    public static final LegalStatusClassifier AUTHORIZED_ALIEN = new LegalStatusClassifier("AA");
 
    private static final java.util.Map values = new java.util.TreeMap();
    private static java.util.List literals = new java.util.ArrayList(3);
    private static java.util.List names = new java.util.ArrayList(3);
 
    /**
     * Initializes the values.
     */
    static {
        values.put(CITIZEN.value, CITIZEN);
	literals.add(CITIZEN.value);
	CITIZEN.setName("CITIZEN");
        names.add("CITIZEN");
        values.put(NONCITIZEN.value, NONCITIZEN);
	literals.add(NONCITIZEN.value);
	NONCITIZEN.setName("NONCITIZEN");
        names.add("NONCITIZEN");
        values.put(PERMANENT_RESIDENT.value, PERMANENT_RESIDENT);
	literals.add(PERMANENT_RESIDENT.value);
	PERMANENT_RESIDENT.setName("PERMANENT_RESIDENT");
        names.add("PERMANENT_RESIDENT");
        values.put(AUTHORIZED_ALIEN.value, AUTHORIZED_ALIEN);
	literals.add(AUTHORIZED_ALIEN.value);
	AUTHORIZED_ALIEN.setName("AUTHORIZED_ALIEN");
        names.add("AUTHORIZED_ALIEN");
        values.put(CITIZEN.value, CITIZEN);
	literals.add(CITIZEN.value);
	CITIZEN.setName("CITIZEN");
        names.add("CITIZEN");
        values.put(NONCITIZEN.value, NONCITIZEN);
	literals.add(NONCITIZEN.value);
	NONCITIZEN.setName("NONCITIZEN");
        names.add("NONCITIZEN");
        values.put(PERMANENT_RESIDENT.value, PERMANENT_RESIDENT);
	literals.add(PERMANENT_RESIDENT.value);
	PERMANENT_RESIDENT.setName("PERMANENT_RESIDENT");
        names.add("PERMANENT_RESIDENT");
        values.put(AUTHORIZED_ALIEN.value, AUTHORIZED_ALIEN);
	literals.add(AUTHORIZED_ALIEN.value);
	AUTHORIZED_ALIEN.setName("AUTHORIZED_ALIEN");
        names.add("AUTHORIZED_ALIEN");
        values.put(CITIZEN.value, CITIZEN);
	literals.add(CITIZEN.value);
	CITIZEN.setName("CITIZEN");
        names.add("CITIZEN");
        values.put(NONCITIZEN.value, NONCITIZEN);
	literals.add(NONCITIZEN.value);
	NONCITIZEN.setName("NONCITIZEN");
        names.add("NONCITIZEN");
        values.put(PERMANENT_RESIDENT.value, PERMANENT_RESIDENT);
	literals.add(PERMANENT_RESIDENT.value);
	PERMANENT_RESIDENT.setName("PERMANENT_RESIDENT");
        names.add("PERMANENT_RESIDENT");
        values.put(AUTHORIZED_ALIEN.value, AUTHORIZED_ALIEN);
	literals.add(AUTHORIZED_ALIEN.value);
	AUTHORIZED_ALIEN.setName("AUTHORIZED_ALIEN");
        names.add("AUTHORIZED_ALIEN");
        literals = java.util.Collections.unmodifiableList(literals);
        names = java.util.Collections.unmodifiableList(names);
    }
 
	private java.lang.String value;
	private java.lang.String name;
 
	/**
     * The default constructor allowing super classes to access it.
     */
    protected LegalStatusClassifier() {}
 
    private LegalStatusClassifier(java.lang.String value) {
        this.value = value;
    }
 
	public String toString() {
        return java.lang.String.valueOf(value);
    }
 
    /**
     * Creates an instance of LegalStatusClassifier from <code>value</code>.
     *
     * @param value the value to create the LegalStatusClassifier from.
     */
    public static LegalStatusClassifier fromString(java.lang.String value) {
        if(value == null) return null;
		final LegalStatusClassifier typeValue = (LegalStatusClassifier) values.get(value);
        if (typeValue == null) {
            throw new IllegalArgumentException("invalid value '" + value + "', possible values are: " + literals);
        }
        return typeValue;
    }
 
	/**
	* Checks correct value for the classifier
	*/
	public boolean isLegalStatusClassifier(java.lang.String value){
	  return (value == null || values.get(value) != null);
	}
    /**
     * Get/set for value
     */
    public java.lang.String getValue() {
        return this.value;
    }
    public java.lang.String getName() {
        return this.name;
    }
    /**
     * Get/set for name
     */
    private void setName(java.lang.String name) {
        this.name = name;
    }
    /**
     * @see java.lang.Comparable#compareTo(java.lang.Object)
     */
    public int compareTo(Object that)
    {
        return (this == that) ? 0 : this.getValue().compareTo(((LegalStatusClassifier)that).getValue());
    }
 
    public static java.util.Map getValues() {
        return values;
    }
 
    /**
     * Returns an unmodifiable list containing the literals that are known by this enumeration.
     *
     * @return A List containing the actual literals defined by this enumeration, this list
     *         can not be modified.
     */
    public static java.util.List literals() {
        return literals;
    }
 
    /**
     * Returns an unmodifiable list containing the names of the literals that are known
     * by this enumeration.
     *
     * @return A List containing the actual names of the literals defined by this
     *         enumeration, this list can not be modified.
     */
    public static java.util.List names() {
        return names;
    }
 
    /**
     * @see java.lang.Object#equals(java.lang.Object)
     */
    public boolean equals(Object object) {
        return (this == object)
            || (object instanceof LegalStatusClassifier && ((LegalStatusClassifier)object).getValue().equals(
                this.getValue()));
    }
 
    /**
     * @see java.lang.Object#hashCode()
     */
    public int hashCode() {
        return this.getValue().hashCode();
    }
 
    /**
     * This method allows the deserialization of an instance of this enumeration type to return the actual instance
     * that will be the singleton for the JVM in which the current thread is running.
     * <p/>
     * Doing this will allow users to safely use the equality operator <code>==</code> for enumerations because
     * a regular deserialized object is always a newly constructed instance and will therefore never be
     * an existing reference; it is this <code>readResolve()</code> method which will intercept the deserialization
     * process in order to return the proper singleton reference.
     */
    private java.lang.Object readResolve() throws java.io.ObjectStreamException {
        return LegalStatusClassifier.fromString(this.value);
    }
 
}