de.dante.extex.interpreter.type.tokens
Interface FixedTokens

All Known Implementing Classes:
Tokens

public interface FixedTokens

This interface describes the features of a Tokens which do not modify the value.

Version:
$Revision: 1.8 $
Author:
Gerd Neugebauer

Method Summary
 Token get(int i)
          Get a specified token from the tokens register.
 int length()
          Getter for the length of the token register, this is the number of elements contained.
 void show(Context context, Tokens toks)
          Determine the printable representation of the object and append it to a list of Tokens.
 java.lang.String toString()
          Return a String, which shows all tokens in the list.
 java.lang.String toText()
          Return a String, which shows all tokens (in text format) in the list.
 java.lang.String toText(UnicodeChar esc)
          Return a String, which shows all tokens (in text format) in the list.
 

Method Detail

get

public Token get(int i)
Get a specified token from the tokens register.

Parameters:
i - the index for the token to get
Returns:
the ith token or null if i is out of bounds

length

public int length()
Getter for the length of the token register, this is the number of elements contained.

Returns:
the number of elements in the token register

show

public void show(Context context,
                 Tokens toks)
          throws GeneralException
Determine the printable representation of the object and append it to a list of Tokens.

Parameters:
context - the processor context
toks - the tokens to add to
Throws:
GeneralException - in case of an error

toString

public java.lang.String toString()
Return a String, which shows all tokens in the list.

Returns:
a String, which show all tokens in the list

toText

public java.lang.String toText()
Return a String, which shows all tokens (in text format) in the list.

Returns:
a String, which show all tokens (in text format) in the list

toText

public java.lang.String toText(UnicodeChar esc)
Return a String, which shows all tokens (in text format) in the list.

Parameters:
esc - the escape character to use
Returns:
a String, which show all tokens (in text format) in the list