Record Class SearchIndex.Entry

java.lang.Object

java.lang.Record

ai.redouble.docs.SearchIndex.Entry

Enclosing class:

SearchIndex

public static record SearchIndex.Entry(String url, String title, String part, String heading, String text)
extends Record

One place a search lands on: the address relative to the site's root, the title of the page or the name of the class, the part of the contents the page belongs to (null for the front matter), the heading of the section (null for a page's opening and for a class) and the text searched.

Since:

0.1 (2026-10-01)

Author:

Andrey Santrosyan

Constructor Summary

Constructors

Constructor	Description
Entry(String url, String title, String part, String heading, String text)	Creates an instance of a Entry 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.
String	heading()	Returns the value of the heading record component.
String	part()	Returns the value of the part record component.
String	text()	Returns the value of the text 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

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

Constructor Details

Entry

public Entry(String url,
 String title,
 String part,
 String heading,
 String text)

Creates an instance of a Entry record class.

Parameters:

url - the value for the url record component

title - the value for the title record component

part - the value for the part record component

heading - the value for the heading record component

text - the value for the text 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.

url

public String url()

Returns the value of the url record component.

Returns:

the value of the url record component

title

public String title()

Returns the value of the title record component.

Returns:

the value of the title record component

part

public String part()

Returns the value of the part record component.

Returns:

the value of the part record component

heading

public String heading()

Returns the value of the heading record component.

Returns:

the value of the heading record component

text

public String text()

Returns the value of the text record component.

Returns:

the value of the text record component