Class NumericEntityEscaper
java.lang.Object
org.apache.commons.lang3.text.translate.CharSequenceTranslator
org.apache.commons.lang3.text.translate.CodePointTranslator
org.apache.commons.lang3.text.translate.NumericEntityEscaper
Deprecated.
As of 3.6, use Apache Commons Text
NumericEntityEscaper instead
Translates code points to their XML numeric entity escaped value.
- Since:
- 3.0
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate final int
Deprecated.private final int
Deprecated.private final boolean
Deprecated.Fields inherited from class org.apache.commons.lang3.text.translate.CharSequenceTranslator
HEX_DIGITS
-
Constructor Summary
ConstructorsModifierConstructorDescriptionDeprecated.Constructs aNumericEntityEscaper
for all characters.private
NumericEntityEscaper
(int below, int above, boolean between) Deprecated.Constructs aNumericEntityEscaper
for the specified range. -
Method Summary
Modifier and TypeMethodDescriptionstatic NumericEntityEscaper
above
(int codePoint) Deprecated.Constructs aNumericEntityEscaper
above the specified value (exclusive).static NumericEntityEscaper
below
(int codePoint) Deprecated.Constructs aNumericEntityEscaper
below the specified value (exclusive).static NumericEntityEscaper
between
(int codePointLow, int codePointHigh) Deprecated.Constructs aNumericEntityEscaper
between the specified values (inclusive).static NumericEntityEscaper
outsideOf
(int codePointLow, int codePointHigh) Deprecated.Constructs aNumericEntityEscaper
outside of the specified values (exclusive).boolean
Deprecated.Translate the specified code point into another.Methods inherited from class org.apache.commons.lang3.text.translate.CodePointTranslator
translate
Methods inherited from class org.apache.commons.lang3.text.translate.CharSequenceTranslator
hex, translate, translate, with
-
Field Details
-
below
private final int belowDeprecated. -
above
private final int aboveDeprecated. -
between
private final boolean betweenDeprecated.
-
-
Constructor Details
-
NumericEntityEscaper
public NumericEntityEscaper()Deprecated.Constructs aNumericEntityEscaper
for all characters. -
NumericEntityEscaper
private NumericEntityEscaper(int below, int above, boolean between) Deprecated.Constructs aNumericEntityEscaper
for the specified range. This is the underlying method for the other constructors/builders. Thebelow
andabove
boundaries are inclusive whenbetween
istrue
and exclusive when it isfalse
.- Parameters:
below
- int value representing the lowest code point boundaryabove
- int value representing the highest code point boundarybetween
- whether to escape between the boundaries or outside them
-
-
Method Details
-
above
Deprecated.Constructs aNumericEntityEscaper
above the specified value (exclusive).- Parameters:
codePoint
- above which to escape- Returns:
- the newly created
NumericEntityEscaper
instance
-
below
Deprecated.Constructs aNumericEntityEscaper
below the specified value (exclusive).- Parameters:
codePoint
- below which to escape- Returns:
- the newly created
NumericEntityEscaper
instance
-
between
Deprecated.Constructs aNumericEntityEscaper
between the specified values (inclusive).- Parameters:
codePointLow
- above which to escapecodePointHigh
- below which to escape- Returns:
- the newly created
NumericEntityEscaper
instance
-
outsideOf
Deprecated.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
Deprecated.Translate the specified code point into another.- Specified by:
translate
in classCodePointTranslator
- Parameters:
codePoint
- int character input to translateout
- 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
-