org.opengis.util
Class CodeList

Object
  CodeList

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

AxisDirection, ByteInValuePacking, ColorInterpretation, CurveInterpolation, PaletteInterpretation, PixelInCell, SampleDimensionType, SimpleEnumerationType, SurfaceInterpolation, ValueInBytePacking, VerticalDatumType

public abstract class CodeList

extends Object

implements Serializable

Base class for all code lists. Subclasses shall provides a values() method which returns all CodeList element in an array of the appropriate class. Code list are extensible, i.e. invoking the public constructor in any subclass will automatically add the newly created CodeList element in the array to be returned by values().

Note: This class has an API similar to Enum. In a future version, it may extends directly Enum for a J2SE 1.5 profile.

Version:

2.0

Author:

OpenGIS® consortium

See Also:

Serialized Form

Constructor Summary

protected

CodeList(String name, Collection values) Creates a new code list element and add it to the given collection.

Method Summary

abstract CodeList[]	family() Returns the list of enumerations of the same kind than this enum.
String	name() Returns the name of this enum constant.
int	ordinal() Returns the ordinal of this enumeration constant (its position in its enum declaration, where the initial constant is assigned an ordinal of zero).
protected Object	readResolve() Resolve the code list to an unique instance after deserialization.
String	toString() Returns a string representation of this code list.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

CodeList

protected CodeList(String name,
                   Collection values)

Creates a new code list element and add it to the given collection. Subclasses will typically give a static reference to an ArrayList for the values argument. This list is used for values() method implementations.

Parameters:

name - The code name.

values - The collection to add the element to.

Method Detail

ordinal

public final int ordinal()

Returns the ordinal of this enumeration constant (its position in its enum declaration, where the initial constant is assigned an ordinal of zero).

Returns:

the ordinal of this enumeration constant.

name

public final String name()

Returns the name of this enum constant.

Returns:

the name of this enum constant.

family

public abstract CodeList[] family()

Returns the list of enumerations of the same kind than this enum.

toString

public String toString()

Returns a string representation of this code list.

Overrides:

toString in class Object

readResolve

protected Object readResolve()
                      throws ObjectStreamException

Resolve the code list to an unique instance after deserialization. The instance is resolved using its name only (not its ordinal).

Returns:

This code list as a unique instance.

Throws:

ObjectStreamException - if the deserialization failed.