com.unboundid.asn1

Class ASN1NumericString

java.lang.Object

com.unboundid.asn1.ASN1Element

com.unboundid.asn1.ASN1NumericString

All Implemented Interfaces:

java.io.Serializable

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

This class provides an ASN.1 numeric string element that can hold any empty or non-empty string comprised only of the ASCII numeric digits '0' through '9' and the ASCII space.

See Also:

Serialized Form

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static ASN1NumericString	decodeAsNumericString(ASN1Element element) Decodes the provided ASN.1 element as a numeric string element.
static ASN1NumericString	decodeAsNumericString(byte[] elementBytes) Decodes the contents of the provided byte array as a numeric 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

ASN1NumericString

public ASN1NumericString(@Nullable
                         java.lang.String stringValue)
                  throws ASN1Exception

Creates a new ASN.1 numeric 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. It must only contain ASCII digit and space characters.

Throws:

ASN1Exception - If the provided string does not represent a valid numeric string.

ASN1NumericString

public ASN1NumericString(byte type,
                         @Nullable
                         java.lang.String stringValue)
                  throws ASN1Exception

Creates a new ASN.1 numeric 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. It must only contain ASCII digit and space characters.

Throws:

ASN1Exception - If the provided string does not represent a valid numeric string.

Method Detail

stringValue

@NotNull
public java.lang.String stringValue()

Retrieves the string value for this element.

Returns:

The string value for this element.

decodeAsNumericString

@NotNull
public static ASN1NumericString decodeAsNumericString(@NotNull
                                                               byte[] elementBytes)
                                                        throws ASN1Exception

Decodes the contents of the provided byte array as a numeric string element.

Parameters:

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

Returns:

The decoded ASN.1 numeric string element.

Throws:

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

decodeAsNumericString

@NotNull
public static ASN1NumericString decodeAsNumericString(@NotNull
                                                               ASN1Element element)
                                                        throws ASN1Exception

Decodes the provided ASN.1 element as a numeric string element.

Parameters:

element - The ASN.1 element to be decoded.

Returns:

The decoded ASN.1 numeric string element.

Throws:

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