org.extex.unit.tex.file
Class Closeout

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

All Implemented Interfaces:

java.io.Serializable, Code

public class Closeout
extends AbstractCode

This class provides an implementation for the primitive \closeout.

The Primitive \closeout

The primitive takes one expanded integer argument. This argument denotes a write register which will be closed if it is currently assigned to a file – with \openout. If the input file assigned to the given number has not been opened or has been closed before then this primitive simply does nothing.

Syntax

The formal description of this primitive is the following:

    ⟨closeout⟩
       → \closeout ⟨outfile name⟩ 

Examples

    \closeout5  

    \closeout\count120  

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

Closeout(CodeToken token)
Creates a new object.

Method Summary

void	enableLogging(java.util.logging.Logger theLogger) 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.

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

Closeout

public Closeout(CodeToken token)

Creates a new object.

Parameters:

token - the initial token for the primitive

Method Detail

enableLogging

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

Setter for the logger.

Parameters:

theLogger - the new logger

See Also:

org.extex.framework.logger.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)