Class ExpansionType

  extended by atg.core.util.Enum
      extended by
All Implemented Interfaces:, java.lang.Comparable

public class ExpansionType
extends Enum

Enumeration for types of query term expansions

See Also:
Serialized Form

Nested Class Summary
static class ExpansionType.ExpansionTypeEditor
Nested classes/interfaces inherited from class atg.core.util.Enum
Enum.EnumEditor, Enum.LocaleEnumEditor
Field Summary
static java.lang.String CLASS_VERSION
          Class version string
static ExpansionType EQUAL
static ExpansionType IDENTITY
static ExpansionType MEDIUM
static ExpansionType STRONG
static ExpansionType UNKNOWN
static ExpansionType WEAK
Constructor Summary
protected ExpansionType(java.lang.String enumName, int ordinalVal)
          The subclass constructor should be private.
Method Summary
static ExpansionType valueOf(java.lang.String pName)
Methods inherited from class atg.core.util.Enum
compareTo, getEnumClassInfo, getOrdinal, iterator, iterator, lookup, lookup, lookup, lookup, readResolve, toString
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail


public static java.lang.String CLASS_VERSION
Class version string


public static final ExpansionType IDENTITY


public static final ExpansionType EQUAL


public static final ExpansionType STRONG


public static final ExpansionType MEDIUM


public static final ExpansionType WEAK


public static final ExpansionType UNKNOWN
Constructor Detail


protected ExpansionType(java.lang.String enumName,
                        int ordinalVal)
The subclass constructor should be private.

The ordinal value is used to compare (done when sorting, for example) two Enum objects and to order the objects in iterators and PropertyEditors. No two instances of a subclass should have the same ordinal value or name. To safely add new Enum subclass instances and preserve previous orderings in containers the best thing to do is to always use a new ordinal value when creating a new instance rather than changing old instance's ordinal value.

If an enum subclass instance is ever removed, there should be a comment in the file that reserves the old ordinal value so that any old serialized files don't accidentally map an old enum to a new enum.

enumName - The name of the instance that will appear in editors and toString().
ordinalVal - The ordinal value
java.lang.Error - if the subclass already has an instance name n or if the ordinal number is already used by another instance of the same subclass.
Method Detail


public static ExpansionType valueOf(java.lang.String pName)