com.unboundid.ldap.protocol
Class ModifyRequestProtocolOp

java.lang.Object
  extended by com.unboundid.ldap.protocol.ModifyRequestProtocolOp
All Implemented Interfaces:
ProtocolOp, java.io.Serializable

@InternalUseOnly
@NotMutable
@ThreadSafety(level=COMPLETELY_THREADSAFE)
public final class ModifyRequestProtocolOp
extends java.lang.Object
implements ProtocolOp

This class provides an implementation of an LDAP modify request protocol op.

See Also:
Serialized Form

Constructor Summary
ModifyRequestProtocolOp(java.lang.String dn, java.util.List<Modification> modifications)
          Creates a new modify request protocol op with the provided information.
 
Method Summary
 java.lang.String getDN()
          Retrieves the target entry DN for this modify request.
 java.util.List<Modification> getModifications()
          Retrieves the list of modifications for this modify request.
 byte getProtocolOpType()
          Retrieves the BER type for this protocol op.
 java.lang.String toString()
          Retrieves a string representation of this protocol op.
 void toString(java.lang.StringBuilder buffer)
          Appends a string representation of this LDAP protocol op to the provided buffer.
 void writeTo(ASN1Buffer writer)
          Writes an ASN.1-encoded representation of this LDAP protocol op to the provided ASN.1 buffer.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ModifyRequestProtocolOp

public ModifyRequestProtocolOp(java.lang.String dn,
                               java.util.List<Modification> modifications)
Creates a new modify request protocol op with the provided information.

Parameters:
dn - The entry DN for this modify request.
modifications - The list of modifications to include in this modify request.
Method Detail

getDN

public java.lang.String getDN()
Retrieves the target entry DN for this modify request.

Returns:
The target entry DN for this modify request.

getModifications

public java.util.List<Modification> getModifications()
Retrieves the list of modifications for this modify request.

Returns:
The list of modifications for this modify request.

getProtocolOpType

public byte getProtocolOpType()
Retrieves the BER type for this protocol op.

Specified by:
getProtocolOpType in interface ProtocolOp
Returns:
The BER type for this protocol op.

writeTo

public void writeTo(ASN1Buffer writer)
Writes an ASN.1-encoded representation of this LDAP protocol op to the provided ASN.1 buffer. This method is intended for internal use only and should not be used by third-party code.

Specified by:
writeTo in interface ProtocolOp
Parameters:
writer - The ASN.1 buffer to which the encoded representation should be written.

toString

public java.lang.String toString()
Retrieves a string representation of this protocol op.

Overrides:
toString in class java.lang.Object
Returns:
A string representation of this protocol op.

toString

public void toString(java.lang.StringBuilder buffer)
Appends a string representation of this LDAP protocol op to the provided buffer.

Specified by:
toString in interface ProtocolOp
Parameters:
buffer - The buffer to which the string representation should be appended.