com.unboundid.asn1

Class ASN1Set

java.lang.Object

com.unboundid.asn1.ASN1Element

com.unboundid.asn1.ASN1Set

All Implemented Interfaces:

java.io.Serializable

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

This class provides an ASN.1 set element, which is used to hold a set of zero or more other elements (potentially including additional "envelope" element types like other sequences and/or sets) in which the order of those elements should not be considered significant.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ASN1Set() Creates a new ASN.1 set with the default BER type and no encapsulated elements.
ASN1Set(ASN1Element... elements) Creates a new ASN.1 set with the default BER type and the provided set of elements.
ASN1Set(byte type) Creates a new ASN.1 set with the specified BER type and no encapsulated elements.
ASN1Set(byte type, ASN1Element... elements) Creates a new ASN.1 set with the specified BER type and the provided set of elements.
ASN1Set(byte type, java.util.Collection<? extends ASN1Element> elements) Creates a new ASN.1 set with the specified BER type and the provided set of elements.
ASN1Set(java.util.Collection<? extends ASN1Element> elements) Creates a new ASN.1 set with the default BER type and the provided set of elements.

Method Summary

Modifier and Type	Method and Description
static ASN1Set	decodeAsSet(ASN1Element element) Decodes the provided ASN.1 element as a set element.
static ASN1Set	decodeAsSet(byte[] elementBytes) Decodes the contents of the provided byte array as a set element.
ASN1Element[]	elements() Retrieves the set of encapsulated elements held in this set.
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.
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, 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 Detail

ASN1Set

public ASN1Set()

Creates a new ASN.1 set with the default BER type and no encapsulated elements.

ASN1Set

public ASN1Set(byte type)

Creates a new ASN.1 set with the specified BER type and no encapsulated elements.

Parameters:

type - The BER type to use for this element.

ASN1Set

public ASN1Set(@Nullable
               ASN1Element... elements)

Creates a new ASN.1 set with the default BER type and the provided set of elements.

Parameters:

elements - The set of elements to include in this set.

ASN1Set

public ASN1Set(@Nullable
               java.util.Collection<? extends ASN1Element> elements)

Creates a new ASN.1 set with the default BER type and the provided set of elements.

Parameters:

elements - The set of elements to include in this set.

ASN1Set

public ASN1Set(byte type,
               @Nullable
               ASN1Element... elements)

Creates a new ASN.1 set with the specified BER type and the provided set of elements.

Parameters:

type - The BER type to use for this element.

elements - The set of elements to include in this set.

ASN1Set

public ASN1Set(byte type,
               @Nullable
               java.util.Collection<? extends ASN1Element> elements)

Creates a new ASN.1 set with the specified BER type and the provided set of elements.

Parameters:

type - The BER type to use for this element.

elements - The set of elements to include in this set.

Method Detail

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.

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.

elements

@NotNull
public ASN1Element[] elements()

Retrieves the set of encapsulated elements held in this set.

Returns:

The set of encapsulated elements held in this set.

decodeAsSet

@NotNull
public static ASN1Set decodeAsSet(@NotNull
                                           byte[] elementBytes)
                                    throws ASN1Exception

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

Parameters:

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

Returns:

The decoded ASN.1 set element.

Throws:

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

decodeAsSet

@NotNull
public static ASN1Set decodeAsSet(@NotNull
                                           ASN1Element element)
                                    throws ASN1Exception

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

Parameters:

element - The ASN.1 element to be decoded.

Returns:

The decoded ASN.1 set element.

Throws:

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