de.dante.extex.interpreter.primitives.file
Class End

java.lang.Object
  de.dante.extex.interpreter.type.AbstractCode
      de.dante.extex.interpreter.primitives.file.End

All Implemented Interfaces:

Code, Localizable, java.io.Serializable

public class End

extends AbstractCode

This class provides an implementation for the primitive \end.

The Primitive \end

The primitive \end closes all input stream and discards all tokens which might be waiting to be read. This usually mean the end of the processing of one document.

Syntax

    ⟨end⟩
       → \end  

Examples

    \end  

Version:

$Revision: 1.20 $

Author:

Gerd Neugebauer

See Also:

Serialized Form

serialVersionUID

protected static final long serialVersionUID

The constant serialVersionUID contains the id for serialization.

See Also:

Constant Field Values

End

public End(java.lang.String name)

Creates a new object.

Parameters:

name - the name for debugging

execute

public void execute(Flags prefix,
                    Context context,
                    TokenSource source,
                    Typesetter typesetter)
             throws InterpreterException

Description copied from interface: Code

This method takes the first token and executes it. The result is placed on the stack. This operation might have side effects. To execute a token it might be necessary to consume further tokens.

Specified by:

execute in interface Code

Overrides:

execute in class AbstractCode

Throws:

InterpreterException

See Also:

Code.execute( de.dante.extex.interpreter.Flags, de.dante.extex.interpreter.context.Context, de.dante.extex.interpreter.TokenSource, de.dante.extex.typesetter.Typesetter)