org.opends.server.protocols.asn1
Class ASN1Boolean

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

All Implemented Interfaces:

java.io.Serializable, ProtocolElement

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

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

See Also:

Serialized Form

Constructor Summary

ASN1Boolean(boolean booleanValue)
Creates a new ASN.1 Boolean element with the default type and the provided value.

ASN1Boolean(byte type, boolean booleanValue)
Creates a new ASN.1 Boolean element with the specified type and value.

Method Summary

boolean	booleanValue() Retrieves the boolean value for this ASN.1 Boolean element.
static ASN1Boolean	decodeAsBoolean(ASN1Element element) Decodes the provided ASN.1 element as a Boolean element.
static ASN1Boolean	decodeAsBoolean(byte[] encodedElement) Decodes the provided byte array as an ASN.1 Boolean element.
void	setValue(boolean booleanValue) Specifies the boolean value for this ASN.1 Boolean element.
void	setValue(byte[] value) Specifies the value for this ASN.1 Boolean element.
void	toString(java.lang.StringBuilder buffer) Appends a string representation of this ASN.1 Boolean 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

ASN1Boolean

public ASN1Boolean(boolean booleanValue)

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

Parameters:

booleanValue - The value for this ASN.1 Boolean element.

ASN1Boolean

public ASN1Boolean(byte type,
                   boolean booleanValue)

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

Parameters:

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

booleanValue - The value for this ASN.1 Boolean element.

Method Detail

booleanValue

public boolean booleanValue()

Retrieves the boolean value for this ASN.1 Boolean element.

Returns:

The boolean value for this ASN.1 Boolean element.

setValue

public void setValue(boolean booleanValue)

Specifies the boolean value for this ASN.1 Boolean element.

Parameters:

booleanValue - The boolean value for this ASN.1 Boolean element.

setValue

public void setValue(byte[] value)
              throws ASN1Exception

Specifies the value for this ASN.1 Boolean element.

Overrides:

setValue in class ASN1Element

Parameters:

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

Throws:

ASN1Exception - If the provided array is null or does not contain a single byte.

decodeAsBoolean

public static ASN1Boolean decodeAsBoolean(ASN1Element element)
                                   throws ASN1Exception

Decodes the provided ASN.1 element as a Boolean element.

Parameters:

element - The ASN.1 element to decode as a Boolean element.

Returns:

The decoded ASN.1 Boolean element.

Throws:

ASN1Exception - If the provided ASN.1 element cannot be decoded as a Boolean element.

decodeAsBoolean

public static ASN1Boolean decodeAsBoolean(byte[] encodedElement)
                                   throws ASN1Exception

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

Parameters:

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

Returns:

The decoded ASN.1 Boolean element.

Throws:

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

toString

public void toString(java.lang.StringBuilder buffer)

Appends a string representation of this ASN.1 Boolean 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.