//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\
 //                                                                        \\
 //                 Centre for Speech Technology Research                  \\
 //                      University of Edinburgh, UK                       \\
 //                        Copyright (c) 1996,1997                         \\
 //                         All Rights Reserved.                           \\
 //   Permission is hereby granted, free of charge, to use and distribute  \\
 //   this software and its documentation without restriction, including   \\
 //   without limitation the rights to use, copy, modify, merge, publish,  \\
 //   distribute, sublicense, and/or sell copies of this work, and to      \\
 //   permit persons to whom this work is furnished to do so, subject to   \\
 //   the following conditions:                                            \\
 //    1. The code must retain the above copyright notice, this list of    \\
 //       conditions and the following disclaimer.                         \\
 //    2. Any modifications must be clearly marked as such.                \\
 //    3. Original authors' names are not deleted.                         \\
 //    4. The authors' names are not used to endorse or promote products   \\
 //       derived from this software without specific prior written        \\
 //       permission.                                                      \\
 //   THE UNIVERSITY OF EDINBURGH AND THE CONTRIBUTORS TO THIS WORK        \\
 //   DISCLAIM ALL WARRANTIES With REGARD TO THIS SOFTWARE, INCLUDING      \\
 //   ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT   \\
 //   SHALL THE UNIVERSITY OF EDINBURGH NOR THE CONTRIBUTORS BE LIABLE     \\
 //   FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES    \\
 //   WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN   \\
 //   AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,          \\
 //   ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF       \\
 //   THIS SOFTWARE.                                                       \\
 //                                                                        \\
 //\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\
 //                                                                        \\
 //                  Author: Richard Caley (rjc@cstr.ed.ac.uk)             \\
 //  --------------------------------------------------------------------  \\
 //  Simple Enumerated type superclass.                                    \\
 //                                                                        \\
 //\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\

package cstr.util ;

import java.lang.*;
import java.util.*;
import java.awt.*;

public abstract class Enum 
{
  String name;
  String longName;
  Object info;
  int index;

  abstract public EnumValues getValuesTable();

  protected static EnumValues init(String n)
    {
      return new EnumValues(n);
    }
  
  protected Enum(String s, String ls, Object o)
    {
      setup(s, ls, o);
    }
     
  protected Enum(String s, String ls, boolean real)
    {
      setup(s, ls, real?null:Enum.class);
    }
     
  protected void setup(String s, String ls, Object o)
    {
      name=s;
      longName=ls;
      info=o;

      EnumValues values = getValuesTable();

      index=values.add(this);
    }

  protected void alias(String a)
    {
      EnumValues values = getValuesTable();
      values.add(this, a);
    }

  protected static Enum getValue(String s, EnumValues values)
    throws IllegalArgumentException
    {
      return values.getValue(s);
    }
  
  protected static Object getValues(EnumValues values)
    {
      return (Object)values.getValues();
    }

  public boolean isReal()
    {
      return info != Enum.class;
    }
  
  public String toString()
    {
      return name;
    }

  public String toString(boolean lng)
    {
      return lng?longName:name;
    }

  public Object getInfo()
    {
      return info;
    }

}