/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apache.commons.lang3.text.translate;

Translates codepoints to their Unicode escaped value suitable for Java source.
Since:
3.2
Deprecated:
as of 3.6, use commons-text

UnicodeEscaper instead/**
 * Translates codepoints to their Unicode escaped value suitable for Java source.
 *
 * @since 3.2
 * @deprecated as of 3.6, use commons-text
 * <a href="https://commons.apache.org/proper/commons-text/javadocs/api-release/org/apache/commons/text/translate/UnicodeEscaper.html">
 * UnicodeEscaper</a> instead
 */
@Deprecated
public class JavaUnicodeEscaper extends UnicodeEscaper {

    

Constructs a JavaUnicodeEscaper above the specified value (exclusive).

Params:
codepoint – 
           above which to escape
Returns:
the newly created UnicodeEscaper instance/**
     * <p>
     * Constructs a <code>JavaUnicodeEscaper</code> above the specified value (exclusive).
     * </p>
     *
     * @param codepoint
     *            above which to escape
     * @return the newly created {@code UnicodeEscaper} instance
     */
    public static JavaUnicodeEscaper above(final int codepoint) {
        return outsideOf(0, codepoint);
    }

    

Constructs a JavaUnicodeEscaper below the specified value (exclusive).

Params:
codepoint – 
           below which to escape
Returns:
the newly created UnicodeEscaper instance/**
     * <p>
     * Constructs a <code>JavaUnicodeEscaper</code> below the specified value (exclusive).
     * </p>
     *
     * @param codepoint
     *            below which to escape
     * @return the newly created {@code UnicodeEscaper} instance
     */
    public static JavaUnicodeEscaper below(final int codepoint) {
        return outsideOf(codepoint, Integer.MAX_VALUE);
    }

    

Constructs a JavaUnicodeEscaper between the specified values (inclusive).

Params:
codepointLow – 
           above which to escape
codepointHigh – 
           below which to escape
Returns:
the newly created UnicodeEscaper instance/**
     * <p>
     * Constructs a <code>JavaUnicodeEscaper</code> between the specified values (inclusive).
     * </p>
     *
     * @param codepointLow
     *            above which to escape
     * @param codepointHigh
     *            below which to escape
     * @return the newly created {@code UnicodeEscaper} instance
     */
    public static JavaUnicodeEscaper between(final int codepointLow, final int codepointHigh) {
        return new JavaUnicodeEscaper(codepointLow, codepointHigh, true);
    }

    

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

Params:
codepointLow – 
           below which to escape
codepointHigh – 
           above which to escape
Returns:
the newly created UnicodeEscaper instance/**
     * <p>
     * Constructs a <code>JavaUnicodeEscaper</code> outside of the specified values (exclusive).
     * </p>
     *
     * @param codepointLow
     *            below which to escape
     * @param codepointHigh
     *            above which to escape
     * @return the newly created {@code UnicodeEscaper} instance
     */
    public static JavaUnicodeEscaper outsideOf(final int codepointLow, final int codepointHigh) {
        return new JavaUnicodeEscaper(codepointLow, codepointHigh, false);
    }

    

Constructs a JavaUnicodeEscaper 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.

Params:
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/**
     * <p>
     * Constructs a <code>JavaUnicodeEscaper</code> for the specified range. This is the underlying method for the
     * other constructors/builders. The <code>below</code> and <code>above</code> boundaries are inclusive when
     * <code>between</code> is <code>true</code> and exclusive when it is <code>false</code>.
     * </p>
     *
     * @param below
     *            int value representing the lowest codepoint boundary
     * @param above
     *            int value representing the highest codepoint boundary
     * @param between
     *            whether to escape between the boundaries or outside them
     */
    public JavaUnicodeEscaper(final int below, final int above, final boolean between) {
        super(below, above, between);
    }

    
Converts the given codepoint to a hex string of the form "\\uXXXX\\uXXXX" 
Params:
codepoint – 
           a Unicode code point
Returns:
the hex string for the given codepoint/**
     * Converts the given codepoint to a hex string of the form {@code "\\uXXXX\\uXXXX"}
     *
     * @param codepoint
     *            a Unicode code point
     * @return the hex string for the given codepoint
     */
    @Override
    protected String toUtf16Escape(final int codepoint) {
        final char[] surrogatePair = Character.toChars(codepoint);
        return "\\u" + hex(surrogatePair[0]) + "\\u" + hex(surrogatePair[1]);
    }

}