|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.unboundid.asn1.ASN1Element
com.unboundid.asn1.ASN1OctetString
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class ASN1OctetString
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.
Constructor Summary | |
---|---|
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,
java.lang.String value)
Creates a new ASN.1 octet string element with the specified type and the provided value. |
|
ASN1OctetString(java.lang.String value)
Creates a new ASN.1 octet string element with the default BER type and the provided value. |
Method Summary | |
---|---|
void |
appendValueTo(ByteStringBuffer buffer)
Appends the value of this ASN.1 octet string to the provided buffer. |
static ASN1OctetString |
decodeAsOctetString(ASN1Element element)
Decodes the provided ASN.1 element as an octet string element. |
static ASN1OctetString |
decodeAsOctetString(byte[] elementBytes)
Decodes the contents of the provided byte array 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. |
java.lang.String |
stringValue()
Retrieves the string value for this element. |
ASN1OctetString |
toASN1OctetString()
Converts this byte string to an ASN.1 octet string. |
void |
toString(java.lang.StringBuilder buffer)
Appends a string representation of this ASN.1 element to the provided buffer. |
Methods inherited from class com.unboundid.asn1.ASN1Element |
---|
decode, decodeAsBoolean, decodeAsEnumerated, decodeAsInteger, decodeAsLong, decodeAsNull, decodeAsOctetString, decodeAsSequence, decodeAsSet, encode, encodeLength, equals, equalsIgnoreType, getType, hashCode, readFrom, readFrom, toString, writeTo |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public ASN1OctetString()
public ASN1OctetString(byte type)
type
- The BER type to use for this element.public ASN1OctetString(byte[] value)
value
- The value to use for this element.public ASN1OctetString(byte[] value, int offset, int length)
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.public ASN1OctetString(byte type, byte[] value)
type
- The BER type to use for this element.value
- The value to use for this element.public ASN1OctetString(byte type, byte[] value, int offset, int length)
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.public ASN1OctetString(java.lang.String value)
value
- The value to use for this element.public ASN1OctetString(byte type, java.lang.String value)
type
- The BER type to use for this element.value
- The value to use for this element.Method Detail |
---|
public int getValueLength()
getValueLength
in class ASN1Element
public byte[] getValue()
getValue
in interface ByteString
getValue
in class ASN1Element
public void encodeTo(ByteStringBuffer buffer)
encodeTo
in class ASN1Element
buffer
- The buffer to which the encoded representation should be
appended.public java.lang.String stringValue()
stringValue
in interface ByteString
public static ASN1OctetString decodeAsOctetString(byte[] elementBytes) throws ASN1Exception
elementBytes
- The byte array to decode as an ASN.1 octet string
element.
ASN1Exception
- If the provided array cannot be decoded as an
octet string element.public static ASN1OctetString decodeAsOctetString(ASN1Element element)
element
- The ASN.1 element to be decoded.
public void appendValueTo(ByteStringBuffer buffer)
appendValueTo
in interface ByteString
buffer
- The buffer to which the value is to be appended.public ASN1OctetString toASN1OctetString()
toASN1OctetString
in interface ByteString
public void toString(java.lang.StringBuilder buffer)
toString
in class ASN1Element
buffer
- The buffer to which to append the information.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |