banner.types

Class Token

java.lang.Object

banner.types.Token

All Implemented Interfaces:

Comparable<Token>

public class Token
extends Object
implements Comparable<Token>

Represents a single token of text. Note that the token does not know what Mention it is a part of, if any.

Author:

Bob

Constructor Summary

Constructors

Constructor and Description
Token(Sentence sentence, int start, int end) The token is from character start to character end - 1

Method Summary

Modifier and Type	Method and Description
int	compareTo(Token token2)
boolean	contains(int index)
boolean	equals(Object obj)
int	getEnd()
int	getEnd(boolean ignoreWhitespace)
Sentence	getSentence()
int	getStart()
int	getStart(boolean ignoreWhitespace)
String	getText()
int	hashCode()
int	length()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Token

public Token(Sentence sentence,
             int start,
             int end)

The token is from character start to character end - 1

Parameters:

sentence -

start -

end -

Method Detail

getSentence

public Sentence getSentence()

Returns:

The Sentence for this Token

getText

public String getText()

Returns:

The text for this token

getStart

public int getStart()

Returns:

The start index for this token, inclusive

getEnd

public int getEnd()

Returns:

The end index for this token, exclusive

getStart

public int getStart(boolean ignoreWhitespace)

Returns:

The start index for this token, inclusive

getEnd

public int getEnd(boolean ignoreWhitespace)

Returns:

The end index for this token, exclusive

contains

public boolean contains(int index)

length

public int length()

Returns:

The number of characters in this token

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

compareTo

public int compareTo(Token token2)

Specified by:

compareTo in interface Comparable<Token>

toString

public String toString()

Overrides:

toString in class Object