org.aoju.bus.core.text.escape

Class NumericEscaper

java.lang.Object

org.aoju.bus.core.text.translate.CharSequenceTranslator

org.aoju.bus.core.text.translate.CodePointTranslator

org.aoju.bus.core.text.escape.NumericEscaper

public class NumericEscaper
extends CodePointTranslator

Translates codepoints to their XML numeric entity escaped value.

Since:

JDK 1.8

Version:

3.2.5

Author:

Kimi Liu

Constructor Summary

Constructors

Constructor and Description
NumericEscaper() Constructs a NumericEscaper for all characters.

Method Summary

Modifier and Type	Method and Description
static NumericEscaper	above(int codepoint) Constructs a NumericEscaper above the specified value (exclusive).
static NumericEscaper	below(int codepoint) Constructs a NumericEscaper below the specified value (exclusive).
static NumericEscaper	between(int codepointLow, int codepointHigh) Constructs a NumericEscaper between the specified values (inclusive).
static NumericEscaper	outsideOf(int codepointLow, int codepointHigh) Constructs a NumericEscaper outside of the specified values (exclusive).
boolean	translate(int codepoint, Writer out) Translate the specified codepoint into another.

Methods inherited from class org.aoju.bus.core.text.translate.CodePointTranslator

translate

Methods inherited from class org.aoju.bus.core.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

Constructor Detail

NumericEscaper

public NumericEscaper()

Constructs a NumericEscaper for all characters.

Method Detail

below

public static NumericEscaper below(int codepoint)

Constructs a NumericEscaper below the specified value (exclusive).

Parameters:

codepoint - below which to escape

Returns:

the newly created NumericEscaper instance

above

public static NumericEscaper above(int codepoint)

Constructs a NumericEscaper above the specified value (exclusive).

Parameters:

codepoint - above which to escape

Returns:

the newly created NumericEscaper instance

between

public static NumericEscaper between(int codepointLow,
                                     int codepointHigh)

Constructs a NumericEscaper between the specified values (inclusive).

Parameters:

codepointLow - above which to escape

codepointHigh - below which to escape

Returns:

the newly created NumericEscaper instance

outsideOf

public static NumericEscaper outsideOf(int codepointLow,
                                       int codepointHigh)

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

Parameters:

codepointLow - below which to escape

codepointHigh - above which to escape

Returns:

the newly created NumericEscaper instance

translate

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

Description copied from class: CodePointTranslator

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:

IOException - if and only if the Writer produces an IOException