org.deegree.model.coverage
Class CodeList

java.lang.Object
  org.deegree.model.coverage.CodeList

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

ColorInterpretation, PaletteInterpretation, SampleDimensionType

public abstract class CodeList
extends java.lang.Object
implements java.io.Serializable

Base class for all code lists.

Version:

2.0

Author:

OpenGIS® consortium

See Also:

Serialized Form

Constructor Summary

(package private)	CodeList(java.lang.String name, java.util.Collection<CodeList> values) Create a new code list instance and add it to the given collection.
protected	CodeList(java.lang.String name, int ordinal) Create a new code list instance.

Method Summary

abstract CodeList[]	family() Returns the list of enumerations of the same kind than this enum.
java.lang.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 java.lang.Object	readResolve() Resolve the code list to an unique instance after deserialization.
java.lang.String	toString() Returns a string representation of this code list.

Methods inherited from class java.lang.Object

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

Constructor Detail

CodeList

protected CodeList(java.lang.String name,
                   int ordinal)

Create a new code list instance.

Parameters:

name - The code name.

ordinal - The code value.

CodeList

CodeList(java.lang.String name,
         java.util.Collection<CodeList> values)

Create a new code list instance and add it to the given collection.

Parameters:

name - The code name.

values - The collection to add the enum 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 java.lang.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.

Returns:

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

toString

public java.lang.String toString()

Returns a string representation of this code list.

Overrides:

toString in class java.lang.Object

readResolve

protected java.lang.Object readResolve()
                                throws java.io.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:

java.io.ObjectStreamException - if the deserialization failed.