au.id.pbw.hyfo.hyph
Class HyphenInhibitor

java.lang.Object
  au.id.pbw.hyfo.hyph.HyphenBreak
      au.id.pbw.hyfo.hyph.HyphenInhibitor

All Implemented Interfaces:

Serializable

public class HyphenInhibitor
extends HyphenBreak
implements Serializable

Represents an inhibiting value for a hyphenation break point. In the Liang/TeX algorithm, such points have even weights in the range 0 .. 8.

Author:

Peter B. West

See Also:

Serialized Form

Field Summary

Fields inherited from class au.id.pbw.hyfo.hyph.HyphenBreak

check_nobreak_text, DEFAULT_WEIGHT, NEUTRAL_WEIGHT, nobreak, post_brkpt, pre_brkpt, replace_post_brkpt, replace_pre_brkpt, weight

Constructor Summary

HyphenInhibitor(Byte weight, Alphabet alphabet)
Creates a new instance of HyphenInhibitor

Method Summary

Methods inherited from class au.id.pbw.hyfo.hyph.HyphenBreak

get_weight, make_key, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

HyphenInhibitor

public HyphenInhibitor(Byte weight,
                       Alphabet alphabet)
                throws HyphenationException

Creates a new instance of HyphenInhibitor

Parameters:

weight - the relative strength of hyphen inhibition. Values are small positive even numbers.

alphabet - the Alphabet this object is defined with respect to.

Throws:

HyphenationException - if the weight is invalid for inhibition.