org.extex.scanner.type.tokens
Interface FixedTokens

All Known Implementing Classes:

ImmutableTokens, MacroPattern, Tokens

public interface FixedTokens

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

Version:

$Revision: 4726 $

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.
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

Token get(int i)

Get a specified token from the tokens register.

Parameters:

i - the index for the token to get

Returns:

the i^th token or null if i is out of bounds

length

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

toString

java.lang.String toString()

Return a String, which shows all tokens in the list.

Overrides:

toString in class java.lang.Object

Returns:

a String, which show all tokens in the list

toText

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

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