Class SinglePassTranslator
- java.lang.Object
-
- org.apache.commons.text.translate.CharSequenceTranslator
-
- org.apache.commons.text.translate.SinglePassTranslator
-
- Direct Known Subclasses:
CsvTranslators.CsvEscaper
,CsvTranslators.CsvUnescaper
abstract class SinglePassTranslator extends CharSequenceTranslator
Abstract translator for processing whole input in single pass. Handles initial index checking and counting of returned code points.
-
-
Field Summary
-
Fields inherited from class org.apache.commons.text.translate.CharSequenceTranslator
HEX_DIGITS
-
-
Constructor Summary
Constructors Constructor Description SinglePassTranslator()
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description private java.lang.String
getClassName()
A utility method to be used in thetranslate(CharSequence, int, Writer)
method.int
translate(java.lang.CharSequence input, int index, java.io.Writer out)
Translate a set of codepoints, represented by an int index into a CharSequence, into another set of codepoints.(package private) abstract void
translateWhole(java.lang.CharSequence input, java.io.Writer out)
Translate whole set of code points passed in input.-
Methods inherited from class org.apache.commons.text.translate.CharSequenceTranslator
hex, translate, translate, with
-
-
-
-
Method Detail
-
translate
public int translate(java.lang.CharSequence input, int index, java.io.Writer out) throws java.io.IOException
Description copied from class:CharSequenceTranslator
Translate a set of codepoints, represented by an int index into a CharSequence, into another set of codepoints. The number of codepoints 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 translationout
- Writer to translate the text to- Returns:
- int count of codepoints consumed
- Throws:
java.io.IOException
- if and only if the Writer produces an IOException
-
getClassName
private java.lang.String getClassName()
A utility method to be used in thetranslate(CharSequence, int, Writer)
method.- Returns:
- The name of this or the extending class.
-
translateWhole
abstract void translateWhole(java.lang.CharSequence input, java.io.Writer out) throws java.io.IOException
Translate whole set of code points passed in input.- Parameters:
input
- CharSequence that is being translatedout
- Writer to translate the text to- Throws:
java.io.IOException
- if and only if the Writer produces an IOException
-
-