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 remove unpaired surrogates.
24   *
25   * @since 1.0
26   */
27  public class UnicodeUnpairedSurrogateRemover extends CodePointTranslator {
28      /**
29       * Implementation of translate that throws out unpaired surrogates. 
30       * {@inheritDoc}
31       */
32      @Override
33      public boolean translate(final int codepoint, final Writer out) throws IOException {
34          if (codepoint >= Character.MIN_SURROGATE && codepoint <= Character.MAX_SURROGATE) {
35              // It's a surrogate. Write nothing and say we've translated.
36              return true;
37          }
38          // It's not a surrogate. Don't translate it.
39          return false;
40      }
41  }
42