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

Class AbstractResultResponse

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

All Implemented Interfaces:

Message, Response, ResultResponse

Direct Known Subclasses:

AbstractExtendedResponse, AddResponseImpl, BindResponseImpl, CompareResponseImpl, DeleteResponseImpl, IntermediateResponseImpl, ModifyDnResponseImpl, ModifyResponseImpl, SearchResultDoneImpl

public abstract class AbstractResultResponse
extends AbstractResponse
implements ResultResponse

Abstract base for a ResultResponse message.

Author:

Apache Directory Project

Field Summary

Fields

Modifier and Type	Field	Description
protected LdapResult	ldapResult	Response result components

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

controls

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractResultResponse(int id, MessageTypeEnum type)	Allows subclasses based on the abstract type to create a response to a request.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)	Checks to see if an object is equal to this AbstractResultResponse.
LdapResult	getLdapResult()	Gets the LdapResult components of this Response.
int	hashCode()
String	toString()	Get a String representation of an Response

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

ldapResult

protected LdapResult ldapResult

Response result components

Constructor Detail

AbstractResultResponse

protected AbstractResultResponse(int id,
                                 MessageTypeEnum type)

Allows subclasses based on the abstract type to create a response to a request.

Parameters:

id - the response eliciting this Request

type - the message type of the response

Method Detail

getLdapResult

public LdapResult getLdapResult()

Gets the LdapResult components of this Response.

Specified by:

getLdapResult in interface ResultResponse

Returns:

the LdapResult for this Response.

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractMessage

Returns:

the instance's hash code

See Also:

Object.hashCode()

equals

public boolean equals(Object obj)

Checks to see if an object is equal to this AbstractResultResponse. First the object is checked to see if it is this AbstractResultResponse instance if so it returns true. Next it checks if the super method returns false and if it does false is returned. It then checks if the LDAPResult's are equal. If not false is returned and if they match true is returned.

Overrides:

equals in class AbstractMessage

Parameters:

obj - the object to compare to this LdapResult containing response

Returns:

true if they objects are equivalent false otherwise

toString

public String toString()

Get a String representation of an Response

Overrides:

toString in class Object

Returns:

An Response String