org.extex.interpreter.primitives.format
Class PrintFormat

java.lang.Object
  org.extex.interpreter.type.AbstractCode
      org.extex.interpreter.primitives.format.PrintFormat

All Implemented Interfaces:

java.io.Serializable, Code, Theable

public class PrintFormat
extends AbstractCode
implements Theable

This class provides an implementation for the primitive \printformat. It format the next primitive for the output with the given pattern and the default Locale.

Example:

 \the\printformat{pattern}\real7
 

 \the\printformat{pattern}\count7
 

 \the\printformat{pattern}\pair7
 

Version:

$Revision: 6447 $

Author:

Michael Niedermair

See Also:

DecimalFormat, Serialized Form

Constructor Summary

PrintFormat(CodeToken token)
Creates a new object.

Method Summary

void	execute(Flags prefix, Context context, TokenSource source, Typesetter typesetter) This method takes the first token and executes it.
Tokens	the(Context context, TokenSource source, Typesetter typesetter) This method is the getter for the description of the primitive.

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

Constructor Detail

PrintFormat

public PrintFormat(CodeToken token)

Creates a new object.

Parameters:

token - the initial token for the primitive

Method Detail

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)

the

public Tokens the(Context context,
                  TokenSource source,
                  Typesetter typesetter)
           throws ConfigurationException,
                  HelpingException,
                  TypesetterException

Description copied from interface: Theable

This method is the getter for the description of the primitive.

Specified by:

the in interface Theable

Parameters:

context - the interpreter context

source - the source for further tokens to qualify the request

typesetter - the typesetter to use

Returns:

the description of the primitive as list of Tokens

Throws:

ConfigurationException - in case of an configuration error

HelpingException - in case of an error

TypesetterException - in case of an error

See Also:

Theable.the( org.extex.interpreter.context.Context, org.extex.interpreter.TokenSource, Typesetter)