com.unboundid.asn1

Class ASN1UTF8String

java.lang.Object

com.unboundid.asn1.ASN1Element

com.unboundid.asn1.ASN1UTF8String

All Implemented Interfaces:

java.io.Serializable

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

This class provides an ASN.1 UTF-8 string element that can hold any string value that can be represented in the UTF-8 encoding.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ASN1UTF8String(byte type, java.lang.String stringValue) Creates a new ASN.1 UTF-8 string element with the specified BER type and the provided value.
ASN1UTF8String(java.lang.String stringValue) Creates a new ASN.1 UTF-8 string element with the default BER type and the provided value.

Method Summary

Modifier and Type	Method and Description
static ASN1UTF8String	decodeAsUTF8String(ASN1Element element) Decodes the provided ASN.1 element as a UTF-8 string element.
static ASN1UTF8String	decodeAsUTF8String(byte[] elementBytes) Decodes the contents of the provided byte array as a UTF-8 string element.
java.lang.String	stringValue() Retrieves the string 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

ASN1UTF8String

public ASN1UTF8String(@Nullable
                      java.lang.String stringValue)

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

Parameters:

stringValue - The string value to use for this element. It may be null or empty if the value should be empty.

ASN1UTF8String

public ASN1UTF8String(byte type,
                      @Nullable
                      java.lang.String stringValue)

Creates a new ASN.1 UTF-8 string element with the specified BER type and the provided value.

Parameters:

type - The BER type for this element.

stringValue - The string value to use for this element. It may be null or empty if the value should be empty.

Method Detail

stringValue

@NotNull
public java.lang.String stringValue()

Retrieves the string value for this element.

Returns:

The string value for this element.

decodeAsUTF8String

@NotNull
public static ASN1UTF8String decodeAsUTF8String(@NotNull
                                                         byte[] elementBytes)
                                                  throws ASN1Exception

Decodes the contents of the provided byte array as a UTF-8 string element.

Parameters:

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

Returns:

The decoded ASN.1 UTF-8 string element.

Throws:

ASN1Exception - If the provided array cannot be decoded as a UTF-8 string element.

decodeAsUTF8String

@NotNull
public static ASN1UTF8String decodeAsUTF8String(@NotNull
                                                         ASN1Element element)
                                                  throws ASN1Exception

Decodes the provided ASN.1 element as a UTF-8 string element.

Parameters:

element - The ASN.1 element to be decoded.

Returns:

The decoded ASN.1 UTF-8 string element.

Throws:

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