Class NumericEntityEscaper
- java.lang.Object
-
- org.apache.commons.text.translate.CharSequenceTranslator
-
- org.apache.commons.text.translate.CodePointTranslator
-
- org.apache.commons.text.translate.NumericEntityEscaper
-
public class NumericEntityEscaper extends CodePointTranslator
Translates code points to their XML numeric entity escaped value.- Since:
- 1.0
-
-
Constructor Summary
Constructors Constructor Description NumericEntityEscaper()
Constructs aNumericEntityEscaper
for all characters.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static NumericEntityEscaper
above(int codePoint)
Constructs aNumericEntityEscaper
above the specified value (exclusive).static NumericEntityEscaper
below(int codePoint)
Constructs aNumericEntityEscaper
below the specified value (exclusive).static NumericEntityEscaper
between(int codePointLow, int codePointHigh)
Constructs aNumericEntityEscaper
between the specified values (inclusive).static NumericEntityEscaper
outsideOf(int codePointLow, int codePointHigh)
Constructs aNumericEntityEscaper
outside of the specified values (exclusive).boolean
translate(int codePoint, java.io.Writer writer)
Translates the specified code point into another.-
Methods inherited from class org.apache.commons.text.translate.CodePointTranslator
translate
-
Methods inherited from class org.apache.commons.text.translate.CharSequenceTranslator
hex, translate, translate, with
-
-
-
-
Method Detail
-
above
public static NumericEntityEscaper above(int codePoint)
Constructs aNumericEntityEscaper
above the specified value (exclusive).- Parameters:
codePoint
- above which to escape- Returns:
- The newly created
NumericEntityEscaper
instance
-
below
public static NumericEntityEscaper below(int codePoint)
Constructs aNumericEntityEscaper
below the specified value (exclusive).- Parameters:
codePoint
- below which to escape- Returns:
- The newly created
NumericEntityEscaper
instance
-
between
public static NumericEntityEscaper between(int codePointLow, int codePointHigh)
Constructs aNumericEntityEscaper
between the specified values (inclusive).- Parameters:
codePointLow
- above which to escapecodePointHigh
- below which to escape- Returns:
- The newly created
NumericEntityEscaper
instance
-
outsideOf
public static NumericEntityEscaper outsideOf(int codePointLow, int codePointHigh)
Constructs aNumericEntityEscaper
outside of the specified values (exclusive).- Parameters:
codePointLow
- below which to escapecodePointHigh
- above which to escape- Returns:
- The newly created
NumericEntityEscaper
instance
-
translate
public boolean translate(int codePoint, java.io.Writer writer) throws java.io.IOException
Translates the specified code point into another.- Specified by:
translate
in classCodePointTranslator
- 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
-
-