org.daisy.pipeline.braille.common

Class HyphenatorWithExceptions

java.lang.Object

org.daisy.pipeline.braille.common.AbstractTransform

org.daisy.pipeline.braille.common.AbstractHyphenator

org.daisy.pipeline.braille.common.HyphenatorWithExceptions

All Implemented Interfaces:

Hyphenator, Transform

public class HyphenatorWithExceptions
extends AbstractHyphenator

Nested Class Summary

Nested classes/interfaces inherited from class org.daisy.pipeline.braille.common.AbstractHyphenator

AbstractHyphenator.util

Nested classes/interfaces inherited from interface org.daisy.pipeline.braille.common.Hyphenator

Hyphenator.FullHyphenator, Hyphenator.LineBreaker, Hyphenator.LineIterator, Hyphenator.NonStandardHyphenationException

Constructor Summary

Constructors

Constructor and Description
HyphenatorWithExceptions(Hyphenator hyphenator, Reader exceptionsFile)

Method Summary

Modifier and Type	Method and Description
Hyphenator.FullHyphenator	asFullHyphenator() Indicate all soft wrap opportunities by inserting soft hyphens and zero width spaces.
Hyphenator.LineBreaker	asLineBreaker() Break the input into lines of a preferred and maximal length.
MoreObjects.ToStringHelper	toStringHelper()

Methods inherited from class org.daisy.pipeline.braille.common.AbstractTransform

finalize, getIdentifier, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.daisy.pipeline.braille.common.Transform

getIdentifier

Constructor Detail

HyphenatorWithExceptions

public HyphenatorWithExceptions(Hyphenator hyphenator,
                                Reader exceptionsFile)
                         throws IOException

Throws:

IOException

Method Detail

asFullHyphenator

public Hyphenator.FullHyphenator asFullHyphenator()

Description copied from interface: Hyphenator

Indicate all soft wrap opportunities by inserting soft hyphens and zero width spaces. Don't add new soft wrap opportunities to words that already have a soft hyphen or zero width space in them. Soft wrap opportunities at white space may also be omitted. Apart from the insertion of these special characters no other transformations are allowed. This means that non-standard hyphenation can not be supported through this interface.

Specified by:

asFullHyphenator in interface Hyphenator

Overrides:

asFullHyphenator in class AbstractHyphenator

asLineBreaker

public Hyphenator.LineBreaker asLineBreaker()
                                     throws UnsupportedOperationException

Description copied from interface: Hyphenator

Break the input into lines of a preferred and maximal length. Transformations such as non-standard hyphenation are allowed. A Hyphenator.LineBreaker is not required to do any special white space processing, but it may. If the Hyphenator.FullHyphenator returned by Hyphenator.asFullHyphenator() throws a Hyphenator.NonStandardHyphenationException, the Hyphenator.asLineBreaker() method must not throw a UnsupportedOperationException.

Specified by:

asLineBreaker in interface Hyphenator

Overrides:

asLineBreaker in class AbstractHyphenator

Throws:

UnsupportedOperationException - if the underlying hyphenator's asLineBreaker() method throws an UnsupportedOperationException

toStringHelper

public MoreObjects.ToStringHelper toStringHelper()

Overrides:

toStringHelper in class AbstractTransform