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

package jalview.schemabinding.version2.types;

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

import java.util.Hashtable;

/**
 * Graduated feature colour if no score (or attribute) value
 * 
 * @version $Revision$ $Date$
 */
public class NoValueColour implements java.io.Serializable
{

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

  /**
   * The None type
   */
  public static final int NONE_TYPE = 0;

  /**
   * The instance of the None type
   */
  public static final NoValueColour NONE = new NoValueColour(NONE_TYPE,
          "None");

  /**
   * The Min type
   */
  public static final int MIN_TYPE = 1;

  /**
   * The instance of the Min type
   */
  public static final NoValueColour MIN = new NoValueColour(MIN_TYPE,
          "Min");

  /**
   * The Max type
   */
  public static final int MAX_TYPE = 2;

  /**
   * The instance of the Max type
   */
  public static final NoValueColour MAX = new NoValueColour(MAX_TYPE,
          "Max");

  /**
   * 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 NoValueColour(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
   * NoValueColour
   * 
   * @return an Enumeration over all possible instances of NoValueColour
   */
  public static java.util.Enumeration enumerate()
  {
    return _memberTable.elements();
  }

  /**
   * Method getType.Returns the type of this NoValueColour
   * 
   * @return the type of this NoValueColour
   */
  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("None", NONE);
    members.put("Min", MIN);
    members.put("Max", MAX);
    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 NoValueColour
   * 
   * @return the String representation of this NoValueColour
   */
  public java.lang.String toString()
  {
    return this.stringValue;
  }

  /**
   * Method valueOf.Returns a new NoValueColour based on the given String value.
   * 
   * @param string
   * @return the NoValueColour value of parameter 'string'
   */
  public static jalview.schemabinding.version2.types.NoValueColour 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 NoValueColour";
      throw new IllegalArgumentException(err);
    }
    return (NoValueColour) obj;
  }

}