com.lowagie.text.pdf.hyphenation.PatternConsumer Maven / Gradle / Ivy
/*
* $Id: PatternConsumer.java,v 1.29 2004/12/27 07:10:04 blowagie Exp $
* Copyright (C) 2001 The Apache Software Foundation. All rights reserved.
* For license details please refer to http://xml.apache.org/fop
*/
package com.lowagie.text.pdf.hyphenation;
import java.util.ArrayList;
/**
* This interface is used to connect the XML pattern file parser to
* the hyphenation tree.
*
* @author Carlos Villegas
*/
public interface PatternConsumer {
/**
* 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.
*/
public void addClass(String chargroup);
/**
* 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
* {@link Hyphen Hyphen} instances
*/
public void addException(String word, ArrayList hyphenatedword);
/**
* Add hyphenation patterns.
* @param pattern
* @param values interletter values expressed as a string of
* digit characters.
*/
public void addPattern(String pattern, String values);
}