Record Class IntermediateResponse

java.lang.Object

java.lang.Record

org.forgerock.opendj.ldap.messages.IntermediateResponse

Record Components:

oid - the numeric OID associated with this intermediate response, or null if there is no value.

value - the value associated with this intermediate response, or null if there is no OID. Its format is defined by the specification of this intermediate response.

controls - the List containing the controls.

All Implemented Interfaces:

ProtocolOp, Response

public record IntermediateResponse(String oid, ByteString value, List<Control> controls)
extends Record
implements Response

Provides a mechanism for communicating intermediate responses to the client.

Constructor Summary

Constructors

Constructor	Description
IntermediateResponse(String oid, ByteString value, List<Control> controls)	Creates a new IntermediateResponse.

Method Summary

Modifier and Type	Method	Description
List<Control>	controls()	Returns the value of the controls record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
boolean	hasValue()	Returns true if this intermediate response has a value.
String	oid()	Returns the value of the oid record component.
final String	toString()	Returns a string representation of this record class.
ByteString	value()	Returns the value of the value record component.

Methods inherited from class Object

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

Methods inherited from interface ProtocolOp

addControl, addControls, containsControl, getControl, getControl, removeControls

Constructor Details

IntermediateResponse

public IntermediateResponse(String oid,
 ByteString value,
 List<Control> controls)

Creates a new IntermediateResponse.

Method Details

hasValue

public boolean hasValue()

Returns true if this intermediate response has a value. In some circumstances it may be useful to determine if an intermediate response has a value, without actually calculating the value and incurring any performance costs.

Returns:

true if this intermediate response has a value, or false if there is no value.

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

oid

public String oid()

Returns the value of the oid record component.

Returns:

the value of the oid record component

value

public ByteString value()

Returns the value of the value record component.

Returns:

the value of the value record component

controls

public List<Control> controls()

Returns the value of the controls record component.

Specified by:

controls in interface ProtocolOp

Returns:

the value of the controls record component