Class YaspToken

java.lang.Object
  YaspToken

public class YaspToken

extends java.lang.Object

Class representing a token. A token can be

• WORD
• VERSE_SEPARATOR
• STANZA_SEPARATOR
• END_OF_POEM
• UNDEF

Field Summary

static char	END_OF_POEM
static char	STANZA_SEPARATOR
static char	UNDEF
static char	VERSE_SEPARATOR
static char	WORD

Constructor Summary

YaspToken()
Create an instance of YaspToken.

YaspToken(char type)
Create an instance of YaspToken.

YaspToken(java.lang.String word)
Create an instance of YaspToken.

Method Summary

char	getType() Return the type of this YaspToken.
java.lang.String	getWord() Return the value of this YaspToken.
boolean	isWord() Return whether this YaspToken is a word.
void	setType(char type) Set the type of this YaspToken.
void	setWord(java.lang.String word) Set the value of this YaspToken.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

WORD

public static final char WORD

See Also:

Constant Field Values

VERSE_SEPARATOR

public static final char VERSE_SEPARATOR

See Also:

Constant Field Values

STANZA_SEPARATOR

public static final char STANZA_SEPARATOR

See Also:

Constant Field Values

END_OF_POEM

public static final char END_OF_POEM

See Also:

Constant Field Values

UNDEF

public static final char UNDEF

See Also:

Constant Field Values

Constructor Detail

YaspToken

public YaspToken()

Create an instance of YaspToken.

YaspToken

public YaspToken(char type)

Create an instance of YaspToken.

YaspToken

public YaspToken(java.lang.String word)

Create an instance of YaspToken.

Method Detail

isWord

public boolean isWord()

Return whether this YaspToken is a word.

getType

public char getType()

Return the type of this YaspToken.

Returns:

char {w,n,s,e,?}

setType

public void setType(char type)

Set the type of this YaspToken.

Parameters:

type - valid chars are w,n,s,e,?

getWord

public java.lang.String getWord()

Return the value of this YaspToken.

Returns:

String or null, if the type of the YaspToken is not WORD

setWord

public void setWord(java.lang.String word)

Set the value of this YaspToken.

toString

public java.lang.String toString()