org.opends.server.protocols.asn1
Class ASN1Integer

java.lang.Object
  org.opends.server.protocols.asn1.ASN1Element
      org.opends.server.protocols.asn1.ASN1Integer

All Implemented Interfaces:

java.io.Serializable, ProtocolElement

@PublicAPI(stability=UNCOMMITTED,
           mayInstantiate=true,
           mayExtend=false,
           mayInvoke=true)
public final class ASN1Integer
extends ASN1Element

This class defines the data structures and methods to use when interacting with ASN.1 integer elements.

See Also:

Serialized Form

Constructor Summary

ASN1Integer(byte type, int intValue)
Creates a new ASN.1 integer element with the specified type and value.

ASN1Integer(int intValue)
Creates a new ASN.1 integer element with the default type and the provided value.

Method Summary

static ASN1Integer	decodeAsInteger(ASN1Element element) Decodes the provided ASN.1 element as an integer element.
static ASN1Integer	decodeAsInteger(byte[] encodedElement) Decodes the provided byte array as an ASN.1 integer element.
int	intValue() Retrieves the integer value for this ASN.1 integer element.
void	setValue(byte[] value) Specifies the value for this ASN.1 integer element.
void	setValue(int intValue) Specifies the integer value for this ASN.1 integer element.
void	toString(java.lang.StringBuilder buffer) Appends a string representation of this ASN.1 integer element to the provided buffer.
void	toString(java.lang.StringBuilder buffer, int indent) Appends a string representation of this protocol element to the provided buffer.

Methods inherited from class org.opends.server.protocols.asn1.ASN1Element

decode, decode, decodeAsBoolean, decodeAsEnumerated, decodeAsInteger, decodeAsLong, decodeAsNull, decodeAsOctetString, decodeAsSequence, decodeAsSet, decodeElements, encode, encodeLength, encodeLongValue, encodeValue, encodeValue, encodeValue, equals, equalsElement, equalsIgnoreType, equalsIgnoreType, getProtocolElementName, getType, hashCode, isApplicationSpecific, isConstructed, isContextSpecific, isPrimitive, isPrivate, isUniversal, setType, setValueInternal, toString, value

Methods inherited from class java.lang.Object

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

Constructor Detail

ASN1Integer

public ASN1Integer(int intValue)

Creates a new ASN.1 integer element with the default type and the provided value.

Parameters:

intValue - The value for this ASN.1 integer element.

ASN1Integer

public ASN1Integer(byte type,
                   int intValue)

Creates a new ASN.1 integer element with the specified type and value.

Parameters:

type - The BER type for this ASN.1 integer element.

intValue - The value for this ASN.1 integer element.

Method Detail

intValue

public int intValue()

Retrieves the integer value for this ASN.1 integer element.

Returns:

The integer value for this ASN.1 integer element.

setValue

public void setValue(int intValue)

Specifies the integer value for this ASN.1 integer element.

Parameters:

intValue - The integer value for this ASN.1 integer element.

setValue

public void setValue(byte[] value)
              throws ASN1Exception

Specifies the value for this ASN.1 integer element.

Overrides:

setValue in class ASN1Element

Parameters:

value - The encoded value for this ASN.1 integer element.

Throws:

ASN1Exception - If the provided array is null or is not between one and four bytes in length.

decodeAsInteger

public static ASN1Integer decodeAsInteger(ASN1Element element)
                                   throws ASN1Exception

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

Parameters:

element - The ASN.1 element to decode as an integer element.

Returns:

The decoded ASN.1 integer element.

Throws:

ASN1Exception - If the provided ASN.1 element cannot be decoded as an integer element.

decodeAsInteger

public static ASN1Integer decodeAsInteger(byte[] encodedElement)
                                   throws ASN1Exception

Decodes the provided byte array as an ASN.1 integer element.

Parameters:

encodedElement - The byte array to decode as an ASN.1 integer element.

Returns:

The decoded ASN.1 integer element.

Throws:

ASN1Exception - If the provided byte array cannot be decoded as an ASN.1 integer element.

toString

public void toString(java.lang.StringBuilder buffer)

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

Specified by:

toString in interface ProtocolElement

Overrides:

toString in class ASN1Element

Parameters:

buffer - The buffer to which the information should be appended.

toString

public void toString(java.lang.StringBuilder buffer,
                     int indent)

Appends a string representation of this protocol element to the provided buffer.

Specified by:

toString in interface ProtocolElement

Overrides:

toString in class ASN1Element

Parameters:

buffer - The buffer into which the string representation should be written.

indent - The number of spaces that should be used to indent the resulting string representation.