com.unboundid.ldap.sdk.unboundidds.extensions
Class StreamProxyValuesBackendSetValue

java.lang.Object
  extended by com.unboundid.ldap.sdk.unboundidds.extensions.StreamProxyValuesBackendSetValue
All Implemented Interfaces:
java.io.Serializable

@NotMutable
@ThreadSafety(level=COMPLETELY_THREADSAFE)
public final class StreamProxyValuesBackendSetValue
extends java.lang.Object
implements java.io.Serializable

NOTE: This class is part of the Commercial Edition of the UnboundID LDAP SDK for Java. It is not available for use in applications that include only the Standard Edition of the LDAP SDK, and is not supported for use in conjunction with non-UnboundID products.
This class provides a data structure for holding a value included in the stream proxy values intermediate response. It contains the value, and the ID of the backend set with which the value is associated.

See Also:
Serialized Form

Constructor Summary
StreamProxyValuesBackendSetValue(ASN1OctetString backendSetID, ASN1OctetString value)
          Creates a new stream proxy values backend set value object with the provided information.
 
Method Summary
static StreamProxyValuesBackendSetValue decode(ASN1Element element)
          Decodes the provided ASN.1 element as a stream proxy values backend set value.
 ASN1Element encode()
          Encodes this backend set value in a form suitable for inclusion in a stream proxy values intermediate response.
 ASN1OctetString getBackendSetID()
          Retrieves the backend set ID for this backend set value.
 ASN1OctetString getValue()
          Retrieves the value for this backend set value.
 java.lang.String toString()
          Retrieves a string representation of this backend set value.
 void toString(java.lang.StringBuilder buffer)
          Appends a string representation of this backend set value to the provided buffer.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

StreamProxyValuesBackendSetValue

public StreamProxyValuesBackendSetValue(ASN1OctetString backendSetID,
                                        ASN1OctetString value)
Creates a new stream proxy values backend set value object with the provided information.

Parameters:
backendSetID - The backend set ID for this backend set value. It must not be null.
value - The value for this backend set value. It must not be null.
Method Detail

getBackendSetID

public ASN1OctetString getBackendSetID()
Retrieves the backend set ID for this backend set value.

Returns:
The backend set ID for this backend set value.

getValue

public ASN1OctetString getValue()
Retrieves the value for this backend set value.

Returns:
The value for this backend set value.

encode

public ASN1Element encode()
Encodes this backend set value in a form suitable for inclusion in a stream proxy values intermediate response.

Returns:
An ASN.1 element containing the encoded representation of this stream proxy values backend set value.

decode

public static StreamProxyValuesBackendSetValue decode(ASN1Element element)
                                               throws LDAPException
Decodes the provided ASN.1 element as a stream proxy values backend set value.

Parameters:
element - The ASN.1 element to be decoded as a stream proxy values backend set value.
Returns:
The decoded stream proxy values backend set value.
Throws:
LDAPException - If a problem occurs while attempting to decode the provided ASN.1 element as a stream proxy values backend set value.

toString

public java.lang.String toString()
Retrieves a string representation of this backend set value.

Overrides:
toString in class java.lang.Object
Returns:
A string representation of this backend set value.

toString

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

Parameters:
buffer - The buffer to which the string representation should be appended.