de.dante.extex.interpreter.context
Interface ContextCount

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

public interface ContextCount

This interface describes the container for count registers of an interpreter context.

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

Method Summary
 Count getCount(java.lang.String name)
          Getter for the count register.
 void setCount(java.lang.String name, long value, boolean global)
          Setter for the count register in all requested groups.
 

Method Detail

getCount

public Count getCount(java.lang.String name)
Getter for the count register. Count registers are named, either with a number or an arbitrary string.

The numbered registers where limited to 256 in TeX. This restriction does not longer hold for ExTeX.

The return value is guaranteed to be a valid object. null will never be returned.

Parameters:
name - the name or number of the count register
Returns:
the count register or null if it is not defined
See Also:
setCount(String, long, boolean)

setCount

public void setCount(java.lang.String name,
                     long value,
                     boolean global)
              throws InterpreterException
Setter for the count register in all requested groups. Count 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
value - 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 if an exception in a registered observer
See Also:
getCount(String)