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

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

public class UnicodeUnescaper
extends CharSequenceTranslator

Translates escaped unicode values of the form \\u+\d\d\d\d back to unicode.

Since:

3.0

Version:

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

Author:

Apache Software Foundation

Nested Class Summary

static class

UnicodeUnescaper.OPTION

Constructor Summary

UnicodeUnescaper(UnicodeUnescaper.OPTION... options)

Method Summary

boolean	isSet(UnicodeUnescaper.OPTION opt)
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

UnicodeUnescaper

public UnicodeUnescaper(UnicodeUnescaper.OPTION... options)

Method Detail

isSet

public boolean isSet(UnicodeUnescaper.OPTION opt)

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