de.dante.extex.interpreter.context
Interface ContextTokens

All Known Subinterfaces:
Context, ContextInternals
All Known Implementing Classes:
ContextExtensionImpl, ContextImpl

public interface ContextTokens

This interface describes the container for all data of an interpreter context.

Version:
$Revision: 1.5 $
Author:
Gerd Neugebauer, Michael Niedermair

Method Summary
 Tokens getToks(java.lang.String name)
          Getter for the Tokens register.
 Tokens getToksOrNull(java.lang.String name)
          Getter for the toks register.
 void setToks(java.lang.String name, Tokens toks, boolean global)
          Setter for the Tokens register in the specified groups.
 

Method Detail

getToks

public Tokens getToks(java.lang.String name)
Getter for the Tokens register. Tokens registers are named, either with a number or an arbitrary string. The numbered registers where limited to 256 in TeX. This restriction does no longer hold for ExTeX.

Parameters:
name - the name or number of the token register
Returns:
the token register or a new one if it is not defined yet
See Also:
getToksOrNull(String), setToks(String, Tokens, boolean)

getToksOrNull

public Tokens getToksOrNull(java.lang.String name)
Getter for the toks register. Tokens registers are named, either with a number or an arbitrary string. The numbered registers where limited to 256 in TeX. This restriction does no longer hold for ExTeX.

Parameters:
name - the name or number of the token register
Returns:
the token register or null if it is not defined
See Also:
getToks(String), setToks(String, Tokens, boolean)

setToks

public void setToks(java.lang.String name,
                    Tokens toks,
                    boolean global)
             throws InterpreterException
Setter for the Tokens register in the specified groups. Tokens registers are named, either with a number or an arbitrary string. The numbered registers where limited to 256 in TeX. This restriction does no longer hold for ExTeX.

Parameters:
name - the name or the number of the register
toks - the new value of the register
global - the indicator for the scope; true means all groups; otherwise the current group is affected only
Throws:
InterpreterException - in case of a problem in an observer
See Also:
getToks(String), getToksOrNull(String)