Package org.ldaptive

Class CompareResponse

java.lang.Object

org.ldaptive.AbstractMessage

org.ldaptive.AbstractResult

org.ldaptive.CompareResponse

All Implemented Interfaces:

Message, Result

public final class CompareResponse
extends AbstractResult

LDAP compare response defined as:

   CompareResponse ::= [APPLICATION 15] LDAPResult
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CompareResponse.Builder

Nested classes/interfaces inherited from class org.ldaptive.AbstractResult

AbstractResult.AbstractBuilder<B,T extends AbstractResult>, AbstractResult.DiagnosticMessageHandler, AbstractResult.MatchedDNHandler, AbstractResult.ReferralHandler, AbstractResult.ResultCodeHandler

Nested classes/interfaces inherited from class org.ldaptive.AbstractMessage

AbstractMessage.ControlParser, AbstractMessage.ControlsHandler, AbstractMessage.MessageIDHandler

Field Summary

Fields

Modifier and Type	Field	Description
private static DERPath	DIAGNOSTIC_MESSAGE_PATH	DER path to diagnostic message.
private static int	HASH_CODE_SEED	hash code seed.
private static DERPath	MATCHED_DN_PATH	DER path to matched DN.
static int	PROTOCOL_OP	BER protocol number.
private static DERPath	REFERRAL_PATH	DER path to referral.
private static DERPath	RESULT_CODE_PATH	DER path to result code.

Fields inherited from interface org.ldaptive.Result

ENCODE_CNTRL_CHARS

Constructor Summary

Constructors

Modifier	Constructor	Description
private	CompareResponse()	Default constructor.
	CompareResponse(DERBuffer buffer)	Creates a new compare response.

Method Summary

Modifier and Type	Method	Description
static CompareResponse.Builder	builder()	Creates a builder for this class.
boolean	equals(Object o)
int	hashCode()	Returns the hash code for this object.
boolean	isFalse()	Returns whether the result code in this result is ResultCode.COMPARE_FALSE.
boolean	isTrue()	Returns whether the result code in this result is ResultCode.COMPARE_TRUE.

Methods inherited from class org.ldaptive.AbstractResult

addReferralURLs, copyValues, equalsResult, getDiagnosticMessage, getMatchedDN, getReferralURLs, getResultCode, setDiagnosticMessage, setMatchedDN, setResultCode, toString

Methods inherited from class org.ldaptive.AbstractMessage

addControls, copyValues, equalsMessage, getControls, getMessageID, setMessageID

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.ldaptive.Message

getControl, getControls, getMessageID

Methods inherited from interface org.ldaptive.Result

getEncodedDiagnosticMessage, isSuccess

Field Detail

PROTOCOL_OP

public static final int PROTOCOL_OP

BER protocol number.

See Also:

Constant Field Values

HASH_CODE_SEED

private static final int HASH_CODE_SEED

hash code seed.

See Also:

Constant Field Values

RESULT_CODE_PATH

private static final DERPath RESULT_CODE_PATH

DER path to result code.

MATCHED_DN_PATH

private static final DERPath MATCHED_DN_PATH

DER path to matched DN.

DIAGNOSTIC_MESSAGE_PATH

private static final DERPath DIAGNOSTIC_MESSAGE_PATH

DER path to diagnostic message.

REFERRAL_PATH

private static final DERPath REFERRAL_PATH

DER path to referral.

Constructor Detail

CompareResponse

private CompareResponse()

Default constructor.

CompareResponse

public CompareResponse(DERBuffer buffer)

Creates a new compare response.

Parameters:

buffer - to decode

Method Detail

isTrue

public boolean isTrue()

Returns whether the result code in this result is ResultCode.COMPARE_TRUE.

Returns:

whether this result is compare true

isFalse

public boolean isFalse()

Returns whether the result code in this result is ResultCode.COMPARE_FALSE.

Returns:

whether this result is compare false

equals

public boolean equals(Object o)

Overrides:

equals in class AbstractResult

hashCode

public int hashCode()

Description copied from class: AbstractMessage

Returns the hash code for this object.

Specified by:

hashCode in class AbstractMessage

Returns:

hash code

builder

public static CompareResponse.Builder builder()

Creates a builder for this class.

Returns:

new builder