Record Class CASyntaxRuleLeaf

java.lang.Object

java.lang.Record

com.io7m.cardant.parsers.CASyntaxRuleLeaf

Record Components:

name - The name

text - The rule text

examples - The examples

All Implemented Interfaces:

CASyntaxRuleType, Comparable<CASyntaxRuleType>

public record CASyntaxRuleLeaf(String name, String text, List<String> examples)
extends Record
implements CASyntaxRuleType

A syntax rule leaf.

Constructor Summary

Constructors

Constructor	Description
CASyntaxRuleLeaf(String name, String text, List<String> examples)	A syntax rule leaf.

Method Summary

Modifier and Type	Method	Description
int	compareTo(CASyntaxRuleType other)
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
List<String>	examples()	Returns the value of the examples record component.
final int	hashCode()	Returns a hash code value for this object.
String	name()	Returns the value of the name record component.
List<String>	subRules()
String	text()	Returns the value of the text record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class Object

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

Constructor Details

CASyntaxRuleLeaf

public CASyntaxRuleLeaf(String name,
 String text,
 List<String> examples)

A syntax rule leaf.

Parameters:

name - The name

text - The rule text

examples - The examples

Method Details

compareTo

public int compareTo(CASyntaxRuleType other)

Specified by:

compareTo in interface Comparable<CASyntaxRuleType>

subRules

public List<String> subRules()

Specified by:

subRules in interface CASyntaxRuleType

Returns:

The syntax rules

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.

name

public String name()

Returns the value of the name record component.

Specified by:

name in interface CASyntaxRuleType

Returns:

the value of the name record component

text

public String text()

Returns the value of the text record component.

Specified by:

text in interface CASyntaxRuleType

Returns:

the value of the text record component

examples

public List<String> examples()

Returns the value of the examples record component.

Specified by:

examples in interface CASyntaxRuleType

Returns:

the value of the examples record component