sjm.parse.tokens
Class TokenAssembly
java.lang.Object
|
+--sjm.parse.Assembly
|
+--sjm.parse.tokens.TokenAssembly
- All Implemented Interfaces:
- java.lang.Cloneable, java.util.Enumeration, PubliclyCloneable
- public class TokenAssembly
- extends Assembly
A TokenAssembly is an Assembly whose elements are Tokens.
Tokens are, roughly, the chunks of text that a
Tokenizer
returns.
- Version:
- 1.0
- Author:
- Steven J. Metsker
Constructor Summary |
TokenAssembly(java.lang.String s)
Constructs a TokenAssembly on a TokenString constructed
from the given String. |
TokenAssembly(Tokenizer t)
Constructs a TokenAssembly on a TokenString constructed
from the given Tokenizer. |
TokenAssembly(TokenString tokenString)
Constructs a TokenAssembly from the given TokenString. |
Method Summary |
java.lang.String |
consumed(java.lang.String delimiter)
Returns a textual representation of the amount of this
tokenAssembly that has been consumed. |
java.lang.String |
defaultDelimiter()
Returns the default string to show between elements
consumed or remaining. |
int |
length()
Returns the number of elements in this assembly. |
java.lang.Object |
nextElement()
Returns the next token. |
java.lang.Object |
peek()
Shows the next object in the assembly, without removing it |
java.lang.String |
remainder(java.lang.String delimiter)
Returns a textual representation of the amount of this
tokenAssembly that remains to be consumed. |
Methods inherited from class sjm.parse.Assembly |
clone, elementsConsumed, elementsRemaining, getStack, getTarget, hasMoreElements, pop, push, setTarget, stackIsEmpty, toString, unget |
Methods inherited from class java.lang.Object |
, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
tokenString
protected TokenString tokenString
- the "string" of tokens this assembly will consume
TokenAssembly
public TokenAssembly(java.lang.String s)
- Constructs a TokenAssembly on a TokenString constructed
from the given String.
- Parameters:
string
- the string to consume
TokenAssembly
public TokenAssembly(Tokenizer t)
- Constructs a TokenAssembly on a TokenString constructed
from the given Tokenizer.
- Parameters:
Tokenizer
- the tokenizer to consume tokens
from
TokenAssembly
public TokenAssembly(TokenString tokenString)
- Constructs a TokenAssembly from the given TokenString.
- Parameters:
tokenString
- the tokenString to consume
consumed
public java.lang.String consumed(java.lang.String delimiter)
- Returns a textual representation of the amount of this
tokenAssembly that has been consumed.
- Overrides:
consumed
in class Assembly
- Parameters:
delimiter
- the mark to show between consumed
elements- Returns:
- a textual description of the amount of this
assembly that has been consumed
defaultDelimiter
public java.lang.String defaultDelimiter()
- Returns the default string to show between elements
consumed or remaining.
- Overrides:
defaultDelimiter
in class Assembly
- Returns:
- the default string to show between elements
consumed or remaining
length
public int length()
- Returns the number of elements in this assembly.
- Overrides:
length
in class Assembly
- Returns:
- the number of elements in this assembly
nextElement
public java.lang.Object nextElement()
- Returns the next token.
- Returns:
- the next token from the associated token string.
- Throws:
ArrayIndexOutOfBoundsException
- if there are no
more tokens in this tokenizer's string.
peek
public java.lang.Object peek()
- Shows the next object in the assembly, without removing it
- Overrides:
peek
in class Assembly
- Returns:
- the next object
remainder
public java.lang.String remainder(java.lang.String delimiter)
- Returns a textual representation of the amount of this
tokenAssembly that remains to be consumed.
- Overrides:
remainder
in class Assembly
- Parameters:
delimiter
- the mark to show between consumed
elements- Returns:
- a textual description of the amount of this
assembly that remains to be consumed