Package com.unboundid.asn1

Class ASN1OctetString

java.lang.Object

com.unboundid.asn1.ASN1Element

com.unboundid.asn1.ASN1OctetString

All Implemented Interfaces:

ByteString, Serializable

@NotMutable
@ThreadSafety(level=COMPLETELY_THREADSAFE)
public final class ASN1OctetString
extends ASN1Element
implements ByteString

This class provides an ASN.1 octet string element, whose value is simply comprised of zero or more bytes. Octet string elements are frequently used to represent string values as well.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
ASN1OctetString()	Creates a new ASN.1 octet string element with the default BER type and no value.
ASN1OctetString(byte type)	Creates a new ASN.1 octet string element with the specified type and no value.
ASN1OctetString(byte[] value)	Creates a new ASN.1 octet string element with the default BER type and the provided value.
ASN1OctetString(byte[] value, int offset, int length)	Creates a new ASN.1 octet string element with the default BER type and the provided value.
ASN1OctetString(byte type, byte[] value)	Creates a new ASN.1 octet string element with the specified type and the provided value.
ASN1OctetString(byte type, byte[] value, int offset, int length)	Creates a new ASN.1 octet string element with the specified type and the provided value.
ASN1OctetString(byte type, String value)	Creates a new ASN.1 octet string element with the specified type and the provided value.
ASN1OctetString(String value)	Creates a new ASN.1 octet string element with the default BER type and the provided value.

Method Summary

Modifier and Type	Method	Description
void	appendValueTo(ByteStringBuffer buffer)	Appends the value of this ASN.1 octet string to the provided buffer.
static ASN1OctetString	decodeAsOctetString(byte[] elementBytes)	Decodes the contents of the provided byte array as an octet string element.
static ASN1OctetString	decodeAsOctetString(ASN1Element element)	Decodes the provided ASN.1 element as an octet string element.
void	encodeTo(ByteStringBuffer buffer)	Appends an encoded representation of this ASN.1 element to the provided buffer.
byte[]	getValue()	Retrieves the encoded value for this element.
int	getValueLength()	Retrieves the number of bytes contained in the value.
String	stringValue()	Retrieves the string value for this element.
ASN1OctetString	toASN1OctetString()	Converts this byte string to an ASN.1 octet string.
void	toString(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, equals, equalsIgnoreType, getType, getTypeClass, hashCode, isConstructed, readFrom, readFrom, toString, writeTo

Methods inherited from class java.lang.Object

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

Constructor Details

ASN1OctetString

public ASN1OctetString()

Creates a new ASN.1 octet string element with the default BER type and no value.

ASN1OctetString

public ASN1OctetString(byte type)

Creates a new ASN.1 octet string element with the specified type and no value.

Parameters:

type - The BER type to use for this element.

ASN1OctetString

public ASN1OctetString(@Nullable
 byte[] value)

Creates a new ASN.1 octet string element with the default BER type and the provided value.

Parameters:

value - The value to use for this element.

ASN1OctetString

public ASN1OctetString(@NotNull
 byte[] value,
 int offset,
 int length)

Creates a new ASN.1 octet string element with the default BER type and the provided value.

Parameters:

value - The byte array containing the value to use for this element It must not be null.

offset - The offset within the array at which the value begins. It must be greater than or equal to zero and less than or equal to the length of the array.

length - The length in bytes of the value. It must be greater than or equal to zero, and it must not extend beyond the end of the array.

ASN1OctetString

public ASN1OctetString(byte type,
 @Nullable
 byte[] value)

Creates a new ASN.1 octet string element with the specified type and the provided value.

Parameters:

type - The BER type to use for this element.

value - The value to use for this element.

ASN1OctetString

public ASN1OctetString(byte type,
 @NotNull
 byte[] value,
 int offset,
 int length)

Creates a new ASN.1 octet string element with the specified type and the provided value.

Parameters:

type - The BER type to use for this element.

value - The byte array containing the value to use for this element. It must not be null.

offset - The offset within the array at which the value begins. It must be greater than or equal to zero and less than or equal to the length of the array.

length - The length in bytes of the value. It must be greater than or equal to zero, and it must not extend beyond the end of the array.

ASN1OctetString

public ASN1OctetString(@Nullable
 String value)

Creates a new ASN.1 octet string element with the default BER type and the provided value.

Parameters:

value - The value to use for this element.

ASN1OctetString

public ASN1OctetString(byte type,
 @Nullable
 String value)

Creates a new ASN.1 octet string element with the specified type and the provided value.

Parameters:

type - The BER type to use for this element.

value - The value to use for this element.

Method Details

getValueLength

public int getValueLength()

Retrieves the number of bytes contained in the value.

Overrides:

getValueLength in class ASN1Element

Returns:

The number of bytes contained in the value.

getValue

@NotNull
public byte[] getValue()

Retrieves the encoded value for this element.

Specified by:

getValue in interface ByteString

Overrides:

getValue in class ASN1Element

Returns:

The encoded value for this element.

encodeTo

public void encodeTo(@NotNull
 ByteStringBuffer buffer)

Appends an encoded representation of this ASN.1 element to the provided buffer.

Overrides:

encodeTo in class ASN1Element

Parameters:

buffer - The buffer to which the encoded representation should be appended.

stringValue

@NotNull
public String stringValue()

Retrieves the string value for this element.

Specified by:

stringValue in interface ByteString

Returns:

The String value for this element.

decodeAsOctetString

@NotNull
public static ASN1OctetString decodeAsOctetString(@NotNull
 byte[] elementBytes)
                                           throws ASN1Exception

Decodes the contents of the provided byte array as an octet string element.

Parameters:

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

Returns:

The decoded ASN.1 octet string element.

Throws:

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

decodeAsOctetString

@NotNull
public static ASN1OctetString decodeAsOctetString(@NotNull
 ASN1Element element)

Decodes the provided ASN.1 element as an octet string element.

Parameters:

element - The ASN.1 element to be decoded.

Returns:

The decoded ASN.1 octet string element.

appendValueTo

public void appendValueTo(@NotNull
 ByteStringBuffer buffer)

Appends the value of this ASN.1 octet string to the provided buffer.

Specified by:

appendValueTo in interface ByteString

Parameters:

buffer - The buffer to which the value is to be appended.

toASN1OctetString

@NotNull
public ASN1OctetString toASN1OctetString()

Converts this byte string to an ASN.1 octet string.

Specified by:

toASN1OctetString in interface ByteString

Returns:

An ASN.1 octet string with the value of this byte string.

toString

public void toString(@NotNull
 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.