Package com.oss.asn1

Class Enumerated

java.lang.Object

com.oss.asn1.ASN1Object

com.oss.asn1.AbstractData

com.oss.asn1.Enumerated

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

Direct Known Subclasses:

RelaySafeEnumerated

public abstract class Enumerated
extends AbstractData

The Enumerated class represents the ASN.1 ENUMERATED type.

Since:

ASN.1/Java 6.0

See Also:

Serialized Form

Field Summary

Fields inherited from class com.oss.asn1.AbstractData

EQUALS, GREATER_THAN, LESS_THAN

Method Summary

Modifier and Type	Method and Description
java.lang.Object	clone() Clone 'this' object.
int	compareTo(Enumerated that) Compare 'this' object to 'that' Enumerated object to determine whether the contents of 'this' object is less than, equal to, or greater than the contents of 'that' object.
boolean	equalTo(Enumerated that) Compare 'this' object to 'that' Enumerated object to see if their contents are the same.
java.lang.String	getTypeName() Returns the name of ASN.1 type this java class represents.
int	hashCode() Returns a hash code for this object
boolean	isUnknownEnumerator() Checks if the object is the result of decoding an unknown enumerated value of extensible enumerated type.
long	longValue() Get the value of 'this' object.
java.lang.String	name() Returns the name of this enumerator.

Methods inherited from class com.oss.asn1.AbstractData

abstractEqualTo, delete, equals, isEncodable, isPDU, isValid, toString, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

longValue

public final long longValue()

Get the value of 'this' object.

Returns:

long value of 'this' object.

equalTo

public final boolean equalTo(Enumerated that)

Compare 'this' object to 'that' Enumerated object to see if their contents are the same. Both objects must be ASN.1 assignment compatible or an exception occurs.

Parameters:

that - the Enumerated object to compare 'this' object to.

Returns:

true if contents of both objects are the same.

Throws:

java.lang.ClassCastException - if 'that' is non-null and is not assignment compatible with this class.

compareTo

public final int compareTo(Enumerated that)

Compare 'this' object to 'that' Enumerated object to determine whether the contents of 'this' object is less than, equal to, or greater than the contents of 'that' object. Both objects must be ASN.1 assignment compatible or an exception occurs.

Parameters:

that - Enumerated object that is compared with 'this' object

Returns:

LESS_THAN, EQUALS, GREATER_THAN values as the results of comparison.

Throws:

java.lang.ClassCastException - if 'that' is non-null and is not assignment compatible with this class.

clone

public java.lang.Object clone()

Clone 'this' object. Enumerated clone simply returns 'this' object, no additional instances get created.

Overrides:

clone in class ASN1Object

Returns:

'this'.

isUnknownEnumerator

public boolean isUnknownEnumerator()

Checks if the object is the result of decoding an unknown enumerated value of extensible enumerated type. The method must be overridden by subclasses which represent extensible enumerated types. This method simply returns 'false' for non-extensible types.

Returns:

false

name

public java.lang.String name()

Returns the name of this enumerator. Returns the name of the enumerator or null if the instance represents unknown enumerator.

Returns:

the name of this enumerator.

Since:

ASN.1/Java 6.1

hashCode

public int hashCode()

Returns a hash code for this object

Overrides:

hashCode in class AbstractData

Returns:

a hash code for this object

getTypeName

public java.lang.String getTypeName()

Returns the name of ASN.1 type this java class represents.

Overrides:

getTypeName in class AbstractData

Returns:

the name of the ASN.1 type.