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 remove unpaired surrogates.
24 *
25 * @deprecated As of 3.6, use Apache Commons Text
26 * <a href="https://commons.apache.org/proper/commons-text/javadocs/api-release/org/apache/commons/text/translate/UnicodeUnpairedSurrogateRemover.html">
27 * UnicodeUnpairedSurrogateRemover</a> instead
28 */
29 @Deprecated
30 public class UnicodeUnpairedSurrogateRemover extends CodePointTranslator {
31
32 /**
33 * Constructs a new instance.
34 */
35 public UnicodeUnpairedSurrogateRemover() {
36 // empty
37 }
38
39 /**
40 * Implements translate that throws out unpaired surrogates.
41 * {@inheritDoc}
42 */
43 @Override
44 public boolean translate(final int codePoint, final Writer out) throws IOException {
45 // true: It's a surrogate. Write nothing and say we've translated.
46 return codePoint >= Character.MIN_SURROGATE && codePoint <= Character.MAX_SURROGATE;
47 // It's not a surrogate. Don't translate it.
48 }
49 }
50