Package org.apache.commons.text.translate

Class NumericEntityEscaper

java.lang.Object

org.apache.commons.text.translate.CharSequenceTranslator

org.apache.commons.text.translate.CodePointTranslator

org.apache.commons.text.translate.NumericEntityEscaper

public class NumericEntityEscaper
extends CodePointTranslator

Translates code points to their XML numeric entity escaped value.

Since:

1.0

Constructor Summary

Constructors

Constructor	Description
NumericEntityEscaper()	Constructs a NumericEntityEscaper for all characters.

Method Summary

Modifier and Type	Method	Description
static NumericEntityEscaper	above(int codePoint)	Constructs a NumericEntityEscaper above the specified value (exclusive).
static NumericEntityEscaper	below(int codePoint)	Constructs a NumericEntityEscaper below the specified value (exclusive).
static NumericEntityEscaper	between(int codePointLow, int codePointHigh)	Constructs a NumericEntityEscaper between the specified values (inclusive).
static NumericEntityEscaper	outsideOf(int codePointLow, int codePointHigh)	Constructs a NumericEntityEscaper outside of the specified values (exclusive).
boolean	translate(int codePoint, java.io.Writer writer)	Translates the specified code point into another.

Methods inherited from class org.apache.commons.text.translate.CodePointTranslator

translate

Methods inherited from class org.apache.commons.text.translate.CharSequenceTranslator

hex, translate, translate, with

Methods inherited from class java.lang.Object

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

Constructor Detail

NumericEntityEscaper

public NumericEntityEscaper()

Constructs a NumericEntityEscaper for all characters.

Method Detail

above

public static NumericEntityEscaper above(int codePoint)

Constructs a NumericEntityEscaper above the specified value (exclusive).

Parameters:

codePoint - above which to escape

Returns:

The newly created NumericEntityEscaper instance

below

public static NumericEntityEscaper below(int codePoint)

Constructs a NumericEntityEscaper below the specified value (exclusive).

Parameters:

codePoint - below which to escape

Returns:

The newly created NumericEntityEscaper instance

between

public static NumericEntityEscaper between(int codePointLow,
                                           int codePointHigh)

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)

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 writer)
                  throws java.io.IOException

Translates the specified code point into another.

Specified by:

translate in class CodePointTranslator

Parameters:

codePoint - int character input to translate

writer - 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