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 *      https://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 <a href="https://commons.apache.org/proper/commons-lang/changes-report.html#a3.6">3.6</a>, 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>.
029 */
030@Deprecated
031public class UnicodeEscaper extends CodePointTranslator {
032
033    /**
034     * Constructs a {@link UnicodeEscaper} above the specified value (exclusive).
035     *
036     * @param codePoint above which to escape.
037     * @return the newly created {@link UnicodeEscaper} instance.
038     */
039    public static UnicodeEscaper above(final int codePoint) {
040        return outsideOf(0, codePoint);
041    }
042
043    /**
044     * Constructs a {@link UnicodeEscaper} below the specified value (exclusive).
045     *
046     * @param codePoint below which to escape.
047     * @return the newly created {@link UnicodeEscaper} instance.
048     */
049    public static UnicodeEscaper below(final int codePoint) {
050        return outsideOf(codePoint, Integer.MAX_VALUE);
051    }
052
053    /**
054     * Constructs a {@link UnicodeEscaper} between the specified values (inclusive).
055     *
056     * @param codePointLow above which to escape.
057     * @param codePointHigh below which to escape.
058     * @return the newly created {@link UnicodeEscaper} instance.
059     */
060    public static UnicodeEscaper between(final int codePointLow, final int codePointHigh) {
061        return new UnicodeEscaper(codePointLow, codePointHigh, true);
062    }
063
064    /**
065     * Constructs a {@link UnicodeEscaper} outside of the specified values (exclusive).
066     *
067     * @param codePointLow below which to escape.
068     * @param codePointHigh above which to escape.
069     * @return the newly created {@link UnicodeEscaper} instance.
070     */
071    public static UnicodeEscaper outsideOf(final int codePointLow, final int codePointHigh) {
072        return new UnicodeEscaper(codePointLow, codePointHigh, false);
073    }
074
075    private final int below;
076
077    private final int above;
078
079    private final boolean between;
080
081    /**
082     * Constructs a {@link UnicodeEscaper} for all characters.
083     */
084    public UnicodeEscaper() {
085        this(0, Integer.MAX_VALUE, true);
086    }
087
088    /**
089     * Constructs a {@link UnicodeEscaper} for the specified range. This is
090     * the underlying method for the other constructors/builders. The {@code below}
091     * and {@code above} boundaries are inclusive when {@code between} is
092     * {@code true} and exclusive when it is {@code false}.
093     *
094     * @param below int value representing the lowest code point boundary.
095     * @param above int value representing the highest code point boundary.
096     * @param between whether to escape between the boundaries or outside them.
097     */
098    protected UnicodeEscaper(final int below, final int above, final boolean between) {
099        this.below = below;
100        this.above = above;
101        this.between = between;
102    }
103
104    /**
105     * Converts the given code point to a hexadecimal string of the form {@code "\\uXXXX"}
106     *
107     * @param codePoint
108     *            a Unicode code point.
109     * @return the hexadecimal string for the given code point.
110     * @since 3.2
111     */
112    protected String toUtf16Escape(final int codePoint) {
113        return "\\u" + hex(codePoint);
114    }
115
116    /**
117     * {@inheritDoc}
118     */
119    @Override
120    public boolean translate(final int codePoint, final Writer out) throws IOException {
121        if (between) {
122            if (codePoint < below || codePoint > above) {
123                return false;
124            }
125        } else if (codePoint >= below && codePoint <= above) {
126            return false;
127        }
128
129        // TODO: Handle potential + sign per various Unicode escape implementations
130        if (codePoint > 0xffff) {
131            out.write(toUtf16Escape(codePoint));
132        } else {
133          out.write("\\u");
134          out.write(HEX_DIGITS[codePoint >> 12 & 15]);
135          out.write(HEX_DIGITS[codePoint >> 8 & 15]);
136          out.write(HEX_DIGITS[codePoint >> 4 & 15]);
137          out.write(HEX_DIGITS[codePoint & 15]);
138        }
139        return true;
140    }
141}