/*

 * 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;

import java.io.IOException;

import java.io.Writer;

/**

 * Helper subclass to CharSequenceTranslator to allow for translations that

 * will replace up to one character at a time.

 *

 * @since 3.0

 * @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/CodePointTranslator.html">

 * CharSequenceTranslator</a> instead

 */

@Deprecated

public abstract class CodePointTranslator extends CharSequenceTranslator {

    /**

     * Implementation of translate that maps onto the abstract translate(int, Writer) method.

     * {@inheritDoc}

     */

    @Override

    public final int translate(final CharSequence input, final int index, final Writer out) throws IOException {

        final int codepoint = Character.codePointAt(input, index);

        final boolean consumed = translate(codepoint, out);

        return consumed ? 1 : 0;

    }

    /**

     * Translate the specified codepoint into another.

     *

     * @param codepoint int character input to translate

     * @param out Writer to optionally push the translated output to

     * @return boolean as to whether translation occurred or not

     * @throws IOException if and only if the Writer produces an IOException

     */

    public abstract boolean translate(int codepoint, Writer out) throws IOException;

}