Package org.daisy.dotify.api.translator
Interface FollowingText
-
- All Known Subinterfaces:
ResolvableText
public interface FollowingText
Provides information about an item that comes after the items being translated.- See Also:
ResolvableText
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description Optional<String>
getLocale()
Gets the locale for the text, if specified.boolean
isStatic()
Returns true if this item does not change.String
peek()
Peeks the value of this item.boolean
shouldHyphenate()
Returns true if the text should be hyphenated.boolean
shouldMarkCapitalLetters()
Returns true if the text should mark capital letters.
-
-
-
Method Detail
-
peek
String peek()
Peeks the value of this item. The returned string may be different from call to call.- Returns:
- the value, never null
-
isStatic
boolean isStatic()
Returns true if this item does not change.- Returns:
- true if this item is static, false otherwise
-
getLocale
Optional<String> getLocale()
Gets the locale for the text, if specified.
Note that this method returns the language that the text is written in. It does not imply association with a particular translator or braille code.
- Returns:
- an optional containing the locale, never null
-
shouldHyphenate
boolean shouldHyphenate()
Returns true if the text should be hyphenated.- Returns:
- true if the text should be hyphenated, false otherwise
-
shouldMarkCapitalLetters
boolean shouldMarkCapitalLetters()
Returns true if the text should mark capital letters.- Returns:
- true if the capital letters should be marked, false otherwise
-
-