Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

de.dante.extex.interpreter.primitives.info
Class Errmessage

java.lang.Object
  extended byde.dante.extex.interpreter.type.AbstractCode
      extended byde.dante.extex.interpreter.primitives.info.Errmessage
All Implemented Interfaces:
Code, Localizable, java.io.Serializable
public class Errmessage
extends AbstractCode

This class provides an implementation for the primitive \errmessage.

The Primitive \errmessage

The primitive \errmessage takes one argument. This argument is an expanded list of tokens. Those tokens are presented as error message. The help text is taken from the token register \errhelp

Syntax

The formal description of this primitive is the following: 
    ⟨errmessage⟩
       → \errmessage ⟨tokens⟩

Examples

    \errhelp={Too bad}
    \errmessage{I found an error}

The Token Register \errhelp

The token register \errhelp contains the help text for the primitive \errmessage. Nevertheless this register can be used in any place where a token register is needed.

Syntax

The formal description of this primitive is the following: 
    ⟨errhelp⟩
      → \errhelp ⟨equals⟩ ⟨tokens⟩

Examples

    \errhelp={Too bad}
    \errmessage{I found an error}

Version:
$Revision: 1.22 $
Author:
Gerd Neugebauer, Michael Niedermair
See Also:
Serialized Form

Field Summary
protected static long serialVersionUID
          The constant serialVersionUID contains the id for serialization.
 
Constructor Summary
Errmessage(java.lang.String name)
          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.
 
Methods inherited from class de.dante.extex.interpreter.type.AbstractCode
enableLocalization, getLocalizer, getName, isIf, isOuter, printable, printableControlSequence, readResolve, setName, toString
 
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

Errmessage

public Errmessage(java.lang.String name)
Creates a new object.

Parameters:
name - the name for tracing and debugging
Method Detail

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)
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD