Package 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
Direct Known Subclasses:
JavaUnicodeEscaper
@Deprecated public class UnicodeEscaper extends CodePointTranslator
Deprecated.
as of 3.6, use commons-text UnicodeEscaper instead
Translates codepoints to their Unicode escaped value.
Since:
3.0

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    private final int
    above
    Deprecated.
     
    private final int
    below
    Deprecated.
     
    private final boolean
    between
    Deprecated.
     

    Fields inherited from class org.apache.commons.lang3.text.translate.CharSequenceTranslator

    HEX_DIGITS

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
     
    UnicodeEscaper()
    Deprecated.
    Constructs a UnicodeEscaper for all characters.
    protected
    UnicodeEscaper(int below, int above, boolean between)
    Deprecated.
    Constructs a UnicodeEscaper for the specified range.

  • Method Summary

    Modifier and Type
    Method
    Description
    static UnicodeEscaper
    above(int codepoint)
    Deprecated.
    Constructs a UnicodeEscaper above the specified value (exclusive).
    static UnicodeEscaper
    below(int codepoint)
    Deprecated.
    Constructs a UnicodeEscaper below the specified value (exclusive).
    static UnicodeEscaper
    between(int codepointLow, int codepointHigh)
    Deprecated.
    Constructs a UnicodeEscaper between the specified values (inclusive).
    static UnicodeEscaper
    outsideOf(int codepointLow, int codepointHigh)
    Deprecated.
    Constructs a UnicodeEscaper outside of the specified values (exclusive).
    protected String
    toUtf16Escape(int codepoint)
    Deprecated.
    Converts the given codepoint to a hex string of the form "\\uXXXX"
    boolean
    translate(int codepoint, Writer out)
    Deprecated.
    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

  • Field Details

    • below

      private final int below
      Deprecated.

    • above

      private final int above
      Deprecated.

    • between

      private final boolean between
      Deprecated.

  • Constructor Details

    • UnicodeEscaper

      public UnicodeEscaper()
      Deprecated.

      Constructs a UnicodeEscaper for all characters.

    • UnicodeEscaper

      protected UnicodeEscaper(int below, int above, boolean between)
      Deprecated.

      Constructs a UnicodeEscaper 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 value representing the lowest codepoint boundary
      above - int value representing the highest codepoint boundary
      between - whether to escape between the boundaries or outside them

  • Method Details

    • below

      public static UnicodeEscaper below(int codepoint)
      Deprecated.

      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)
      Deprecated.

      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)
      Deprecated.

      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)
      Deprecated.

      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
      Deprecated.
      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

    • toUtf16Escape

      protected String toUtf16Escape(int codepoint)
      Deprecated.
      Converts the given codepoint to a hex string of the form "\\uXXXX"
      Parameters:
      codepoint - a Unicode code point
      Returns:
      the hex string for the given codepoint
      Since:
      3.2