no.g9.support

Class G9Enumerator

java.lang.Object

no.g9.support.G9Enumerator

All Implemented Interfaces:

Serializable, Comparable<G9Enumerator>

public class G9Enumerator
extends Object
implements Serializable, Comparable<G9Enumerator>

The super class of all enumerators

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
int	currentValue The current enumerator value

Constructor Summary

Constructors

Constructor and Description
G9Enumerator()

Method Summary

Modifier and Type	Method and Description
void	assignFromName(String n) Assign the current value based on the supplied parameter
int	compareTo(G9Enumerator genum)
String	currentAsName() Deprecated. This method is likely to fail...
boolean	equals(Object o)
int	getCurrentValue() Gets the current enumerator value
Integer	getCurrentValueAsInteger() Gets the current value as an Integer
int	hashCode()
int	keyFromName(String f) Gets the key from the specified name
String	nameFromKey(int n) Deprecated. This method may return incorrect value.
void	setCurrentValue(int n) Sets the current enumeration value

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

currentValue

public int currentValue

The current enumerator value

Constructor Detail

G9Enumerator

public G9Enumerator()

Method Detail

getCurrentValue

public int getCurrentValue()

Gets the current enumerator value

Returns:

the current enumerator value

getCurrentValueAsInteger

public Integer getCurrentValueAsInteger()

Gets the current value as an Integer

Returns:

Current Value as Integer.

setCurrentValue

public void setCurrentValue(int n)

Sets the current enumeration value

Parameters:

n - the current enumeration value

currentAsName

@Deprecated
public String currentAsName()

Deprecated. This method is likely to fail...

Internal use!

Returns:

the name of the current value.

assignFromName

public void assignFromName(String n)

Assign the current value based on the supplied parameter

Parameters:

n - the name of the enumerator value

keyFromName

public int keyFromName(String f)

Gets the key from the specified name

Parameters:

f - the name

Returns:

the key, or -1 if the name does not exist

nameFromKey

@Deprecated
public String nameFromKey(int n)

Deprecated. This method may return incorrect value.

Gets the name from a key

Parameters:

n - the key

Returns:

the name, or null if no such key

compareTo

public int compareTo(G9Enumerator genum)

Specified by:

compareTo in interface Comparable<G9Enumerator>

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object