org.opengis.util

Class CodeList<E extends CodeList<E>>

java.lang.Object

org.opengis.util.CodeList<E>

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<E>

Direct Known Subclasses:

AxisDirection, BSplineSurfaceForm, ByteInValuePacking, CellGeometry, Classification, ColorInterpretation, CoverageContentType, CurveInterpolation, Datatype, DataType, DateType, DimensionNameType, EvaluationMethodType, GeometricObjectType, ImagingCondition, KeywordType, KnotType, MaintenanceFrequency, MediumFormat, MediumName, Obligation, OnLineFunction, PaletteInterpretation, PixelInCell, PixelOrientation, PresentationForm, Progress, Restriction, Role, SampleDimensionType, ScopeCode, SimpleEnumerationType, SpatialRepresentationType, SplineCurveForm, SurfaceInterpolation, TopicCategory, TopologyLevel, ValueInBytePacking, VerticalDatumType

public abstract class CodeList<E extends CodeList<E>>
extends java.lang.Object
implements java.lang.Comparable<E>, java.io.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().

Since:

GeoAPI 1.0

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
int	compareTo(E other) Compares this code with the specified object for order.
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).
java.lang.String	toString() Returns a string representation of this code list.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

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).

name

public final java.lang.String name()

Returns the name of this enum constant.

family

public abstract CodeList[] family()

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

compareTo

public final int compareTo(E other)

Compares this code with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

Code list constants are only comparable to other code list constants of the same type. The natural order implemented by this method is the order in which the constants are declared.

Specified by:

compareTo in interface java.lang.Comparable<E extends CodeList<E>>

toString

public java.lang.String toString()

Returns a string representation of this code list.

Overrides:

toString in class java.lang.Object