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

public Class NumericEntityEscaper

extends CodePointTranslator
Class Inheritance
Annotations
@Deprecated
Imports
java.io.IOException, .Writer

Deprecated

As of 3.6, use Apache Commons Text NumericEntityEscaper.

Translates code points to their XML numeric entity escaped value.
Since
3.0

Field Summary

Modifier and TypeField and Description
private final int
above

private final int
below

private final boolean
between

Constructor Summary

AccessConstructor and Description
public
NumericEntityEscaper()

Constructs a NumericEntityEscaper for all characters.

private
NumericEntityEscaper(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 NumericEntityEscaper for the specified range.

Method Summary

Modifier and TypeMethod and Description
public static NumericEntityEscaper

Returns:

the newly created NumericEntityEscaper instance.
above(final int
above which to escape.
codePoint)
References Deprecated NumericEntityEscaper is deprecated or references (maybe indirectly) at least one deprecated element.

Constructs a NumericEntityEscaper above the specified value (exclusive).

public static NumericEntityEscaper

Returns:

the newly created NumericEntityEscaper instance.
below(final int
below which to escape.
codePoint)
References Deprecated NumericEntityEscaper is deprecated or references (maybe indirectly) at least one deprecated element.

Constructs a NumericEntityEscaper below the specified value (exclusive).

public static NumericEntityEscaper

Returns:

the newly created NumericEntityEscaper instance.
between(final int
above which to escape.
codePointLow, final int
below which to escape.
codePointHigh)
References Deprecated NumericEntityEscaper is deprecated or references (maybe indirectly) at least one deprecated element.

Constructs a NumericEntityEscaper between the specified values (inclusive).

public static NumericEntityEscaper

Returns:

the newly created NumericEntityEscaper instance.
outsideOf(final int
below which to escape.
codePointLow, final int
above which to escape.
codePointHigh)
References Deprecated NumericEntityEscaper is deprecated or references (maybe indirectly) at least one deprecated element.

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

public boolean
translate(final int codePoint, final Writer out)

Implements abstract org.apache.commons.lang3.text.translate.CodePointTranslator.translate.

Translate the specified code point into another.

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

Field Detail

aboveback to summary
private final int above
belowback to summary
private final int below
betweenback to summary
private final boolean between

Constructor Detail

NumericEntityEscaperback to summary
public NumericEntityEscaper()

Constructs a NumericEntityEscaper for all characters.

NumericEntityEscaperback to summary
private NumericEntityEscaper(final int below, final int above, final boolean between)

Constructs a NumericEntityEscaper 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 NumericEntityEscaper above(final int codePoint)

References Deprecated

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

See corresponding docs for further information.

Constructs a NumericEntityEscaper above the specified value (exclusive).

Parameters
codePoint:int

above which to escape.

Returns:NumericEntityEscaper

the newly created NumericEntityEscaper instance.

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

References Deprecated

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

See corresponding docs for further information.

Constructs a NumericEntityEscaper below the specified value (exclusive).

Parameters
codePoint:int

below which to escape.

Returns:NumericEntityEscaper

the newly created NumericEntityEscaper instance.

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

References Deprecated

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

See corresponding docs for further information.

Constructs a NumericEntityEscaper between the specified values (inclusive).

Parameters
codePointLow:int

above which to escape.

codePointHigh:int

below which to escape.

Returns:NumericEntityEscaper

the newly created NumericEntityEscaper instance.

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

References Deprecated

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

See corresponding docs for further information.

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

Parameters
codePointLow:int

below which to escape.

codePointHigh:int

above which to escape.

Returns:NumericEntityEscaper

the newly created NumericEntityEscaper instance.

translateback to summary
public boolean translate(final int codePoint, final Writer out) throws IOException

Implements abstract org.apache.commons.lang3.text.translate.CodePointTranslator.translate.

Doc from org.apache.commons.lang3.text.translate.CodePointTranslator.translate.

Translate the specified code point into another.

Annotations
@Override
Exceptions
IOException:
if and only if the Writer produces an IOException.