Package org.apache.commons.lang3.text.translate

Class NumericEntityEscaper

java.lang.Object

org.apache.commons.lang3.text.translate.CharSequenceTranslator

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

org.apache.commons.lang3.text.translate.NumericEntityEscaper

@Deprecated
public class NumericEntityEscaper
extends CodePointTranslator

Deprecated.

as of 3.6, use commons-text NumericEntityEscaper instead

Translates codepoints to their XML numeric entity 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
	NumericEntityEscaper()	Deprecated. Constructs a NumericEntityEscaper for all characters.
private	NumericEntityEscaper(int below, int above, boolean between)	Deprecated. Constructs a NumericEntityEscaper for the specified range.

Method Summary

Modifier and Type	Method	Description
static NumericEntityEscaper	above(int codepoint)	Deprecated. Constructs a NumericEntityEscaper above the specified value (exclusive).
static NumericEntityEscaper	below(int codepoint)	Deprecated. Constructs a NumericEntityEscaper below the specified value (exclusive).
static NumericEntityEscaper	between(int codepointLow, int codepointHigh)	Deprecated. Constructs a NumericEntityEscaper between the specified values (inclusive).
static NumericEntityEscaper	outsideOf(int codepointLow, int codepointHigh)	Deprecated. Constructs a NumericEntityEscaper outside of the specified values (exclusive).
boolean	translate(int codepoint, java.io.Writer out)	Deprecated. Translate the specified codepoint 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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

below

private final int below

Deprecated.

above

private final int above

Deprecated.

between

private final boolean between

Deprecated.

Constructor Detail

NumericEntityEscaper

private NumericEntityEscaper(int below,
                             int above,
                             boolean between)

Deprecated.

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 value representing the lowest codepoint boundary

above - int value representing the highest codepoint boundary

between - whether to escape between the boundaries or outside them

NumericEntityEscaper

public NumericEntityEscaper()

Deprecated.

Constructs a NumericEntityEscaper for all characters.

Method Detail

below

public static NumericEntityEscaper below(int codepoint)

Deprecated.

Constructs a NumericEntityEscaper below the specified value (exclusive).

Parameters:

codepoint - below which to escape

Returns:

the newly created NumericEntityEscaper instance

above

public static NumericEntityEscaper above(int codepoint)

Deprecated.

Constructs a NumericEntityEscaper above the specified value (exclusive).

Parameters:

codepoint - above which to escape

Returns:

the newly created NumericEntityEscaper instance

between

public static NumericEntityEscaper between(int codepointLow,
                                           int codepointHigh)

Deprecated.

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

outsideOf

public static NumericEntityEscaper outsideOf(int codepointLow,
                                             int codepointHigh)

Deprecated.

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

translate

public boolean translate(int codepoint,
                         java.io.Writer out)
                  throws java.io.IOException

Deprecated.

Translate the specified codepoint into another.

Specified by:

translate in class CodePointTranslator

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 - if and only if the Writer produces an IOException