org.axsl.hyphen

Interface MutatingHyphenationBreak

public interface MutatingHyphenationBreak

Specialized information about a specific hyphenation break opportunity in a word. This handles "hard" hyphenation cases, such as those where the word changes spelling when it is hyphenated. For example, the German "backen" hyphenates to "bak-ken". Most hyphenation break opportunities do not require a HyphenBreak because such spelling changes to not occur.

Method Summary

Modifier and Type	Method and Description
java.lang.CharSequence	postDelete() Assuming that a hyphen is placed at this point, provides the text immediately after that hyphen that should be removed.
java.lang.CharSequence	postInsert() Assuming that a hyphen is placed at this point, provides the text that should be inserted immediately after that hyphen.
java.lang.CharSequence	preDelete() Assuming that a hyphen is placed at this point, provides the text immediately before that hyphen that should be removed.
java.lang.CharSequence	preInsert() Assuming that a hyphen is placed at this point, provides the text that should be inserted immediately before that hyphen.

Method Detail

preDelete

java.lang.CharSequence preDelete()

Assuming that a hyphen is placed at this point, provides the text immediately before that hyphen that should be removed. Note that this deletion should occur chronologically before the text returned by preInsert() is inserted.

Returns:

The text that should be deleted before the hyphen, or an empty String if none should be deleted. For the example cited in the class documentation, the German "backen" hyphenating to "bak-ken", the pre-delete return value is "c".

preInsert

java.lang.CharSequence preInsert()

Assuming that a hyphen is placed at this point, provides the text that should be inserted immediately before that hyphen. Note that this insertion should occur chronologically after the text returned by preDelete() is deleted.

Returns:

The text that should be inserted before the hyphen, or an empty String if none should be inserted. For the example cited in the class documentation, the German "backen" hyphenating to "bak-ken", the pre-insert return value is "k".

postDelete

java.lang.CharSequence postDelete()

Assuming that a hyphen is placed at this point, provides the text immediately after that hyphen that should be removed. Note that this deletion should occur chronologically before the text returned by postInsert() is inserted.

Returns:

The text that should be deleted after the hyphen, or an empty String if none should be deleted. For the example cited in the class documentation, the German "backen" hyphenating to "bak-ken", the post-delete return value is an empty String.

postInsert

java.lang.CharSequence postInsert()

Assuming that a hyphen is placed at this point, provides the text that should be inserted immediately after that hyphen. Note that this insertion should occur chronologically after the text returned by postDelete() is deleted.

Returns:

The text that should be inserted after the hyphen, or an empty String if none should be inserted. For the example cited in the class documentation, the German "backen" hyphenating to "bak-ken", the post-insert return value is an empty String.