Class UnicodeEscaper
java.lang.Object
org.apache.commons.text.translate.CharSequenceTranslator
org.apache.commons.text.translate.CodePointTranslator
org.apache.commons.text.translate.UnicodeEscaper
- Direct Known Subclasses:
JavaUnicodeEscaper
Translates code points to their Unicode escaped value.
- Since:
- 1.0
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate final int
int value representing the highest code point boundary.private final int
int value representing the lowest code point boundary.private final boolean
whether to escape between the boundaries or outside them.Fields inherited from class org.apache.commons.text.translate.CharSequenceTranslator
HEX_DIGITS
-
Constructor Summary
ConstructorsModifierConstructorDescriptionConstructs aUnicodeEscaper
for all characters.protected
UnicodeEscaper
(int below, int above, boolean between) Constructs aUnicodeEscaper
for the specified range. -
Method Summary
Modifier and TypeMethodDescriptionstatic UnicodeEscaper
above
(int codePoint) Constructs aUnicodeEscaper
above the specified value (exclusive).static UnicodeEscaper
below
(int codePoint) Constructs aUnicodeEscaper
below the specified value (exclusive).static UnicodeEscaper
between
(int codePointLow, int codePointHigh) Constructs aUnicodeEscaper
between the specified values (inclusive).static UnicodeEscaper
outsideOf
(int codePointLow, int codePointHigh) Constructs aUnicodeEscaper
outside of the specified values (exclusive).protected String
toUtf16Escape
(int codePoint) Converts the given code point to a hex string of the form"\\uXXXX"
.boolean
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
-
Field Details
-
below
private final int belowint value representing the lowest code point boundary. -
above
private final int aboveint value representing the highest code point boundary. -
between
private final boolean betweenwhether to escape between the boundaries or outside them.
-
-
Constructor Details
-
UnicodeEscaper
public UnicodeEscaper()Constructs aUnicodeEscaper
for all characters. -
UnicodeEscaper
protected UnicodeEscaper(int below, int above, boolean between) Constructs aUnicodeEscaper
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
Constructs aUnicodeEscaper
above the specified value (exclusive).- Parameters:
codePoint
- above which to escape- Returns:
- The newly created
UnicodeEscaper
instance
-
below
Constructs aUnicodeEscaper
below the specified value (exclusive).- Parameters:
codePoint
- below which to escape- Returns:
- The newly created
UnicodeEscaper
instance
-
between
Constructs aUnicodeEscaper
between the specified values (inclusive).- Parameters:
codePointLow
- above which to escapecodePointHigh
- below which to escape- Returns:
- The newly created
UnicodeEscaper
instance
-
outsideOf
Constructs aUnicodeEscaper
outside of the specified values (exclusive).- Parameters:
codePointLow
- below which to escapecodePointHigh
- above which to escape- Returns:
- The newly created
UnicodeEscaper
instance
-
toUtf16Escape
Converts the given code point to a hex string of the form"\\uXXXX"
.- Parameters:
codePoint
- a Unicode code point- Returns:
- The hex string for the given code point
-
translate
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:
IOException
- if and only if the Writer produces an IOException
-