Record Class McpGuideMatch

java.lang.Object

java.lang.Record

com.shaft.mcp.McpGuideMatch

Record Components:

title - page title

section - matched section title

url - canonical guide URL

score - local relevance score

excerpt - short official guide excerpt

codeBlocks - nearby official guide code examples

public record McpGuideMatch(String title, String section, String url, double score, String excerpt, List<McpCodeBlock> codeBlocks)
extends Record

One official SHAFT user-guide match returned by shaft_guide_search.

Constructor Summary

Constructors

Constructor	Description
McpGuideMatch(String title, String section, String url, double score, String excerpt, List<McpCodeBlock> codeBlocks)	Creates an immutable guide match.

Method Summary

Modifier and Type	Method	Description
List<McpCodeBlock>	codeBlocks()	Returns the value of the codeBlocks record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
String	excerpt()	Returns the value of the excerpt record component.
final int	hashCode()	Returns a hash code value for this object.
double	score()	Returns the value of the score record component.
String	section()	Returns the value of the section record component.
String	title()	Returns the value of the title record component.
final String	toString()	Returns a string representation of this record class.
String	url()	Returns the value of the url record component.

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Details

McpGuideMatch

public McpGuideMatch(String title,
 String section,
 String url,
 double score,
 String excerpt,
 List<McpCodeBlock> codeBlocks)

Creates an immutable guide match.

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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with the compare method from their corresponding wrapper classes.

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.

title

public String title()

Returns the value of the title record component.

Returns:

the value of the title record component

section

public String section()

Returns the value of the section record component.

Returns:

the value of the section record component

url

public String url()

Returns the value of the url record component.

Returns:

the value of the url record component

score

public double score()

Returns the value of the score record component.

Returns:

the value of the score record component

excerpt

public String excerpt()

Returns the value of the excerpt record component.

Returns:

the value of the excerpt record component

codeBlocks

public List<McpCodeBlock> codeBlocks()

Returns the value of the codeBlocks record component.

Returns:

the value of the codeBlocks record component