com.unboundid.ldap.protocol
Class CompareRequestProtocolOp

java.lang.Object
  com.unboundid.ldap.protocol.CompareRequestProtocolOp

All Implemented Interfaces:

ProtocolOp, java.io.Serializable

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

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

See Also:

Serialized Form

Constructor Summary

CompareRequestProtocolOp(java.lang.String dn, java.lang.String attributeName, ASN1OctetString assertionValue)
Creates a new compare request protocol op with the provided information.

Method Summary

ASN1OctetString	getAssertionValue() Retrieves the assertion value for this compare request.
java.lang.String	getAttributeName() Retrieves the attribute name for this compare request.
java.lang.String	getDN() Retrieves the DN for this compare 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 buffer) 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

CompareRequestProtocolOp

public CompareRequestProtocolOp(java.lang.String dn,
                                java.lang.String attributeName,
                                ASN1OctetString assertionValue)

Creates a new compare request protocol op with the provided information.

Parameters:

dn - The DN for this compare request.

attributeName - The attribute name for this compare request.

assertionValue - The assertion value for this compare request.

Method Detail

getDN

public java.lang.String getDN()

Retrieves the DN for this compare request.

Returns:

The DN for this compare request.

getAttributeName

public java.lang.String getAttributeName()

Retrieves the attribute name for this compare request.

Returns:

The attribute name for this compare request.

getAssertionValue

public ASN1OctetString getAssertionValue()

Retrieves the assertion value for this compare request.

Returns:

The assertion value for this compare 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 buffer)

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:

buffer - 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.