Top Description Constructors Methods
org.apache.commons.lang3.text.translate

public Class JavaUnicodeEscaper

extends UnicodeEscaper
Class Inheritance
Annotations
@Deprecated

Deprecated

As of 3.6, use Apache Commons Text UnicodeEscaper.

Translates code points to their Unicode escaped value suitable for Java source.
Since
3.2

Constructor Summary

AccessConstructor and Description
public
JavaUnicodeEscaper(final int
int value representing the lowest code point boundary.
below
,
final int
int value representing the highest code point boundary.
above
,
final boolean
whether to escape between the boundaries or outside them.
between
)

Constructs a JavaUnicodeEscaper for the specified range.

Method Summary

Modifier and TypeMethod and Description
public static JavaUnicodeEscaper

Returns:

the newly created UnicodeEscaper instance.
above
(final int
above which to escape.
codePoint
)

Hides org.apache.commons.lang3.text.translate.UnicodeEscaper.above.

References Deprecated JavaUnicodeEscaper is deprecated or references (maybe indirectly) at least one deprecated element.

Constructs a JavaUnicodeEscaper above the specified value (exclusive).

public static JavaUnicodeEscaper

Returns:

the newly created UnicodeEscaper instance.
below
(final int
below which to escape.
codePoint
)

Hides org.apache.commons.lang3.text.translate.UnicodeEscaper.below.

References Deprecated JavaUnicodeEscaper is deprecated or references (maybe indirectly) at least one deprecated element.

Constructs a JavaUnicodeEscaper below the specified value (exclusive).

public static JavaUnicodeEscaper

Returns:

the newly created UnicodeEscaper instance.
between
(final int
above which to escape.
codePointLow
,
final int
below which to escape.
codePointHigh
)

Hides org.apache.commons.lang3.text.translate.UnicodeEscaper.between.

References Deprecated JavaUnicodeEscaper is deprecated or references (maybe indirectly) at least one deprecated element.

Constructs a JavaUnicodeEscaper between the specified values (inclusive).

public static JavaUnicodeEscaper

Returns:

the newly created UnicodeEscaper instance.
outsideOf
(final int
below which to escape.
codePointLow
,
final int
above which to escape.
codePointHigh
)

Hides org.apache.commons.lang3.text.translate.UnicodeEscaper.outsideOf.

References Deprecated JavaUnicodeEscaper is deprecated or references (maybe indirectly) at least one deprecated element.

Constructs a JavaUnicodeEscaper outside of the specified values (exclusive).

protected String

Returns:

the hexadecimal string for the given code point.
toUtf16Escape
(final int
a Unicode code point.
codePoint
)

Overrides org.apache.commons.lang3.text.translate.UnicodeEscaper.toUtf16Escape.

Converts the given code point to a hexadecimal string of the form "\\uXXXX\\uXXXX"

Inherited from org.apache.commons.lang3.text.translate.UnicodeEscaper:
translate

Constructor Detail

JavaUnicodeEscaperback to summary
public JavaUnicodeEscaper(final int below, final int above, final boolean between)

Constructs a JavaUnicodeEscaper for the specified range. This is the underlying method for the other constructors/builders. The below and above boundaries are inclusive when between is true and exclusive when it is false.

Parameters
below:int

int value representing the lowest code point boundary.

above:int

int value representing the highest code point boundary.

between:boolean

whether to escape between the boundaries or outside them.

Method Detail

aboveback to summary
public static JavaUnicodeEscaper above(final int codePoint)

Hides org.apache.commons.lang3.text.translate.UnicodeEscaper.above.

References Deprecated

JavaUnicodeEscaper is deprecated or references (maybe indirectly) at least one deprecated element.

See corresponding docs for further information.

Constructs a JavaUnicodeEscaper above the specified value (exclusive).

Parameters
codePoint:int

above which to escape.

Returns:JavaUnicodeEscaper

the newly created UnicodeEscaper instance.

belowback to summary
public static JavaUnicodeEscaper below(final int codePoint)

Hides org.apache.commons.lang3.text.translate.UnicodeEscaper.below.

References Deprecated

JavaUnicodeEscaper is deprecated or references (maybe indirectly) at least one deprecated element.

See corresponding docs for further information.

Constructs a JavaUnicodeEscaper below the specified value (exclusive).

Parameters
codePoint:int

below which to escape.

Returns:JavaUnicodeEscaper

the newly created UnicodeEscaper instance.

betweenback to summary
public static JavaUnicodeEscaper between(final int codePointLow, final int codePointHigh)

Hides org.apache.commons.lang3.text.translate.UnicodeEscaper.between.

References Deprecated

JavaUnicodeEscaper is deprecated or references (maybe indirectly) at least one deprecated element.

See corresponding docs for further information.

Constructs a JavaUnicodeEscaper between the specified values (inclusive).

Parameters
codePointLow:int

above which to escape.

codePointHigh:int

below which to escape.

Returns:JavaUnicodeEscaper

the newly created UnicodeEscaper instance.

outsideOfback to summary
public static JavaUnicodeEscaper outsideOf(final int codePointLow, final int codePointHigh)

Hides org.apache.commons.lang3.text.translate.UnicodeEscaper.outsideOf.

References Deprecated

JavaUnicodeEscaper is deprecated or references (maybe indirectly) at least one deprecated element.

See corresponding docs for further information.

Constructs a JavaUnicodeEscaper outside of the specified values (exclusive).

Parameters
codePointLow:int

below which to escape.

codePointHigh:int

above which to escape.

Returns:JavaUnicodeEscaper

the newly created UnicodeEscaper instance.

toUtf16Escapeback to summary
protected String toUtf16Escape(final int codePoint)

Overrides org.apache.commons.lang3.text.translate.UnicodeEscaper.toUtf16Escape.

Converts the given code point to a hexadecimal string of the form "\\uXXXX\\uXXXX"

Parameters
codePoint:int

a Unicode code point.

Returns:String

the hexadecimal string for the given code point.

Annotations
@Override