de.dante.extex.interpreter.primitives.register.bool
Class NamedBool

java.lang.Object
  extended byde.dante.extex.interpreter.type.AbstractCode
      extended byde.dante.extex.interpreter.type.AbstractAssignment
          extended byde.dante.extex.interpreter.primitives.register.bool.NamedBool
All Implemented Interfaces:
BoolConvertible, Code, Localizable, java.io.Serializable, Theable
Direct Known Subclasses:
NumberedBool

public class NamedBool
extends AbstractAssignment
implements Theable, BoolConvertible

This class provides an implementation for the bool valued primitives. It sets the named bool register to the value given, and as a side effect all prefixes are zeroed.

Example

 \debug=true
 \debug=false
 \debug=on
 \debug=off
 \debug=0
 \debug=7
 

Version:
$Revision: 1.16 $
Author:
Michael Niedermair
See Also:
Serialized Form

Field Summary
 
Fields inherited from class de.dante.extex.interpreter.type.AbstractCode
serialVersionUID
 
Constructor Summary
NamedBool(java.lang.String name)
          Creates a new object.
 
Method Summary
 void assign(Flags prefix, Context context, TokenSource source, Typesetter typesetter)
          The method assign is the core of the functionality of execute().
 Bool convertBool(Context context, TokenSource source)
          Convert to a bool.
protected  java.lang.String getKey(Context context, TokenSource source)
          Return the key (the name of the primitive) for the register.
 void set(Context context, Bool value)
          set the value
 void set(Context context, java.lang.String value)
          Set the value
 Tokens the(Context context, TokenSource source, Typesetter typesetter)
          This method is the getter for the description of the primitive.
 
Methods inherited from class de.dante.extex.interpreter.type.AbstractAssignment
execute
 
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
 

Constructor Detail

NamedBool

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

Parameters:
name - the name for debugging
Method Detail

assign

public void assign(Flags prefix,
                   Context context,
                   TokenSource source,
                   Typesetter typesetter)
            throws InterpreterException
Description copied from class: AbstractAssignment
The method assign is the core of the functionality of execute(). This method is preferable to execute() since the execute() method provided in this class takes care of \afterassignment and \globaldefs as well.

Specified by:
assign in class AbstractAssignment
Parameters:
prefix - the prefix controlling the execution
context - the interpreter context
source - the token source
typesetter - the typesetter
Throws:
InterpreterException - in case of an error
See Also:
AbstractAssignment.assign( de.dante.extex.interpreter.Flags, de.dante.extex.interpreter.context.Context, de.dante.extex.interpreter.TokenSource, de.dante.extex.typesetter.Typesetter)

set

public void set(Context context,
                Bool value)
         throws InterpreterException
set the value

Parameters:
context - the interpreter context
value - the new value
Throws:
InterpreterException - if the extension is not configured

set

public void set(Context context,
                java.lang.String value)
         throws InterpreterException
Set the value

Parameters:
context - the interpreter context
value - the new value as String
Throws:
InterpreterException - if the extension is not configured

the

public Tokens the(Context context,
                  TokenSource source,
                  Typesetter typesetter)
           throws InterpreterException
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:
InterpreterException - in case of an error
See Also:
Theable.the( de.dante.extex.interpreter.context.Context, de.dante.extex.interpreter.TokenSource, Typesetter)

getKey

protected java.lang.String getKey(Context context,
                                  TokenSource source)
                           throws InterpreterException
Return the key (the name of the primitive) for the register.

Parameters:
context - the context
source - the tokensource
Returns:
the key
Throws:
InterpreterException - in case of an error

convertBool

public Bool convertBool(Context context,
                        TokenSource source)
                 throws InterpreterException
Description copied from interface: BoolConvertible
Convert to a bool.

Specified by:
convertBool in interface BoolConvertible
Parameters:
context - the interpreter context
source - the source for new tokens
Returns:
the converted value
Throws:
InterpreterException - in case of an error
See Also:
BoolConvertible.convertBool( de.dante.extex.interpreter.context.Context, de.dante.extex.interpreter.TokenSource)