NumericEntityEscaper

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

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

Translates code points to their XML numeric entity escaped value.

Since:

3.0

Constructors

NumericEntityEscaper()

Constructs a NumericEntityEscaper for all characters.
public NumericEntityEscaper()[source]

Constructs a NumericEntityEscaper for all characters.

Methods

above(int)

Constructs a NumericEntityEscaper above the specified value (exclusive).

below(int)

Constructs a NumericEntityEscaper below the specified value (exclusive).

between(int, int)

Constructs a NumericEntityEscaper between the specified values (inclusive).

outsideOf(int, int)

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

translate(int, Writer)

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

Constructs a NumericEntityEscaper above the specified value (exclusive).

Parameters:

codePoint – above which to escape.

Returns:

The newly created NumericEntityEscaper instance.

public static NumericEntityEscaper below(int codePoint)[source]

Constructs a NumericEntityEscaper below the specified value (exclusive).

Parameters:

codePoint – below which to escape.

Returns:

The newly created NumericEntityEscaper instance.

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

Constructs a NumericEntityEscaper between the specified values (inclusive).

Parameters:

  • codePointLow – above which to escape.

  • codePointHigh – below which to escape.

Returns:

The newly created NumericEntityEscaper instance.

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

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

Parameters:

  • codePointLow – below which to escape.

  • codePointHigh – above which to escape.

Returns:

The newly created NumericEntityEscaper instance.

@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.