Apache Commons Text 1.15.0 · org.apache.commons.text.translate.NumericEntityEscaper

Modifier and Type	Field and Description
private final boolean	between Whether to escape between the boundaries or outside them.
private final Range<Integer>	range Range from lowest code point to highest code point.

Constructor Summary

Access	Constructor 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 Type	Method and Description
public static NumericEntityEscaper	Returns: The newly created `NumericEntityEscaper` instance. above(final int above which to escape. codePoint) 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) 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) 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) Constructs a `NumericEntityEscaper` outside of the specified values (exclusive).
public boolean	translate(final int codePoint, final Writer writer) Implements abstract org.apache.commons.text.translate.CodePointTranslator.translate. Translates the specified code point into another.

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

Field Detail

between	back to summary
private final boolean between Whether to escape between the boundaries or outside them.

range	back to summary
private final Range<Integer> range Range from lowest code point to highest code point.

Constructor Detail

NumericEntityEscaper	back to summary
public NumericEntityEscaper() Constructs a `NumericEntityEscaper` for all characters.

NumericEntityEscaper back to summary

NumericEntityEscaper	back 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.

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

above back to summary

above	back to summary
public static NumericEntityEscaper above(final int codePoint) Constructs a `NumericEntityEscaper` above the specified value (exclusive). Parameters codePoint:int above which to escape. Returns:NumericEntityEscaper The newly created `NumericEntityEscaper` instance.

public static NumericEntityEscaper above(final int codePoint)

Constructs a NumericEntityEscaper above the specified value (exclusive).

Parameters

codePoint:int: above which to escape.

Returns:NumericEntityEscaper

The newly created NumericEntityEscaper instance.

below back to summary

below	back to summary
public static NumericEntityEscaper below(final int codePoint) Constructs a `NumericEntityEscaper` below the specified value (exclusive). Parameters codePoint:int below which to escape. Returns:NumericEntityEscaper The newly created `NumericEntityEscaper` instance.

public static NumericEntityEscaper below(final int codePoint)

Constructs a NumericEntityEscaper below the specified value (exclusive).

Parameters

codePoint:int: below which to escape.

Returns:NumericEntityEscaper

The newly created NumericEntityEscaper instance.

between back to summary

between	back to summary
public static NumericEntityEscaper between(final int codePointLow, final int codePointHigh) 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.

public static NumericEntityEscaper between(final int codePointLow, final int codePointHigh)

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.

outsideOf back to summary

outsideOf	back to summary
public static NumericEntityEscaper outsideOf(final int codePointLow, final int codePointHigh) 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.

public static NumericEntityEscaper outsideOf(final int codePointLow, final int codePointHigh)

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.

translate	back to summary
public boolean translate(final int codePoint, final Writer writer) throws IOException Implements abstract org.apache.commons.text.translate.CodePointTranslator.translate. Doc from org.apache.commons.text.translate.CodePointTranslator.translate. Translates the specified code point into another. Annotations @Override Exceptions IOException: if and only if the Writer produces an IOException.

translate

back to summary

public boolean translate(final int codePoint, final Writer writer) throws IOException

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

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

Translates the specified code point into another.

Annotations

@Override

Exceptions

IOException:: if and only if the Writer produces an IOException.

public Class NumericEntityEscaper

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail