Package com.puppycrawl.tools.checkstyle.site

Record Class SearchIndexEntry

java.lang.Object

java.lang.Record

com.puppycrawl.tools.checkstyle.site.SearchIndexEntry

Record Components:

title - display name

url - relative URL

category - category label

type - document type

description - short description

keywords - comma-separated keywords

public record SearchIndexEntry(String title, String url, String category, String type, String description, String keywords)
extends Record

Represents a single entry in the client-side search index.

Field Summary

Fields

Modifier and Type	Field	Description
private static final int	ASCII_MAX	Maximum ASCII value for the lookup table.
private final String	category	The field for the category record component.
private static final String	COMMA	String literal for comma.
private final String	description	The field for the description record component.
private static final String[]	JSON_ESCAPES	Lookup table for JSON escape sequences for characters < 128 (ASCII range).
private final String	keywords	The field for the keywords record component.
private final String	title	The field for the title record component.
private final String	type	The field for the type record component.
private final String	url	The field for the url record component.

Constructor Summary

Constructors

Constructor	Description
SearchIndexEntry(String title, String url, String category, String type, String description, String keywords)	Creates an instance of a SearchIndexEntry record class.

Method Summary

Modifier and Type	Method	Description
String	category()	Returns the value of the category record component.
String	description()	Returns the value of the description 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.
private static String	jsonString(String value)	Wraps a string value in JSON double quotes and escapes special characters.
String	keywords()	Returns the value of the keywords record component.
String	title()	Returns the value of the title record component.
String	toJson()	Serialises this entry to a compact JSON object string.
final String	toString()	Returns a string representation of this record class.
String	type()	Returns the value of the type record component.
String	url()	Returns the value of the url record component.

Methods inherited from class java.lang.Object

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

Field Details

title

private final String title

The field for the title record component.

url

private final String url

The field for the url record component.

category

private final String category

The field for the category record component.

type

private final String type

The field for the type record component.

description

private final String description

The field for the description record component.

keywords

private final String keywords

The field for the keywords record component.

COMMA

private static final String COMMA

String literal for comma.

See Also:

• Constant Field Values

ASCII_MAX

private static final int ASCII_MAX

Maximum ASCII value for the lookup table.

See Also:

• Constant Field Values

JSON_ESCAPES

private static final String[] JSON_ESCAPES

Lookup table for JSON escape sequences for characters < 128 (ASCII range).

Constructor Details

SearchIndexEntry

public SearchIndexEntry(String title,
 String url,
 String category,
 String type,
 String description,
 String keywords)

Creates an instance of a SearchIndexEntry record class.

Parameters:

title - the value for the title record component

url - the value for the url record component

category - the value for the category record component

type - the value for the type record component

description - the value for the description record component

keywords - the value for the keywords record component

Method Details

toJson

public String toJson()

Serialises this entry to a compact JSON object string.

Returns:

JSON object string

jsonString

private static String jsonString(String value)

Wraps a string value in JSON double quotes and escapes special characters.

Parameters:

value - the raw string to encode

Returns:

JSON-safe quoted string, or "" if value is null

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.

title

public String title()

Returns the value of the title record component.

Returns:

the value of the title record component

url

public String url()

Returns the value of the url record component.

Returns:

the value of the url record component

category

public String category()

Returns the value of the category record component.

Returns:

the value of the category record component

type

public String type()

Returns the value of the type record component.

Returns:

the value of the type record component

description

public String description()

Returns the value of the description record component.

Returns:

the value of the description record component

keywords

public String keywords()

Returns the value of the keywords record component.

Returns:

the value of the keywords record component