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

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

@NotMutable
@ThreadSafety(level=COMPLETELY_THREADSAFE)
public final class ResumeWithTokenStartingPoint
extends ChangelogBatchStartingPoint

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 an implementation of a changelog batch starting point which may be used to start a batch of changes at a point where a previous batch ended. The first change of the batch will be the change immediately after the change associated with the provided token.

See Also:
Serialized Form

Constructor Summary
ResumeWithTokenStartingPoint(ASN1OctetString resumeToken)
          Creates a new instance of this changelog batch starting point using the provided resume token.
 
Method Summary
 ASN1Element encode()
          Encodes this starting point value to an ASN.1 element suitable for inclusion in a changelog batch extended request.
 ASN1OctetString getResumeToken()
          Retrieves the token which may be used to resume changelog access at the point where it previously ended.
 void toString(java.lang.StringBuilder buffer)
          Appends a string representation of this changelog batch starting point to the provided buffer.
 
Methods inherited from class com.unboundid.ldap.sdk.unboundidds.extensions.ChangelogBatchStartingPoint
decode, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ResumeWithTokenStartingPoint

public ResumeWithTokenStartingPoint(ASN1OctetString resumeToken)
Creates a new instance of this changelog batch starting point using the provided resume token.

Parameters:
resumeToken - The token which may be used to resume changelog access at the point where it previously ended. It must not be null.
Method Detail

getResumeToken

public ASN1OctetString getResumeToken()
Retrieves the token which may be used to resume changelog access at the point where it previously ended.

Returns:
The token which may be used to resume changelog access at the point where it previously ended.

encode

public ASN1Element encode()
Encodes this starting point value to an ASN.1 element suitable for inclusion in a changelog batch extended request.

Specified by:
encode in class ChangelogBatchStartingPoint
Returns:
The encoded representation of this starting point value.

toString

public void toString(java.lang.StringBuilder buffer)
Appends a string representation of this changelog batch starting point to the provided buffer.

Specified by:
toString in class ChangelogBatchStartingPoint
Parameters:
buffer - The buffer to which the information should be appended.