com.unboundid.asn1

Class ASN1Boolean

java.lang.Object

com.unboundid.asn1.ASN1Element

com.unboundid.asn1.ASN1Boolean

All Implemented Interfaces:

java.io.Serializable

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

This class provides an ASN.1 Boolean element, whose value is a single byte and represents either "TRUE" or "FALSE". A value whose only byte is 0x00 is considered "false", while any other single-byte value is considered "true".

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static ASN1Boolean	UNIVERSAL_BOOLEAN_FALSE_ELEMENT A pre-allocated ASN.1 Boolean element with the universal Boolean BER type and a value of "FALSE".
static ASN1Boolean	UNIVERSAL_BOOLEAN_TRUE_ELEMENT A pre-allocated ASN.1 Boolean element with the universal Boolean BER type and a value of "TRUE".

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
boolean	booleanValue() Retrieves the boolean value for this element.
static ASN1Boolean	decodeAsBoolean(ASN1Element element) Decodes the provided ASN.1 element as a Boolean element.
static ASN1Boolean	decodeAsBoolean(byte[] elementBytes) Decodes the contents of the provided byte array as a Boolean 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

Field Detail

UNIVERSAL_BOOLEAN_FALSE_ELEMENT

@NotNull
public static final ASN1Boolean UNIVERSAL_BOOLEAN_FALSE_ELEMENT

A pre-allocated ASN.1 Boolean element with the universal Boolean BER type and a value of "FALSE".

UNIVERSAL_BOOLEAN_TRUE_ELEMENT

@NotNull
public static final ASN1Boolean UNIVERSAL_BOOLEAN_TRUE_ELEMENT

A pre-allocated ASN.1 Boolean element with the universal Boolean BER type and a value of "TRUE".

Constructor Detail

ASN1Boolean

public ASN1Boolean(boolean booleanValue)

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

Parameters:

booleanValue - The boolean value to use for this element.

ASN1Boolean

public ASN1Boolean(byte type,
                   boolean booleanValue)

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

Parameters:

type - The BER type to use for this element.

booleanValue - The boolean value to use for this element.

Method Detail

booleanValue

public boolean booleanValue()

Retrieves the boolean value for this element.

Returns:

true if this element has a value of "TRUE", or false if it has a value of "FALSE".

decodeAsBoolean

@NotNull
public static ASN1Boolean decodeAsBoolean(@NotNull
                                                   byte[] elementBytes)
                                            throws ASN1Exception

Decodes the contents of the provided byte array as a Boolean element.

Parameters:

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

Returns:

The decoded ASN.1 Boolean element.

Throws:

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

decodeAsBoolean

@NotNull
public static ASN1Boolean decodeAsBoolean(@NotNull
                                                   ASN1Element element)
                                            throws ASN1Exception

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

Parameters:

element - The ASN.1 element to be decoded.

Returns:

The decoded ASN.1 Boolean element.

Throws:

ASN1Exception - If the provided element cannot be decoded as a Boolean 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.