Package org.ek9lang.compiler.directives

Record Class DirectiveSpec

java.lang.Object

java.lang.Record

org.ek9lang.compiler.directives.DirectiveSpec

public record DirectiveSpec(IToken token, CompilationPhase phase, ISymbol.SymbolCategory symbolCategory, String symbolName, String additionalName, int lineNumber)
extends Record

Specification of a directive, all the common details used in a range of directives.

Constructor Summary

Constructors

Constructor	Description
DirectiveSpec(IToken token, CompilationPhase phase, ISymbol.SymbolCategory symbolCategory, String symbolName, String additionalName, int lineNumber)	Creates an instance of a DirectiveSpec record class.

Method Summary

Modifier and Type	Method	Description
String	additionalName()	Returns the value of the additionalName 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.
int	lineNumber()	Returns the value of the lineNumber record component.
CompilationPhase	phase()	Returns the value of the phase record component.
ISymbol.SymbolCategory	symbolCategory()	Returns the value of the symbolCategory record component.
String	symbolName()	Returns the value of the symbolName record component.
IToken	token()	Returns the value of the token 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

DirectiveSpec

public DirectiveSpec(IToken token,
 CompilationPhase phase,
 ISymbol.SymbolCategory symbolCategory,
 String symbolName,
 String additionalName,
 int lineNumber)

Creates an instance of a DirectiveSpec record class.

Parameters:

token - the value for the token record component

phase - the value for the phase record component

symbolCategory - the value for the symbolCategory record component

symbolName - the value for the symbolName record component

additionalName - the value for the additionalName record component

lineNumber - the value for the lineNumber 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.

token

public IToken token()

Returns the value of the token record component.

Returns:

the value of the token record component

phase

public CompilationPhase phase()

Returns the value of the phase record component.

Returns:

the value of the phase record component

symbolCategory

public ISymbol.SymbolCategory symbolCategory()

Returns the value of the symbolCategory record component.

Returns:

the value of the symbolCategory record component

symbolName

public String symbolName()

Returns the value of the symbolName record component.

Returns:

the value of the symbolName record component

additionalName

public String additionalName()

Returns the value of the additionalName record component.

Returns:

the value of the additionalName record component

lineNumber

public int lineNumber()

Returns the value of the lineNumber record component.

Returns:

the value of the lineNumber record component