com.unboundid.ldap.protocol
Class SearchResultEntryProtocolOp

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

All Implemented Interfaces:

ProtocolOp, java.io.Serializable

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

This class provides an implementation of an LDAP search result entry protocol op.

See Also:

Serialized Form

Constructor Summary

SearchResultEntryProtocolOp(java.lang.String dn, java.util.List<Attribute> attributes)
Creates a new search result entry protocol op with the provided information.

Method Summary

java.util.List<Attribute>	getAttributes() Retrieves the list of attributes for this search result entry.
java.lang.String	getDN() Retrieves the DN for this search result entry.
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

SearchResultEntryProtocolOp

public SearchResultEntryProtocolOp(java.lang.String dn,
                                   java.util.List<Attribute> attributes)

Creates a new search result entry protocol op with the provided information.

Parameters:

dn - The entry DN for this search result entry.

attributes - The list of attributes to include in this search result entry.

Method Detail

getDN

public java.lang.String getDN()

Retrieves the DN for this search result entry.

Returns:

The DN for this search result entry.

getAttributes

public java.util.List<Attribute> getAttributes()

Retrieves the list of attributes for this search result entry.

Returns:

The list of attributes for this search result entry.

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.