pt.lsts.neptus.messages

Class Enumerated

java.lang.Object

java.lang.Number

pt.lsts.neptus.messages.Enumerated

All Implemented Interfaces:

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

public class Enumerated
extends java.lang.Number
implements java.lang.Comparable<Enumerated>

Utility class to wrap enumerated values.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Enumerated(java.util.LinkedHashMap<java.lang.Long,java.lang.String> possibleValues, long currentValue)

Method Summary

Modifier and Type	Method and Description
int	compareTo(Enumerated o)
double	doubleValue()
boolean	equals(java.lang.Object obj)
float	floatValue()
long	getCurrentValue()
java.util.LinkedHashMap<java.lang.Long,java.lang.String>	getPossibleValues()
java.lang.Number	getValueAs(java.lang.String slzType) Get enumerated value according to serialization type.
int	hashCode()
int	intValue()
long	longValue()
void	setCurrentValue(long value)
void	setCurrentValue(java.lang.String value)
java.lang.String	toString()

Methods inherited from class java.lang.Number

byteValue, shortValue

Methods inherited from class java.lang.Object

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

Constructor Detail

Enumerated

public Enumerated(java.util.LinkedHashMap<java.lang.Long,java.lang.String> possibleValues,
                  long currentValue)

Method Detail

longValue

public long longValue()

Specified by:

longValue in class java.lang.Number

doubleValue

public double doubleValue()

Specified by:

doubleValue in class java.lang.Number

floatValue

public float floatValue()

Specified by:

floatValue in class java.lang.Number

intValue

public int intValue()

Specified by:

intValue in class java.lang.Number

compareTo

public int compareTo(Enumerated o)

Specified by:

compareTo in interface java.lang.Comparable<Enumerated>

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

getPossibleValues

public java.util.LinkedHashMap<java.lang.Long,java.lang.String> getPossibleValues()

getCurrentValue

public long getCurrentValue()

setCurrentValue

public void setCurrentValue(long value)
                     throws InvalidFieldValueException

Throws:

InvalidFieldValueException

setCurrentValue

public void setCurrentValue(java.lang.String value)
                     throws InvalidFieldValueException

Throws:

InvalidFieldValueException

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getValueAs

public java.lang.Number getValueAs(java.lang.String slzType)

Get enumerated value according to serialization type.

Parameters:

slzType - the serialization type

Returns:

the correct object encoding the value with the correct Java serialization type (short, int or long)