org.extex.unit.tex.hyphen
Class Patterns

java.lang.Object
  extended by org.extex.interpreter.type.AbstractCode
      extended by org.extex.unit.tex.hyphen.AbstractHyphenationCode
          extended by org.extex.unit.tex.hyphen.Patterns
All Implemented Interfaces:
java.io.Serializable, Code

public class Patterns
extends AbstractHyphenationCode

This class provides an implementation for the primitive \patterns.

The Primitive \patterns

The primitive \patterns adds values to the set of patterns of the hyphenation algorithm.

TODO missing documentation

Syntax

The formal description of this primitive is the following:
    ⟨patterns⟩
      → \patterns { ⟨patterns⟩ } 

Examples

    \patterns{.ach4 .ad4der .af1t}  

Version:
$Revision: 4770 $
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
Patterns(CodeToken token)
          Creates a new object.
 
Method Summary
 void execute(Flags prefix, Context context, TokenSource source, Typesetter typesetter)
          Scan the patterns for hyphenation and store this values in the HyphernationTable.
 
Methods inherited from class org.extex.unit.tex.hyphen.AbstractHyphenationCode
getHyphenationTable
 
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

Patterns

public Patterns(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,
                    EofException,
                    MissingLeftBraceException,
                    NoHelpException
Scan the patterns for hyphenation and store this values in the HyphernationTable. The HyphernationTable are based on the value from \language. 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
EofException
MissingLeftBraceException
NoHelpException
See Also:
AbstractCode.execute( org.extex.interpreter.Flags, org.extex.interpreter.context.Context, org.extex.interpreter.TokenSource, org.extex.typesetter.Typesetter)