1 /* 2 * Licensed to the Apache Software Foundation (ASF) under one or more 3 * contributor license agreements. See the NOTICE file distributed with 4 * this work for additional information regarding copyright ownership. 5 * The ASF licenses this file to You under the Apache License, Version 2.0 6 * (the "License"); you may not use this file except in compliance with 7 * the License. You may obtain a copy of the License at 8 * 9 * http://www.apache.org/licenses/LICENSE-2.0 10 * 11 * Unless required by applicable law or agreed to in writing, software 12 * distributed under the License is distributed on an "AS IS" BASIS, 13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 14 * See the License for the specific language governing permissions and 15 * limitations under the License. 16 */ 17 package org.apache.commons.lang3.text.translate; 18 19 import java.io.IOException; 20 import java.io.Writer; 21 22 /** 23 * Helper subclass to CharSequenceTranslator to allow for translations that 24 * will replace up to one character at a time. 25 * 26 * @since 3.0 27 * @deprecated As of 3.6, use Apache Commons Text 28 * <a href="https://commons.apache.org/proper/commons-text/javadocs/api-release/org/apache/commons/text/translate/CodePointTranslator.html"> 29 * CharSequenceTranslator</a> instead 30 */ 31 @Deprecated 32 public abstract class CodePointTranslator extends CharSequenceTranslator { 33 34 /** 35 * Implementation of translate that maps onto the abstract translate(int, Writer) method. 36 * {@inheritDoc} 37 */ 38 @Override translate(final CharSequence input, final int index, final Writer out)39 public final int translate(final CharSequence input, final int index, final Writer out) throws IOException { 40 final int codePoint = Character.codePointAt(input, index); 41 final boolean consumed = translate(codePoint, out); 42 return consumed ? 1 : 0; 43 } 44 45 /** 46 * Translate the specified code point into another. 47 * 48 * @param codePoint int character input to translate 49 * @param out Writer to optionally push the translated output to 50 * @return boolean as to whether translation occurred or not 51 * @throws IOException if and only if the Writer produces an IOException 52 */ translate(int codePoint, Writer out)53 public abstract boolean translate(int codePoint, Writer out) throws IOException; 54 55 } 56