Record Class CaptureControlServer.PickLocatorResponse

java.lang.Object

java.lang.Record

com.shaft.capture.control.CaptureControlServer.PickLocatorResponse

Record Components:

snippet - winning candidate's copy-paste Java locator expression

ranked - every supplied candidate, ranked best-first

Enclosing class:

CaptureControlServer

public static record CaptureControlServer.PickLocatorResponse(String snippet, List<CaptureControlServer.RankedCandidate> ranked)
extends Record

Pick-locator result: the best candidate's snippet plus every candidate ranked best-first.

Constructor Summary

Constructors

Constructor	Description
PickLocatorResponse(String snippet, List<CaptureControlServer.RankedCandidate> ranked)	Creates an instance of a PickLocatorResponse record class.

Method Summary

Modifier and Type	Method	Description
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.
List<CaptureControlServer.RankedCandidate>	ranked()	Returns the value of the ranked record component.
String	snippet()	Returns the value of the snippet record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Details

PickLocatorResponse

public PickLocatorResponse(String snippet,
 List<CaptureControlServer.RankedCandidate> ranked)

Creates an instance of a PickLocatorResponse record class.

Parameters:

snippet - the value for the snippet record component

ranked - the value for the ranked record component

Method Details

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.

snippet

public String snippet()

Returns the value of the snippet record component.

Returns:

the value of the snippet record component

ranked

public List<CaptureControlServer.RankedCandidate> ranked()

Returns the value of the ranked record component.

Returns:

the value of the ranked record component