View Javadoc
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.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 1.0
27   */
28  public abstract class CodePointTranslator extends CharSequenceTranslator {
29  
30      /**
31       * Implementation of translate that maps onto the abstract translate(int, Writer) method.
32       * {@inheritDoc}
33       */
34      @Override
35      public final int translate(final CharSequence input, final int index, final Writer writer) throws IOException {
36          final int codePoint = Character.codePointAt(input, index);
37          final boolean consumed = translate(codePoint, writer);
38          return consumed ? 1 : 0;
39      }
40  
41      /**
42       * Translates the specified code point into another.
43       *
44       * @param codePoint int character input to translate
45       * @param writer Writer to optionally push the translated output to
46       * @return boolean as to whether translation occurred or not
47       * @throws IOException if and only if the Writer produces an IOException
48       */
49      public abstract boolean translate(int codePoint, Writer writer) throws IOException;
50  
51  }