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
-
Constructor Summary
ConstructorsModifierConstructorDescriptionConstructs aUnicodeEscaperfor all characters.protectedUnicodeEscaper(int below, int above, boolean between) Constructs aUnicodeEscaperfor the specified range. -
Method Summary
Modifier and TypeMethodDescriptionstatic UnicodeEscaperabove(int codePoint) Constructs aUnicodeEscaperabove the specified value (exclusive).static UnicodeEscaperbelow(int codePoint) Constructs aUnicodeEscaperbelow the specified value (exclusive).static UnicodeEscaperbetween(int codePointLow, int codePointHigh) Constructs aUnicodeEscaperbetween the specified values (inclusive).static UnicodeEscaperoutsideOf(int codePointLow, int codePointHigh) Constructs aUnicodeEscaperoutside of the specified values (exclusive).protected StringtoUtf16Escape(int codePoint) Converts the given code point to a hexadecimal string of the form"\\uXXXX".booleanTranslates the specified code point into another.Methods inherited from class org.apache.commons.text.translate.CodePointTranslator
translateMethods inherited from class org.apache.commons.text.translate.CharSequenceTranslator
hex, translate, translate, with
-
Constructor Details
-
UnicodeEscaper
public UnicodeEscaper()Constructs aUnicodeEscaperfor all characters. -
UnicodeEscaper
Constructs aUnicodeEscaperfor the specified range. This is the underlying method for the other constructors/builders. Thebelowandaboveboundaries are inclusive whenbetweenistrueand 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 aUnicodeEscaperabove the specified value (exclusive).- Parameters:
codePoint- above which to escape- Returns:
- The newly created
UnicodeEscaperinstance
-
below
Constructs aUnicodeEscaperbelow the specified value (exclusive).- Parameters:
codePoint- below which to escape- Returns:
- The newly created
UnicodeEscaperinstance
-
between
Constructs aUnicodeEscaperbetween the specified values (inclusive).- Parameters:
codePointLow- above which to escapecodePointHigh- below which to escape- Returns:
- The newly created
UnicodeEscaperinstance
-
outsideOf
Constructs aUnicodeEscaperoutside of the specified values (exclusive).- Parameters:
codePointLow- below which to escapecodePointHigh- above which to escape- Returns:
- The newly created
UnicodeEscaperinstance
-
toUtf16Escape
Converts the given code point to a hexadecimal string of the form"\\uXXXX".- Parameters:
codePoint- a Unicode code point- Returns:
- The hexadecimal string for the given code point
-
translate
Translates the specified code point into another.- Specified by:
translatein 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
-