Package org.daisy.dotify.api.hyphenator
Interface HyphenatorInterface
-
- All Known Implementing Classes:
AbstractHyphenator
,DummyHyphenator
public interface HyphenatorInterface
Provides a hyphenator. The hyphenator hyphenates text using rules specific to the language that the hyphenator supports.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description int
getBeginLimit()
Gets the begin limit.int
getEndLimit()
Gets the end limit.String
hyphenate(String phrase)
Hyphenates the phrase, inserting soft hyphens at all possible breakpoints.void
setBeginLimit(int beginLimit)
Sets the begin limit.void
setEndLimit(int endLimit)
Sets the end limit.
-
-
-
Method Detail
-
hyphenate
String hyphenate(String phrase)
Hyphenates the phrase, inserting soft hyphens at all possible breakpoints.- Parameters:
phrase
- the phrase to hyphenate- Returns:
- the hyphenated string
-
getBeginLimit
int getBeginLimit()
Gets the begin limit. In other words, the number of unbreakable characters at the beginning of each word.- Returns:
- returns the begin limit
-
setBeginLimit
void setBeginLimit(int beginLimit)
Sets the begin limit. In other words, the number of unbreakable characters at the beginning of each word.- Parameters:
beginLimit
- the begin limit
-
getEndLimit
int getEndLimit()
Gets the end limit. In other words, the number of unbreakable characters at the end of each word.- Returns:
- returns the end limit
-
setEndLimit
void setEndLimit(int endLimit)
Sets the end limit. In other words, the number of unbreakable characters at the end of each word.- Parameters:
endLimit
- the end limit
-
-