Module com.darkcollective.relix.embed

Package com.darkcollective.relix.embed

Record Class ReferencePage

java.lang.Object

java.lang.Record

com.darkcollective.relix.embed.ReferencePage

Record Components:

path - where the page sits in the reference, such as operators/select.md; the argument to referencePage

category - the family it belongs to: operator, join, set, aggregate, predicate, literal, language, advanced or guide

title - a short name, such as Selection

symbol - how the construct is written, such as σ or ROLLING; for a page about no single construct, a key word for it

summary - one line saying what it is for

keys - every word the page can be looked up by, lower case except for glyphs: its symbol, its keyword spellings, its common names

public record ReferencePage(String path, String category, String title, String symbol, String summary, List<String> keys)
extends Record

One page of the language reference, as Relix.referencePages() lists it.

The markdown itself is Relix.referencePage(String) of path(). The other components are what a tool needs to find and list a page without reading it: the words a user might look it up by, and a one-line summary.

Since:

1.0

Constructor Summary

Constructors

Constructor	Description
ReferencePage(String path, String category, String title, String symbol, String summary, List<String> keys)	Checks every component and copies the keys.

Method Summary

Modifier and Type	Method	Description
String	category()	Returns the value of the category 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.
List<String>	keys()	Returns the value of the keys record component.
String	path()	Returns the value of the path record component.
String	summary()	Returns the value of the summary record component.
String	symbol()	Returns the value of the symbol record component.
String	title()	Returns the value of the title record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

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

Constructor Details

ReferencePage

public ReferencePage(String path,
 String category,
 String title,
 String symbol,
 String summary,
 List<String> keys)

Checks every component and copies the keys.

Since:

1.0

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.

path

public String path()

Returns the value of the path record component.

Returns:

the value of the path record component

category

public String category()

Returns the value of the category record component.

Returns:

the value of the category record component

title

public String title()

Returns the value of the title record component.

Returns:

the value of the title record component

symbol

public String symbol()

Returns the value of the symbol record component.

Returns:

the value of the symbol record component

summary

public String summary()

Returns the value of the summary record component.

Returns:

the value of the summary record component

keys

public List<String> keys()

Returns the value of the keys record component.

Returns:

the value of the keys record component