Class NumericEntityEscaper
java.lang.Object
org.apache.commons.text.translate.CharSequenceTranslator
org.apache.commons.text.translate.CodePointTranslator
org.apache.commons.text.translate.NumericEntityEscaper
Translates codepoints to their XML numeric entity escaped value.
- Since:
- 1.0
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate final boolean
whether to escape between the boundaries or outside them.private final org.apache.commons.lang3.Range<Integer>
range from lowest codepoint to highest codepoint.Fields inherited from class org.apache.commons.text.translate.CharSequenceTranslator
HEX_DIGITS
-
Constructor Summary
ConstructorsModifierConstructorDescriptionConstructs aNumericEntityEscaper
for all characters.private
NumericEntityEscaper
(int below, int above, boolean between) Constructs aNumericEntityEscaper
for the specified range. -
Method Summary
Modifier and TypeMethodDescriptionstatic 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 the specified codepoint 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
-
Field Details
-
between
private final boolean betweenwhether to escape between the boundaries or outside them. -
range
range from lowest codepoint to highest codepoint.
-
-
Constructor Details
-
NumericEntityEscaper
private NumericEntityEscaper(int below, int above, boolean between) Constructs a
NumericEntityEscaper
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 codepoint boundaryabove
- int value representing the highest codepoint boundarybetween
- whether to escape between the boundaries or outside them
-
NumericEntityEscaper
public NumericEntityEscaper()Constructs a
NumericEntityEscaper
for all characters.
-
-
Method Details
-
below
Constructs a
NumericEntityEscaper
below the specified value (exclusive).- Parameters:
codepoint
- below which to escape- Returns:
- The newly created
NumericEntityEscaper
instance
-
above
Constructs a
NumericEntityEscaper
above the specified value (exclusive).- Parameters:
codepoint
- above which to escape- Returns:
- The newly created
NumericEntityEscaper
instance
-
between
Constructs a
NumericEntityEscaper
between the specified values (inclusive).- Parameters:
codepointLow
- above which to escapecodepointHigh
- below which to escape- Returns:
- The newly created
NumericEntityEscaper
instance
-
outsideOf
Constructs a
NumericEntityEscaper
outside of the specified values (exclusive).- Parameters:
codepointLow
- below which to escapecodepointHigh
- above which to escape- Returns:
- The newly created
NumericEntityEscaper
instance
-
translate
Translate the specified codepoint 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
-