org.extex.unit.tex.file
Class Dump

java.lang.Object
  org.extex.interpreter.type.AbstractCode
      org.extex.unit.tex.file.Dump

All Implemented Interfaces:

java.io.Serializable, OutputStreamConsumer, LogEnabled, Code

public class Dump
extends AbstractCode
implements LogEnabled, OutputStreamConsumer

This class provides an implementation for the primitive \dump.

The Primitive \dump

The primitive writes out the current state of the interpreter to an format file. This format file can be read back in to restore the saved state.

The primitive can be used outside of any group only.

The name of the format file is derived from the job name. The extension .fmt is attached to the job name.

Syntax

The formal description of this primitive is the following:

    ⟨dump⟩
       → \dump  

Examples

    \dump  

Version:

$Revision: 4441 $

Author:

Gerd Neugebauer

See Also:

Serialized Form

Field Summary

protected static long

serialVersionUID The constant serialVersionUID contains the id for serialization.

Constructor Summary

Dump(CodeToken token)
Creates a new object.

Method Summary

void	enableLogging(java.util.logging.Logger log) Setter for the logger.
void	execute(Flags prefix, Context context, TokenSource source, Typesetter typesetter) 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.
void	setOutputStreamFactory(OutputStreamFactory factory) This method takes an output stream factory for further use.

Methods inherited from class org.extex.interpreter.type.AbstractCode

getLocalizer, getName, getToken, isIf, isOuter, readResolve, toString, toText, toText

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

serialVersionUID

protected static final long serialVersionUID

The constant serialVersionUID contains the id for serialization.

See Also:

Constant Field Values

Constructor Detail

Dump

public Dump(CodeToken token)

Creates a new object.

Parameters:

token - the initial token for the primitive

Method Detail

enableLogging

public void enableLogging(java.util.logging.Logger log)

Setter for the logger.

Specified by:

enableLogging in interface LogEnabled

Parameters:

log - the logger to use

See Also:

LogEnabled.enableLogging( java.util.logging.Logger)

execute

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

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

Parameters:

prefix - the prefix controlling the execution

context - the interpreter context

source - the token source

typesetter - the typesetter

Throws:

HelpingException - in case of an error

TypesetterException - in case of an error in the typesetter

See Also:

AbstractCode.execute( org.extex.interpreter.Flags, org.extex.interpreter.context.Context, org.extex.interpreter.TokenSource, org.extex.typesetter.Typesetter)

setOutputStreamFactory

public void setOutputStreamFactory(OutputStreamFactory factory)

This method takes an output stream factory for further use.

Specified by:

setOutputStreamFactory in interface OutputStreamConsumer

Parameters:

factory - the output stream factory to use

See Also:

OutputStreamConsumer.setOutputStreamFactory( org.extex.backend.outputStream.OutputStreamFactory)