Module org.klojang.templates

Package org.klojang.templates

Record Class VariableOccurrence

java.lang.Object

java.lang.Record

org.klojang.templates.VariableOccurrence

Record Components:

name - the name of the variable

varGroup - an Optional containing the variable group corresponding to the group name prefix (as in ~%myVarGroup:foo%), or an empty Optional if there was no group name prefix

placeholder - an Optional containing the placeholder value for this occurrence (as in <!-- ~%firstName% -->John<!--%-->), or an empty Optional if no placeholder was specified. (See VarGroup.DEF and Regex.REGEX_CMT_VARIABLE.)

position - the position (index) of this occurrence within the template

public record VariableOccurrence(String name, Optional<VarGroup> varGroup, Optional<String> placeholder, int position)
extends Record

Represents a concrete occurrence of a variable within a template. Variable names may occur multiple times within the same template. A VariableOccurrence captures the information associated with a single occurrence.

Constructor Summary

Constructors

Constructor	Description
VariableOccurrence(String name, Optional<VarGroup> varGroup, Optional<String> placeholder, int position)	Creates an instance of a VariableOccurrence 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	name()	Returns the value of the name record component.
Optional<String>	placeholder()	Returns the value of the placeholder record component.
int	position()	Returns the value of the position record component.
final String	toString()	Returns a string representation of this record class.
Optional<VarGroup>	varGroup()	Returns the value of the varGroup record component.

Methods inherited from class java.lang.Object

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

Constructor Details

VariableOccurrence

public VariableOccurrence(String name,
 Optional<VarGroup> varGroup,
 Optional<String> placeholder,
 int position)

Creates an instance of a VariableOccurrence record class.

Parameters:

name - the value for the name record component

varGroup - the value for the varGroup record component

placeholder - the value for the placeholder record component

position - the value for the position 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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.

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.

Returns:

the value of the name record component

varGroup

public Optional<VarGroup> varGroup()

Returns the value of the varGroup record component.

Returns:

the value of the varGroup record component

placeholder

public Optional<String> placeholder()

Returns the value of the placeholder record component.

Returns:

the value of the placeholder record component

position

public int position()

Returns the value of the position record component.

Returns:

the value of the position record component