Class UnicodeEscaper
- java.lang.Object
-
- org.apache.commons.lang3.text.translate.CharSequenceTranslator
-
- org.apache.commons.lang3.text.translate.CodePointTranslator
-
- org.apache.commons.lang3.text.translate.UnicodeEscaper
-
- Direct Known Subclasses:
JavaUnicodeEscaper
@Deprecated public class UnicodeEscaper extends CodePointTranslator
Deprecated.As of 3.6, use Apache Commons Text UnicodeEscaper insteadTranslates code points to their Unicode escaped value.- Since:
- 3.0
-
-
Field Summary
Fields Modifier and Type Field Description private int
above
Deprecated.private int
below
Deprecated.private boolean
between
Deprecated.-
Fields inherited from class org.apache.commons.lang3.text.translate.CharSequenceTranslator
HEX_DIGITS
-
-
Constructor Summary
Constructors Modifier Constructor Description UnicodeEscaper()
Deprecated.Constructs aUnicodeEscaper
for all characters.protected
UnicodeEscaper(int below, int above, boolean between)
Deprecated.Constructs aUnicodeEscaper
for the specified range.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description static UnicodeEscaper
above(int codePoint)
Deprecated.Constructs aUnicodeEscaper
above the specified value (exclusive).static UnicodeEscaper
below(int codePoint)
Deprecated.Constructs aUnicodeEscaper
below the specified value (exclusive).static UnicodeEscaper
between(int codePointLow, int codePointHigh)
Deprecated.Constructs aUnicodeEscaper
between the specified values (inclusive).static UnicodeEscaper
outsideOf(int codePointLow, int codePointHigh)
Deprecated.Constructs aUnicodeEscaper
outside of the specified values (exclusive).protected java.lang.String
toUtf16Escape(int codePoint)
Deprecated.Converts the given code point to a hexadecimal string of the form"\\uXXXX"
boolean
translate(int codePoint, java.io.Writer out)
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
-
-
-
-
Constructor Detail
-
UnicodeEscaper
public UnicodeEscaper()
Deprecated.Constructs aUnicodeEscaper
for all characters.
-
UnicodeEscaper
protected UnicodeEscaper(int below, int above, boolean between)
Deprecated.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 Detail
-
above
public static UnicodeEscaper above(int codePoint)
Deprecated.Constructs aUnicodeEscaper
above the specified value (exclusive).- Parameters:
codePoint
- above which to escape- Returns:
- the newly created
UnicodeEscaper
instance
-
below
public static UnicodeEscaper below(int codePoint)
Deprecated.Constructs aUnicodeEscaper
below the specified value (exclusive).- Parameters:
codePoint
- below which to escape- Returns:
- the newly created
UnicodeEscaper
instance
-
between
public static UnicodeEscaper between(int codePointLow, int codePointHigh)
Deprecated.Constructs aUnicodeEscaper
between the specified values (inclusive).- Parameters:
codePointLow
- above which to escapecodePointHigh
- below which to escape- Returns:
- the newly created
UnicodeEscaper
instance
-
outsideOf
public static UnicodeEscaper outsideOf(int codePointLow, int codePointHigh)
Deprecated.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
protected java.lang.String toUtf16Escape(int codePoint)
Deprecated.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
- Since:
- 3.2
-
translate
public boolean translate(int codePoint, java.io.Writer out) throws java.io.IOException
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:
java.io.IOException
- if and only if the Writer produces an IOException
-
-