Class CodePointTranslator
java.lang.Object
org.apache.commons.text.translate.CharSequenceTranslator
org.apache.commons.text.translate.CodePointTranslator
- Direct Known Subclasses:
NumericEntityEscaper
,UnicodeEscaper
,UnicodeUnpairedSurrogateRemover
Helper subclass to CharSequenceTranslator to allow for translations that
will replace up to one character at a time.
- Since:
- 1.0
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionabstract boolean
Translates the specified code point into another.final int
translate
(CharSequence input, int index, Writer writer) Translate a set of code points, represented by an int index into a CharSequence, into another set of code points.Methods inherited from class org.apache.commons.text.translate.CharSequenceTranslator
hex, translate, translate, with
-
Constructor Details
-
CodePointTranslator
public CodePointTranslator()
-
-
Method Details
-
translate
Description copied from class:CharSequenceTranslator
Translate a set of code points, represented by an int index into a CharSequence, into another set of code points. The number of code points consumed must be returned, and the only IOExceptions thrown must be from interacting with the Writer so that the top level API may reliably ignore StringWriter IOExceptions.- Specified by:
translate
in classCharSequenceTranslator
- Parameters:
input
- CharSequence that is being translatedindex
- int representing the current point of translationwriter
- Writer to translate the text to- Returns:
- int count of code points consumed
- Throws:
IOException
- if and only if the Writer produces an IOException
-
translate
Translates the specified code point into another.- Parameters:
codePoint
- int character input to translatewriter
- Writer to optionally push the translated output to- Returns:
- boolean as to whether translation occurred or not
- Throws:
IOException
- if and only if the Writer produces an IOException
-