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

java.lang.Object
  org.apache.commons.lang3.text.translate.CharSequenceTranslator
      org.apache.commons.lang3.text.translate.CodePointTranslator
          org.apache.commons.lang3.text.translate.UnicodeEscaper

public class UnicodeEscaper
extends CodePointTranslator

Translates codepoints to their Unicode escaped value.

Since:

3.0

Version:

$Id: UnicodeEscaper.java 1148520 2011-07-19 20:53:23Z ggregory $

Constructor Summary

UnicodeEscaper()
Constructs a UnicodeEscaper for all characters.

Method Summary

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

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

translate

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

UnicodeEscaper

public UnicodeEscaper()

Constructs a UnicodeEscaper for all characters.

Method Detail

below

public static UnicodeEscaper below(int codepoint)

Constructs a UnicodeEscaper below the specified value (exclusive).

Parameters:

codepoint - below which to escape

Returns:

the newly created UnicodeEscaper instance

above

public static UnicodeEscaper above(int codepoint)

Constructs a UnicodeEscaper above the specified value (exclusive).

Parameters:

codepoint - above which to escape

Returns:

the newly created UnicodeEscaper instance

outsideOf

public static UnicodeEscaper outsideOf(int codepointLow,
                                       int codepointHigh)

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

Parameters:

codepointLow - below which to escape

codepointHigh - above which to escape

Returns:

the newly created UnicodeEscaper instance

between

public static UnicodeEscaper between(int codepointLow,
                                     int codepointHigh)

Constructs a UnicodeEscaper between the specified values (inclusive).

Parameters:

codepointLow - above which to escape

codepointHigh - below which to escape

Returns:

the newly created UnicodeEscaper instance

translate

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

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