    001/*
    002 * Licensed to the Apache Software Foundation (ASF) under one or more
    003 * contributor license agreements.  See the NOTICE file distributed with
    004 * this work for additional information regarding copyright ownership.
    005 * The ASF licenses this file to You under the Apache License, Version 2.0
    006 * (the "License"); you may not use this file except in compliance with
    007 * the License.  You may obtain a copy of the License at
    008 *
    009 *      http://www.apache.org/licenses/LICENSE-2.0
    010 *
    011 * Unless required by applicable law or agreed to in writing, software
    012 * distributed under the License is distributed on an "AS IS" BASIS,
    013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    014 * See the License for the specific language governing permissions and
    015 * limitations under the License.
    016 */
    017package org.apache.commons.lang3.text.translate;
    018
    019import java.io.IOException;
    020import java.io.Writer;
    021
    022/**
    023 * Translates code points to their Unicode escaped value.
    024 *
    025 * @since 3.0
    026 * @deprecated As of 3.6, use Apache Commons Text
    027 * <a href="https://commons.apache.org/proper/commons-text/javadocs/api-release/org/apache/commons/text/translate/UnicodeEscaper.html">
    028 * UnicodeEscaper</a> instead
    029 */
    030@Deprecated
    031public class UnicodeEscaper extends CodePointTranslator {
    032
    033    private final int below;
    034    private final int above;
    035    private final boolean between;
    036
    037    /**
    038     * Constructs a {@link UnicodeEscaper} for all characters.
    039     */
    040    public UnicodeEscaper() {
    041        this(0, Integer.MAX_VALUE, true);
    042    }
    043
    044    /**
    045     * Constructs a {@link UnicodeEscaper} for the specified range. This is
    046     * the underlying method for the other constructors/builders. The {@code below}
    047     * and {@code above} boundaries are inclusive when {@code between} is
    048     * {@code true} and exclusive when it is {@code false}.
    049     *
    050     * @param below int value representing the lowest code point boundary
    051     * @param above int value representing the highest code point boundary
    052     * @param between whether to escape between the boundaries or outside them
    053     */
    054    protected UnicodeEscaper(final int below, final int above, final boolean between) {
    055        this.below = below;
    056        this.above = above;
    057        this.between = between;
    058    }
    059
    060    /**
    061     * Constructs a {@link UnicodeEscaper} below the specified value (exclusive).
    062     *
    063     * @param codePoint below which to escape
    064     * @return the newly created {@link UnicodeEscaper} instance
    065     */
    066    public static UnicodeEscaper below(final int codePoint) {
    067        return outsideOf(codePoint, Integer.MAX_VALUE);
    068    }
    069
    070    /**
    071     * Constructs a {@link UnicodeEscaper} above the specified value (exclusive).
    072     *
    073     * @param codePoint above which to escape
    074     * @return the newly created {@link UnicodeEscaper} instance
    075     */
    076    public static UnicodeEscaper above(final int codePoint) {
    077        return outsideOf(0, codePoint);
    078    }
    079
    080    /**
    081     * Constructs a {@link UnicodeEscaper} outside of the specified values (exclusive).
    082     *
    083     * @param codePointLow below which to escape
    084     * @param codePointHigh above which to escape
    085     * @return the newly created {@link UnicodeEscaper} instance
    086     */
    087    public static UnicodeEscaper outsideOf(final int codePointLow, final int codePointHigh) {
    088        return new UnicodeEscaper(codePointLow, codePointHigh, false);
    089    }
    090
    091    /**
    092     * Constructs a {@link UnicodeEscaper} between the specified values (inclusive).
    093     *
    094     * @param codePointLow above which to escape
    095     * @param codePointHigh below which to escape
    096     * @return the newly created {@link UnicodeEscaper} instance
    097     */
    098    public static UnicodeEscaper between(final int codePointLow, final int codePointHigh) {
    099        return new UnicodeEscaper(codePointLow, codePointHigh, true);
    100    }
    101
    102    /**
    103     * {@inheritDoc}
    104     */
    105    @Override
    106    public boolean translate(final int codePoint, final Writer out) throws IOException {
    107        if (between) {
    108            if (codePoint < below || codePoint > above) {
    109                return false;
    110            }
    111        } else if (codePoint >= below && codePoint <= above) {
    112            return false;
    113        }
    114
    115        // TODO: Handle potential + sign per various Unicode escape implementations
    116        if (codePoint > 0xffff) {
    117            out.write(toUtf16Escape(codePoint));
    118        } else {
    119          out.write("\\u");
    120          out.write(HEX_DIGITS[(codePoint >> 12) & 15]);
    121          out.write(HEX_DIGITS[(codePoint >> 8) & 15]);
    122          out.write(HEX_DIGITS[(codePoint >> 4) & 15]);
    123          out.write(HEX_DIGITS[(codePoint) & 15]);
    124        }
    125        return true;
    126    }
    127
    128    /**
    129     * Converts the given code point to a hex string of the form {@code "\\uXXXX"}
    130     *
    131     * @param codePoint
    132     *            a Unicode code point
    133     * @return the hex string for the given code point
    134     *
    135     * @since 3.2
    136     */
    137    protected String toUtf16Escape(final int codePoint) {
    138        return "\\u" + hex(codePoint);
    139    }
    140}