org.nineml.coffeegrinder.parser

Class NonterminalSymbol

java.lang.Object

org.nineml.coffeegrinder.util.Decoratable

org.nineml.coffeegrinder.parser.Symbol

org.nineml.coffeegrinder.parser.NonterminalSymbol

public class NonterminalSymbol
extends Symbol

A nonterminal symbol in the grammar.

Every nonterminal must be defined by a Rule in the Grammar.

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	symbolName

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj) Test nonterminals for equality.
java.lang.String	getName() The name of this symbol.
int	hashCode() Assure that equal nonterminals return the same hash code.
boolean	matches(Symbol input) Are these the same symbol?
boolean	matches(Token input) Does this symbol match the input token?
java.lang.String	toString() Pretty print a nonterminal.

Methods inherited from class org.nineml.coffeegrinder.util.Decoratable

addAttribute, addAttributes, getAttribute, getAttributes, getAttributesMap, getAttributeValue, hasAttribute

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

symbolName

public final java.lang.String symbolName

Method Detail

getName

public java.lang.String getName()

The name of this symbol.

Returns:

the name of the symbol.

matches

public final boolean matches(Symbol input)

Are these the same symbol?

Specified by:

matches in class Symbol

Parameters:

input - The symbol.

Returns:

true if they're the same nonterminal symbol.

matches

public final boolean matches(Token input)

Does this symbol match the input token?

No, it does not. No nonterminal ever matches an input token.

Specified by:

matches in class Symbol

Parameters:

input - The token.

Returns:

false

equals

public boolean equals(java.lang.Object obj)

Test nonterminals for equality.

Two nonterminals are equal if they have the same name.

Overrides:

equals in class java.lang.Object

Parameters:

obj - An object.

Returns:

true if obj is equal to this nonterminal.

hashCode

public int hashCode()

Assure that equal nonterminals return the same hash code.

Overrides:

hashCode in class java.lang.Object

Returns:

the hash code.

toString

public java.lang.String toString()

Pretty print a nonterminal.

Overrides:

toString in class java.lang.Object

Returns:

a string representation of the object.