org.apache.commons.lang3.text.translate
Class NumericEntityUnescaper

java.lang.Object
  org.apache.commons.lang3.text.translate.CharSequenceTranslator
      org.apache.commons.lang3.text.translate.NumericEntityUnescaper

public class NumericEntityUnescaper
extends CharSequenceTranslator

Translate XML numeric entities of the form &#[xX]?\d+; to the specific codepoint.

Since:

3.0

Version:

$Id: NumericEntityUnescaper.java 967237 2010-07-23 20:08:57Z mbenson $

Author:

Apache Software Foundation

Constructor Summary

NumericEntityUnescaper()

Method Summary

int	translate(CharSequence input, int index, Writer out) Translate a set of codepoints, represented by an int index into a CharSequence, into another set of codepoints.

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

Constructor Detail

NumericEntityUnescaper

public NumericEntityUnescaper()

Method Detail

translate

public int translate(CharSequence input,
                     int index,
                     Writer out)
              throws IOException

Translate a set of codepoints, represented by an int index into a CharSequence, into another set of codepoints. The number of codepoints consumed must be returned, and the only IOExceptions thrown must be from interacting with the Writer so that the top level API may reliable ignore StringWriter IOExceptions.

Specified by:

translate in class CharSequenceTranslator

Parameters:

input - CharSequence that is being translated

index - int representing the current point of translation

out - Writer to translate the text to

Returns:

int count of codepoints consumed

Throws:

IOException - if and only if the Writer produces an IOException