UnicodeEscaper

@Deprecated public class org.apache.commons.lang3.text.translate.UnicodeEscaper extends CodePointTranslator[source]

Deprecated: As of 3.6, use Apache Commons Text UnicodeEscaper.

Translates code points to their Unicode escaped value.

Since:

3.0

Constructors

UnicodeEscaper()

Constructs a UnicodeEscaper for all characters.

UnicodeEscaper(int, int, boolean)

Constructs a UnicodeEscaper for the specified range.
public UnicodeEscaper()[source]

Constructs a UnicodeEscaper for all characters.

protected UnicodeEscaper(int below, int above, boolean between)[source]

Constructs a UnicodeEscaper 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 value representing the lowest code point boundary.

  • above – int value representing the highest code point boundary.

  • between – whether to escape between the boundaries or outside them.

Methods

above(int)

Constructs a UnicodeEscaper above the specified value (exclusive).

below(int)

Constructs a UnicodeEscaper below the specified value (exclusive).

between(int, int)

Constructs a UnicodeEscaper between the specified values (inclusive).

outsideOf(int, int)

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

toUtf16Escape(int)

Converts the given code point to a hexadecimal string of the form "\\uXXXX", or the surrogate pair form "\\uXXXX\\uXXXX" for a supplementary code point.

translate(int, Writer)

Translate the specified code point into another.
public static UnicodeEscaper above(int codePoint)[source]

Constructs a UnicodeEscaper above the specified value (exclusive).

Parameters:

codePoint – above which to escape.

Returns:

The newly created UnicodeEscaper instance.

public static UnicodeEscaper below(int codePoint)[source]

Constructs a UnicodeEscaper below the specified value (exclusive).

Parameters:

codePoint – below which to escape.

Returns:

The newly created UnicodeEscaper instance.

public static UnicodeEscaper between(int codePointLow, int codePointHigh)[source]

Constructs a UnicodeEscaper between the specified values (inclusive).

Parameters:

  • codePointLow – above which to escape.

  • codePointHigh – below which to escape.

Returns:

The newly created UnicodeEscaper instance.

public static UnicodeEscaper outsideOf(int codePointLow, int codePointHigh)[source]

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

Parameters:

  • codePointLow – below which to escape.

  • codePointHigh – above which to escape.

Returns:

The newly created UnicodeEscaper instance.

protected String toUtf16Escape(int codePoint)[source]

Converts the given code point to a hexadecimal string of the form "\\uXXXX", or the surrogate pair form "\\uXXXX\\uXXXX" for a supplementary code point.

Parameters:

codePoint – a Unicode code point.

Returns:

The hexadecimal string for the given code point.

Since:

3.2

@Override public boolean translate(int codePoint, Writer out) throws IOException[source]

Translate the specified code point into another.

Parameters:

  • codePoint – int character input to translate.

  • out – Writer to optionally push the translated output to.

Returns:

boolean as to whether translation occurred or not.

Throws:

java.io.IOException – Thrown if and only if the Writer produces an IOException.