Class CodePointTranslator
- java.lang.Object
-
- org.apache.commons.text.translate.CharSequenceTranslator
-
- org.apache.commons.text.translate.CodePointTranslator
-
- Direct Known Subclasses:
NumericEntityEscaper
,UnicodeEscaper
,UnicodeUnpairedSurrogateRemover
public abstract class CodePointTranslator extends CharSequenceTranslator
Helper subclass to CharSequenceTranslator to allow for translations that will replace up to one character at a time.- Since:
- 1.0
-
-
Constructor Summary
Constructors Constructor Description CodePointTranslator()
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description abstract boolean
translate(int codePoint, java.io.Writer writer)
Translates the specified code point into another.int
translate(java.lang.CharSequence input, int index, java.io.Writer writer)
Implementation of translate that maps onto the abstract translate(int, Writer) method.-
Methods inherited from class org.apache.commons.text.translate.CharSequenceTranslator
hex, translate, translate, with
-
-
-
-
Method Detail
-
translate
public final int translate(java.lang.CharSequence input, int index, java.io.Writer writer) throws java.io.IOException
Implementation of translate that maps onto the abstract translate(int, Writer) method. 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:
java.io.IOException
- if and only if the Writer produces an IOException
-
translate
public abstract boolean translate(int codePoint, java.io.Writer writer) throws java.io.IOException
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:
java.io.IOException
- if and only if the Writer produces an IOException
-
-