org.nineml.coffeegrinder.tokens

Class TokenRegex

java.lang.Object

org.nineml.coffeegrinder.util.Decoratable

org.nineml.coffeegrinder.tokens.Token

org.nineml.coffeegrinder.tokens.TokenRegex

public class TokenRegex
extends Token

A regular expression token Token.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
static TokenRegex	get(java.lang.String expr) Create a token for the specified regular expression.
static TokenRegex	get(java.lang.String expr, java.util.Collection<ParserAttribute> attributes) Create a token for the specified regular expression (with attributes)
static TokenRegex	get(java.lang.String expr, ParserAttribute attribute) Create a token for the specified regular expression (with an attribute)
java.lang.String	getValue() Get the regular expression.
int	hashCode()
java.lang.String	matches(java.lang.String input)
boolean	matches(Token input) Does this token match the input token?
java.lang.String	toString()

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 TokenRegex get(java.lang.String expr)

Create a token for the specified regular expression.

Parameters:

expr - the expression

Returns:

the token

get

public static TokenRegex get(java.lang.String expr,
                             ParserAttribute attribute)

Create a token for the specified regular expression (with an attribute)

Parameters:

expr - the expression

attribute - the attribute

Returns:

the token

Throws:

java.lang.NullPointerException - if the attribute is null

get

public static TokenRegex get(java.lang.String expr,
                             java.util.Collection<ParserAttribute> attributes)

Create a token for the specified regular expression (with attributes)

Parameters:

expr - the expression

attributes - the attributes

Returns:

the token

getValue

public java.lang.String getValue()

Get the regular expression.

Specified by:

getValue in class Token

Returns:

The regular expression used by this token.

matches

public final boolean matches(Token input)

Does this token match the input token?

A regular expression token matches a TokenCharacter or TokenString if the regular expression matches the value. Returns fals for all other kinds of tokens.

Specified by:

matches in class Token

Parameters:

input - The input.

Returns:

true if they match

matches

public final java.lang.String matches(java.lang.String input)

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object