PatternConsumer (Apache FOP Core 2.11 API)
Date: 2025-04-24

org.apache.fop.hyphenation

## Interface PatternConsumer

- All Known Implementing Classes:
    HyphenationTree, PatternParser

      public interface PatternConsumer

  This interface is used to connect the XML pattern file parser to the hyphenation tree.

  This work was authored by Carlos Villegas (cav@uniscope.co.jp).

- - ### Method Summary

    All Methods Instance Methods Abstract Methods
    Modifier and Type | Method and Description
    --- | ---
    `void` | `addClass(String chargroup)` Add a character class.
    `void` | `addException(String word, ArrayList hyphenatedword)` Add a hyphenation exception.
    `void` | `addPattern(String pattern, String values)` Add hyphenation patterns.

- - ### Method Detail

    - #### addClass

          void addClass(String chargroup)

      Add a character class. A character class defines characters that are considered equivalent for the purpose of hyphenation (e.g. "aA"). It usually means to ignore case.
      Parameters:
        `chargroup` - character group

    - #### addException

          void addException(String word,
                            ArrayList hyphenatedword)

      Add a hyphenation exception. An exception replaces the result obtained by the algorithm for cases for which this fails or the user wants to provide his own hyphenation. A hyphenatedword is a vector of alternating String's and `Hyphen` instances
      Parameters:
        `word` - word to add as an exception
        `hyphenatedword` - pre-hyphenated word

    - #### addPattern

          void addPattern(String pattern,
                          String values)

      Add hyphenation patterns.
      Parameters:
        `pattern` - the pattern
        `values` - interletter values expressed as a string of digit characters.

Copyright © 2025 Apache Software Foundation. All rights reserved.