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 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 -
Method Summary
Modifier and TypeMethodDescriptionprivate String
A utility method to be used in thetranslate(CharSequence, int, Writer)
method.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.(package private) abstract void
translateWhole
(CharSequence input, Writer writer) Translates whole set of code points passed in input.Methods inherited from class org.apache.commons.text.translate.CharSequenceTranslator
hex, translate, translate, with
-
Constructor Details
-
SinglePassTranslator
SinglePassTranslator()
-
-
Method Details
-
getClassName
A utility method to be used in thetranslate(CharSequence, int, Writer)
method.- Returns:
- The name of this or the extending class.
-
translate
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:
IllegalArgumentException
- ifindex != 0
IOException
- if and only if the Writer produces an IOException
-
translateWhole
Translates whole set of code points passed in input.- Parameters:
input
- CharSequence that is being translatedwriter
- Writer to translate the text to- Throws:
IOException
- if and only if the Writer produces an IOException
-