Module io.jenetics.ext

Package io.jenetics.ext.grammar

Record Class Cfg.Rule<T>

java.lang.Object

java.lang.Record

io.jenetics.ext.grammar.Cfg.Rule<T>

Type Parameters:

T - the terminal symbol value type

All Implemented Interfaces:

Cfg.Annotatable<T>

Enclosing class:

Cfg<T>

public static record Cfg.Rule<T>(Cfg.NonTerminal<T> start, List<Cfg.Expression<T>> alternatives, Object annotation)
extends Record
implements Cfg.Annotatable<T>

Represents a production rule of the grammar (R).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	Cfg.Rule.Builder<T>	Builder class for building CFG rules.

Constructor Summary

Constructors

Constructor	Description
Rule(Cfg.NonTerminal<T> start, List<Cfg.Expression<T>> alternatives)
Rule(Cfg.NonTerminal<T> start, List<Cfg.Expression<T>> alternatives, Object annotation)	Creates a new rule object.

Method Summary

Modifier and Type	Method	Description
List<Cfg.Expression<T>>	alternatives()	Returns the value of the alternatives record component.
Object	annotation()	Returns the value of the annotation record component.
Cfg.Rule<T>	at(Object annotation)	Create a new copy of the CFG element, with the given annotation.
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.
Cfg.NonTerminal<T>	start()	Returns the value of the start 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

Rule

public Rule(Cfg.NonTerminal<T> start,
 List<Cfg.Expression<T>> alternatives,
 Object annotation)

Creates a new rule object.

Parameters:

start - the start symbol of the rule

alternatives - the list of alternative rule expressions

Throws:

IllegalArgumentException - if the given list of alternatives is empty

NullPointerException - if one of the arguments is null

Rule

public Rule(Cfg.NonTerminal<T> start,
 List<Cfg.Expression<T>> alternatives)

Method Details

at

public Cfg.Rule<T> at(Object annotation)

Description copied from interface: Cfg.Annotatable

Create a new copy of the CFG element, with the given annotation.

Specified by:

at in interface Cfg.Annotatable<T>

Parameters:

annotation - the annotation of the newly created element, may be null

Returns:

a copy of the element with the given annotation

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.

start

public Cfg.NonTerminal<T> start()

Returns the value of the start record component.

Returns:

the value of the start record component

alternatives

public List<Cfg.Expression<T>> alternatives()

Returns the value of the alternatives record component.

Returns:

the value of the alternatives record component

annotation

public Object annotation()

Returns the value of the annotation record component.

Specified by:

annotation in interface Cfg.Annotatable<T>

Returns:

the value of the annotation record component