org.apache.directory.api.ldap.model.message

Class SearchResultEntryImpl

java.lang.Object

org.apache.directory.api.ldap.model.message.AbstractMessage

org.apache.directory.api.ldap.model.message.AbstractResponse

org.apache.directory.api.ldap.model.message.SearchResultEntryImpl

All Implemented Interfaces:

Message, Response, SearchResultEntry

public class SearchResultEntryImpl
extends AbstractResponse
implements SearchResultEntry

Lockable SearchResponseEntry implementation

Field Summary

Fields

Modifier and Type	Field and Description
private Entry	entry Entry returned in response to search
(package private) static long	serialVersionUID

Fields inherited from class org.apache.directory.api.ldap.model.message.AbstractMessage

controls

Constructor Summary

Constructors

Constructor and Description
SearchResultEntryImpl() Creates a SearchResponseEntry as a reply to an SearchRequest to indicate the end of a search operation.
SearchResultEntryImpl(int id) Creates a SearchResponseEntry as a reply to an SearchRequest to indicate the end of a search operation.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj) Checks for equality by comparing the objectName, and attributes properties of this Message after delegating to the super.equals() method.
Entry	getEntry() Gets the entry
Dn	getObjectName() Gets the distinguished name of the entry object returned.
int	hashCode()
void	setEntry(Entry entry) Sets the entry.
void	setObjectName(Dn objectName) Sets the distinguished name of the entry object returned.
java.lang.String	toString() Return a string representation of a SearchResultEntry request

Methods inherited from class org.apache.directory.api.ldap.model.message.AbstractMessage

addAllControls, addControl, get, getControl, getControls, getMessageId, getType, hasControl, put, removeControl, setMessageId, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.directory.api.ldap.model.message.Message

addAllControls, addControl, get, getControl, getControls, getMessageId, getType, hasControl, put, removeControl, setMessageId

Field Detail

serialVersionUID

static final long serialVersionUID

See Also:

Constant Field Values

entry

private Entry entry

Entry returned in response to search

Constructor Detail

SearchResultEntryImpl

public SearchResultEntryImpl()

Creates a SearchResponseEntry as a reply to an SearchRequest to indicate the end of a search operation.

SearchResultEntryImpl

public SearchResultEntryImpl(int id)

Creates a SearchResponseEntry as a reply to an SearchRequest to indicate the end of a search operation.

Parameters:

id - the session unique message id

Method Detail

getEntry

public Entry getEntry()

Gets the entry

Specified by:

getEntry in interface SearchResultEntry

Returns:

the entry

setEntry

public void setEntry(Entry entry)

Sets the entry.

Specified by:

setEntry in interface SearchResultEntry

Parameters:

entry - the entry

getObjectName

public Dn getObjectName()

Gets the distinguished name of the entry object returned.

Specified by:

getObjectName in interface SearchResultEntry

Returns:

the Dn of the entry returned.

setObjectName

public void setObjectName(Dn objectName)

Sets the distinguished name of the entry object returned.

Specified by:

setObjectName in interface SearchResultEntry

Parameters:

objectName - the Dn of the entry returned.

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractMessage

Returns:

the instance's hash code

See Also:

Object.hashCode()

equals

public boolean equals(java.lang.Object obj)

Checks for equality by comparing the objectName, and attributes properties of this Message after delegating to the super.equals() method.

Overrides:

equals in class AbstractMessage

Parameters:

obj - the object to test for equality with this message

Returns:

true if the obj is equal false otherwise

toString

public java.lang.String toString()

Return a string representation of a SearchResultEntry request

Overrides:

toString in class java.lang.Object