com.unboundid.asn1

Class ASN1Enumerated

java.lang.Object

com.unboundid.asn1.ASN1Element

com.unboundid.asn1.ASN1Enumerated

All Implemented Interfaces:

java.io.Serializable

@NotMutable
 @ThreadSafety(level=COMPLETELY_THREADSAFE)
public final class ASN1Enumerated
extends ASN1Element

This class provides an ASN.1 enumerated element. Enumerated elements are very similar to integer elements, and the only real difference between them is that the individual values of an enumerated element have a symbolic significance (i.e., each value is associated with a particular meaning), although this does not impact its encoding other than through the use of a different default BER type.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ASN1Enumerated(byte type, int intValue) Creates a new ASN.1 enumerated element with the specified BER type and the provided int value.
ASN1Enumerated(int intValue) Creates a new ASN.1 enumerated element with the default BER type and the provided int value.

Method Summary

Modifier and Type	Method and Description
static ASN1Enumerated	decodeAsEnumerated(ASN1Element element) Decodes the provided ASN.1 element as an enumerated element.
static ASN1Enumerated	decodeAsEnumerated(byte[] elementBytes) Decodes the contents of the provided byte array as an enumerated element.
int	intValue() Retrieves the int value for this element.
void	toString(java.lang.StringBuilder buffer) Appends a string representation of the value for this ASN.1 element to the provided buffer.

Methods inherited from class com.unboundid.asn1.ASN1Element

decode, decodeAsBigInteger, decodeAsBitString, decodeAsBoolean, decodeAsEnumerated, decodeAsGeneralizedTime, decodeAsIA5String, decodeAsInteger, decodeAsLong, decodeAsNull, decodeAsNumericString, decodeAsObjectIdentifier, decodeAsOctetString, decodeAsPrintableString, decodeAsSequence, decodeAsSet, decodeAsUTCTime, decodeAsUTF8String, encode, encodeLength, encodeTo, equals, equalsIgnoreType, getType, getTypeClass, getValue, getValueLength, hashCode, isConstructed, readFrom, readFrom, toString, writeTo

Methods inherited from class java.lang.Object

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

Constructor Detail

ASN1Enumerated

public ASN1Enumerated(int intValue)

Creates a new ASN.1 enumerated element with the default BER type and the provided int value.

Parameters:

intValue - The int value to use for this element.

ASN1Enumerated

public ASN1Enumerated(byte type,
                      int intValue)

Creates a new ASN.1 enumerated element with the specified BER type and the provided int value.

Parameters:

type - The BER type to use for this element.

intValue - The int value to use for this element.

Method Detail

intValue

public int intValue()

Retrieves the int value for this element.

Returns:

The int value for this element.

decodeAsEnumerated

@NotNull
public static ASN1Enumerated decodeAsEnumerated(@NotNull
                                                         byte[] elementBytes)
                                                  throws ASN1Exception

Decodes the contents of the provided byte array as an enumerated element.

Parameters:

elementBytes - The byte array to decode as an ASN.1 enumerated element.

Returns:

The decoded ASN.1 enumerated element.

Throws:

ASN1Exception - If the provided array cannot be decoded as an enumerated element.

decodeAsEnumerated

@NotNull
public static ASN1Enumerated decodeAsEnumerated(@NotNull
                                                         ASN1Element element)
                                                  throws ASN1Exception

Decodes the provided ASN.1 element as an enumerated element.

Parameters:

element - The ASN.1 element to be decoded.

Returns:

The decoded ASN.1 enumerated element.

Throws:

ASN1Exception - If the provided element cannot be decoded as an enumerated element.

toString

public void toString(@NotNull
                     java.lang.StringBuilder buffer)

Appends a string representation of the value for this ASN.1 element to the provided buffer.

Overrides:

toString in class ASN1Element

Parameters:

buffer - The buffer to which to append the information.