    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 * Helper subclass to CharSequenceTranslator to allow for translations that
    024 * will replace up to one character at a time.
    025 *
    026 * @since 3.0
    027 * @deprecated As of <a href="https://commons.apache.org/proper/commons-lang/changes-report.html#a3.6">3.6</a>, use Apache Commons Text
    028 * <a href="https://commons.apache.org/proper/commons-text/javadocs/api-release/org/apache/commons/text/translate/CodePointTranslator.html">
    029 * CharSequenceTranslator</a>.
    030 */
    031@Deprecated
    032public abstract class CodePointTranslator extends CharSequenceTranslator {
    033
    034    /**
    035     * Constructs a new instance.
    036     */
    037    public CodePointTranslator() {
    038        // empty
    039    }
    040
    041    /**
    042     * Implements translate to map onto the abstract translate(int, Writer) method.
    043     * {@inheritDoc}
    044     */
    045    @Override
    046    public final int translate(final CharSequence input, final int index, final Writer out) throws IOException {
    047        final int codePoint = Character.codePointAt(input, index);
    048        final boolean consumed = translate(codePoint, out);
    049        return consumed ? 1 : 0;
    050    }
    051
    052    /**
    053     * Translate the specified code point into another.
    054     *
    055     * @param codePoint int character input to translate.
    056     * @param out Writer to optionally push the translated output to.
    057     * @return boolean as to whether translation occurred or not.
    058     * @throws IOException if and only if the Writer produces an IOException.
    059     */
    060    public abstract boolean translate(int codePoint, Writer out) throws IOException;
    061
    062}