    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     */
    017    package org.apache.commons.lang3.text.translate;
    018
    019    import java.io.IOException;
    020    import 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     * @author Apache Software Foundation
    027     * @since 3.0
    028     * @version $Id: CodePointTranslator.java 967237 2010-07-23 20:08:57Z mbenson $
    029     */
    030    public abstract class CodePointTranslator extends CharSequenceTranslator {
    031
    032        /**
    033         * Implementation of translate that maps onto the abstract translate(int, Writer) method.
    034         * {@inheritDoc}
    035         */
    036        @Override
    037        public final int translate(CharSequence input, int index, Writer out) throws IOException {
    038            int codepoint = Character.codePointAt(input, index);
    039            boolean consumed = translate(codepoint, out);
    040            if(consumed) {
    041                return 1;
    042            } else {
    043                return 0;
    044            }
    045        }
    046
    047        /**
    048         * Translate the specified codepoint into another.
    049         *
    050         * @param codepoint int character input to translate
    051         * @param out Writer to optionally push the translated output to
    052         * @return boolean as to whether translation occurred or not
    053         * @throws IOException if and only if the Writer produces an IOException
    054         */
    055        public abstract boolean translate(int codepoint, Writer out) throws IOException;
    056
    057    }