org.opends.server.protocols.asn1
Class ASN1Set

java.lang.Object
  extended by org.opends.server.protocols.asn1.ASN1Element
      extended by org.opends.server.protocols.asn1.ASN1Set
All Implemented Interfaces:
java.io.Serializable, ProtocolElement

@PublicAPI(stability=UNCOMMITTED,
           mayInstantiate=true,
           mayExtend=false,
           mayInvoke=true)
public final class ASN1Set
extends ASN1Element

This class defines the data structures and methods to use when interacting with ASN.1 set elements.

See Also:
Serialized Form

Constructor Summary
ASN1Set()
          Creates a new ASN.1 set element with the default type no value.
ASN1Set(java.util.ArrayList<ASN1Element> elements)
          Creates a new ASN.1 set with the default type and the provided set of elements.
ASN1Set(byte type)
          Creates a new ASN.1 set element with the specified type and no value.
ASN1Set(byte type, java.util.ArrayList<ASN1Element> elements)
          Creates a new ASN.1 set with the specified type and the provided set of elements.
 
Method Summary
static ASN1Set decodeAsSet(ASN1Element element)
          Decodes the provided ASN.1 element as a set element.
static ASN1Set decodeAsSet(byte[] encodedElement)
          Decodes the provided byte array as an ASN.1 set element.
 java.util.ArrayList<ASN1Element> elements()
          Retrieves the set of elements contained in this ASN.1 set.
 void setElements(java.util.ArrayList<ASN1Element> elements)
          Specifies the set of elements for this ASN.1 set.
 void setValue(byte[] value)
          Specifies the value for this ASN.1 set element.
 void toString(java.lang.StringBuilder buffer)
          Appends a string representation of this ASN.1 set element to the provided buffer.
 void toString(java.lang.StringBuilder buffer, int indent)
          Appends a string representation of this protocol element to the provided buffer.
 
Methods inherited from class org.opends.server.protocols.asn1.ASN1Element
decode, decode, decodeAsBoolean, decodeAsEnumerated, decodeAsInteger, decodeAsLong, decodeAsNull, decodeAsOctetString, decodeAsSequence, decodeAsSet, decodeElements, encode, encodeLength, encodeLongValue, encodeValue, encodeValue, encodeValue, equals, equalsElement, equalsIgnoreType, equalsIgnoreType, getProtocolElementName, getType, hashCode, isApplicationSpecific, isConstructed, isContextSpecific, isPrimitive, isPrivate, isUniversal, setType, setValueInternal, toString, value
 
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 element with the default type no value.


ASN1Set

public ASN1Set(byte type)
Creates a new ASN.1 set element with the specified type and no value.

Parameters:
type - The BER type for this ASN.1 set.

ASN1Set

public ASN1Set(java.util.ArrayList<ASN1Element> elements)
Creates a new ASN.1 set with the default type and the provided set of elements.

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

ASN1Set

public ASN1Set(byte type,
               java.util.ArrayList<ASN1Element> elements)
Creates a new ASN.1 set with the specified type and the provided set of elements.

Parameters:
type - The BER type for this set.
elements - The set of elements to include in this set.
Method Detail

elements

public java.util.ArrayList<ASN1Element> elements()
Retrieves the set of elements contained in this ASN.1 set. The returned list must not be modified by the caller.

Returns:
The set of elements contained in this ASN.1 set.

setElements

public void setElements(java.util.ArrayList<ASN1Element> elements)
Specifies the set of elements for this ASN.1 set.

Parameters:
elements - The set of elements for this ASN.1 set.

setValue

public void setValue(byte[] value)
              throws ASN1Exception
Specifies the value for this ASN.1 set element.

Overrides:
setValue in class ASN1Element
Parameters:
value - The encoded value for this ASN.1 set element.
Throws:
ASN1Exception - If the provided array is null or cannot be decoded as a set of ASN.1 elements.

decodeAsSet

public static ASN1Set decodeAsSet(ASN1Element element)
                           throws ASN1Exception
Decodes the provided ASN.1 element as a set element.

Parameters:
element - The ASN.1 element to decode as a set element.
Returns:
The decoded ASN.1 set element.
Throws:
ASN1Exception - If the provided ASN.1 element cannot be decoded as a set element.

decodeAsSet

public static ASN1Set decodeAsSet(byte[] encodedElement)
                           throws ASN1Exception
Decodes the provided byte array as an ASN.1 set element.

Parameters:
encodedElement - The byte array to decode as an ASN.1 set element.
Returns:
The decoded ASN.1 set element.
Throws:
ASN1Exception - If the provided byte array cannot be decoded as an ASN.1 set element.

toString

public void toString(java.lang.StringBuilder buffer)
Appends a string representation of this ASN.1 set element to the provided buffer.

Specified by:
toString in interface ProtocolElement
Overrides:
toString in class ASN1Element
Parameters:
buffer - The buffer to which the information should be appended.

toString

public void toString(java.lang.StringBuilder buffer,
                     int indent)
Appends a string representation of this protocol element to the provided buffer.

Specified by:
toString in interface ProtocolElement
Overrides:
toString in class ASN1Element
Parameters:
buffer - The buffer into which the string representation should be written.
indent - The number of spaces that should be used to indent the resulting string representation.