Package quickparse.grammar.symbol

Class Symbol

java.lang.Object

quickparse.grammar.symbol.Symbol

Direct Known Subclasses:

ConstructSymbol, TokenSymbol

public abstract class Symbol
extends java.lang.Object

Defines a grammar symbol. A grammar symbol can identify a construct (i.e., a 'non-terminal' symbol) or a token (i.e., a 'terminal' symbol).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Symbol.ConstructAction	An action that can be executed on a ConstructSymbol
static interface	Symbol.ConstructFunction<R,C>	A function that can be executed on a ConstructSymbol
static interface	Symbol.Function<R,C>	Represents a function that can be computed on a ConstructSymbol or, alternatively, on a TokenSymbol.
static interface	Symbol.TokenAction	An action that can be executed on a TokenSymbol
static interface	Symbol.TokenFunction<R,C>	A function that can be executed on a TokenSymbol

Constructor Summary

Constructors

Constructor	Description
Symbol()

Method Summary

Modifier and Type	Method	Description
abstract <R, C> R	accept(C context, Symbol.Function<R,C> symbolFunction)	Solves the subclass of this symbol (ConstructSymbol or TokenSymbol and computes the given Symbol.Function
abstract java.lang.String	getName()	The name of the symbol
<R, C> R	ifConstruct(C context, Symbol.ConstructFunction<R,C> function)	If this symbol is a ConstructSymbol instance, computes the given Symbol.ConstructFunction on it.
void	ifConstruct(Symbol.ConstructAction action)	If this symbol is a ConstructSymbol instance, computes the given Symbol.ConstructAction on it.
<R, C> R	ifToken(C context, Symbol.TokenFunction<R,C> function)	If this symbol is a ConstructSymbol instance, computes the given Symbol.TokenFunction on it.
void	ifToken(Symbol.TokenAction action)	If this symbol is a TokenSymbol instance, computes the given Symbol.TokenAction on it.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Symbol

public Symbol()

Method Details

getName

public abstract java.lang.String getName()

The name of the symbol

Returns:

the name of this symbol as a String

accept

public abstract <R, C> R accept(C context, Symbol.Function<R,C> symbolFunction)

Solves the subclass of this symbol (ConstructSymbol or TokenSymbol and computes the given Symbol.Function

Type Parameters:

R - the return type of the function

C - the context type for the function

Parameters:

context - the context used for computation

symbolFunction - the function that must be computed on this symbol

Returns:

the return value returned by computing the Symbol.Function

ifToken

public final void ifToken(Symbol.TokenAction action)

If this symbol is a TokenSymbol instance, computes the given Symbol.TokenAction on it.

Parameters:

action - the Symbol.TokenAction to compute

ifConstruct

public final void ifConstruct(Symbol.ConstructAction action)

If this symbol is a ConstructSymbol instance, computes the given Symbol.ConstructAction on it.

Parameters:

action - the Symbol.ConstructAction to compute

ifToken

public final <R, C> R ifToken(C context, Symbol.TokenFunction<R,C> function)

If this symbol is a ConstructSymbol instance, computes the given Symbol.TokenFunction on it.

Type Parameters:

R - the return type of the function

C - the context type for the function

Parameters:

context - the contex used to compute the Symbol.TokenFunction

function - the Symbol.TokenFunction to compute

Returns:

the return value returned by computing the Symbol.TokenFunction

ifConstruct

public final <R, C> R ifConstruct(C context, Symbol.ConstructFunction<R,C> function)

If this symbol is a ConstructSymbol instance, computes the given Symbol.ConstructFunction on it.

Type Parameters:

R - the return type of the function

C - the context type for the function

Parameters:

context - the contex used to compute the Symbol.ConstructFunction

function - the Symbol.ConstructFunction to compute

Returns:

the return value returned by computing the Symbol.ConstructFunction