org.nineml.coffeegrinder.tokens

Class TokenCharacter

java.lang.Object

org.nineml.coffeegrinder.util.Decoratable

org.nineml.coffeegrinder.tokens.Token

org.nineml.coffeegrinder.tokens.TokenCharacter

public class TokenCharacter
extends Token

A single character Token.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj) Test tokens for equality.
static TokenCharacter	get(int ch) Create a token for the specified character.
static TokenCharacter	get(int ch, java.util.Collection<ParserAttribute> attributes) Create a token for the specified character.
static TokenCharacter	get(int ch, ParserAttribute attribute) Create a token for the specified character.
int	getCodepoint() Return the codepoint value of this token (its character codepoint)
java.lang.String	getValue() Return the value of this token (its character).
int	hashCode() Assure that equal tokens return the same hash code.
boolean	matches(java.lang.String input) Does this token match this string?
boolean	matches(Token input) Does this token match the input?
java.lang.String	toString() Pretty print a token.

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

Method Detail

get

public static TokenCharacter get(int ch)

Create a token for the specified character.

Parameters:

ch - the character

Returns:

a token

get

public static TokenCharacter get(int ch,
                                 ParserAttribute attribute)

Create a token for the specified character.

Parameters:

ch - the character

attribute - the attribute

Returns:

a token

get

public static TokenCharacter get(int ch,
                                 java.util.Collection<ParserAttribute> attributes)

Create a token for the specified character.

Parameters:

ch - the character

attributes - the attributes

Returns:

a token

getValue

public java.lang.String getValue()

Return the value of this token (its character).

Specified by:

getValue in class Token

Returns:

The character value of the token.

getCodepoint

public int getCodepoint()

Return the codepoint value of this token (its character codepoint)

Returns:

the codepoint

matches

public boolean matches(Token input)

Does this token match the input?

This token matches other token characters that have the same character as well as TokenStrings that are one character long and contain the same character.

Specified by:

matches in class Token

Parameters:

input - The input.

Returns:

true if they match.

matches

public boolean matches(java.lang.String input)

Does this token match this string?

Parameters:

input - the input string.

Returns:

true if it's a single-character long string containing the same character as this token.

equals

public boolean equals(java.lang.Object obj)

Test tokens for equality.

Two tokens are equal if they represent the same character.

Overrides:

equals in class java.lang.Object

Parameters:

obj - An object.

Returns:

true if obj is equal to this terminal character.

hashCode

public int hashCode()

Assure that equal tokens 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 token.

Overrides:

toString in class java.lang.Object

Returns:

a string representation of the object.