totalcross.lang

Class Enum4D<T extends Enum4D<T>>

java.lang.Object

totalcross.lang.Enum4D<T>

All Implemented Interfaces:

java.lang.Comparable<T>

public abstract class Enum4D<T extends Enum4D<T>>
extends java.lang.Object
implements java.lang.Comparable<T>

This class represents a Java enumeration. All enumerations are subclasses of this class.

Since:

1.5

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Enum4D(java.lang.String name, int ordinal) This constructor is used by the compiler to create enumeration constants.

Method Summary

Modifier and Type	Method and Description
protected java.lang.Object	clone() Cloning of enumeration constants is prevented, to maintain their singleton status.
int	compareTo(T e) Returns an integer which represents the relative ordering of this enumeration constant.
boolean	equals(java.lang.Object o) Returns true if this enumeration is equivalent to the supplied object, o.
protected void	finalize() Enumerations can not have finalization methods.
java.lang.Class<T>	getDeclaringClass() Returns the type of this enumeration constant.
int	hashCode() Returns the hash code of this constant.
java.lang.String	name() Returns the name of this enumeration constant.
int	ordinal() Returns the number of this enumeration constant, which represents the order in which it was originally declared, starting from zero.
java.lang.String	toString() Returns a textual representation of this enumeration constant.
static <T extends Enum4D<T>> T	valueOf(java.lang.Class<T> enumType, java.lang.String name)

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Enum4D

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

This constructor is used by the compiler to create enumeration constants.

Parameters:

name - the name of the enumeration constant.

ordinal - the number of the enumeration constant, based on the declaration order of the constants and starting from zero.

Method Detail

equals

public final boolean equals(java.lang.Object o)

Returns true if this enumeration is equivalent to the supplied object, o. Only one instance of an enumeration constant exists, so the comparison is simply done using ==.

Overrides:

equals in class java.lang.Object

Parameters:

o - the object to compare to this.

Returns:

true if this == o.

hashCode

public final int hashCode()

Returns the hash code of this constant. This is simply the ordinal.

Overrides:

hashCode in class java.lang.Object

Returns:

the hash code of this enumeration constant.

toString

public java.lang.String toString()

Returns a textual representation of this enumeration constant. By default, this is simply the declared name of the constant, but specific enumeration types may provide an implementation more suited to the data being stored.

Overrides:

toString in class java.lang.Object

Returns:

a textual representation of this constant.

compareTo

public final int compareTo(T e)

Returns an integer which represents the relative ordering of this enumeration constant. Enumeration constants are ordered by their ordinals, which represents their declaration order. So, comparing two identical constants yields zero, while one declared prior to this returns a positive integer and one declared after yields a negative integer.

Specified by:

compareTo in interface java.lang.Comparable<T extends Enum4D<T>>

Parameters:

e - the enumeration constant to compare.

Returns:

a negative integer if e.ordinal < this.ordinal, zero if e.ordinal == this.ordinal and a positive integer if e.ordinal > this.ordinal.

Throws:

java.lang.ClassCastException - if e is not an enumeration constant of the same class.

clone

protected final java.lang.Object clone()
                                throws java.lang.CloneNotSupportedException

Cloning of enumeration constants is prevented, to maintain their singleton status.

Overrides:

clone in class java.lang.Object

Returns:

the cloned object.

Throws:

java.lang.CloneNotSupportedException - as enumeration constants can't be cloned.

name

public final java.lang.String name()

Returns the name of this enumeration constant.

Returns:

the name of the constant.

ordinal

public final int ordinal()

Returns the number of this enumeration constant, which represents the order in which it was originally declared, starting from zero.

Returns:

the number of this constant.

getDeclaringClass

public final java.lang.Class<T> getDeclaringClass()

Returns the type of this enumeration constant. This is the class corresponding to the declaration of the enumeration.

Returns:

the type of this enumeration constant.

finalize

protected final void finalize()

Enumerations can not have finalization methods.

Overrides:

finalize in class java.lang.Object

Since:

1.6

valueOf

public static <T extends Enum4D<T>> T valueOf(java.lang.Class<T> enumType,
                                              java.lang.String name)