org.extex.unit.etex.prefix
Class Protected

java.lang.Object
  org.extex.interpreter.type.AbstractCode
      org.extex.unit.etex.prefix.Protected

All Implemented Interfaces:

java.io.Serializable, Code, PrefixCode

public class Protected
extends AbstractCode
implements PrefixCode

This class provides an implementation for the primitive \protected. It does simply nothing, but as a side effect the prefix PROTECTED is added to the prefixes.

The Prefix Primitive \protected

The primitive \protected is a prefix modifying the operation of a following primitive. If the immediately following token denotes another prefix primitives then the functionality is accumulated. This means that the next non-prefix primitive is modified by any directly preceding prefix primitives.

Multiple \protected prefixes act identical to a single one.

Syntax

The formal description of this primitive is the following:

    ⟨protected⟩
      → \protected  

Examples

    \protected\def\abc{123}  

Version:

$Revision:4431 $

Author:

Gerd Neugebauer

See Also:

Serialized Form

Field Summary

protected static long

serialVersionUID The constant serialVersionUID contains the id for serialization.

Constructor Summary

Protected(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.

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

Protected

public Protected(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)

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

See Also:

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