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.io.input;
18  
19  import java.io.Reader;
20  import java.util.function.IntPredicate;
21  
22  /**
23   * A filter reader that filters out a given character represented as an {@code int} code point, handy to remove
24   * known junk characters from CSV files for example. This class is the most efficient way to filter out a single
25   * character, as opposed to using a {@link CharacterSetFilterReader}. You can also nest {@link CharacterFilterReader}s.
26   */
27  public class CharacterFilterReader extends AbstractCharacterFilterReader {
28  
29      /**
30       * Constructs a new reader.
31       *
32       * @param reader
33       *            the reader to filter.
34       * @param skip
35       *            the character to filter out.
36       */
37      public CharacterFilterReader(final Reader reader, final int skip) {
38          super(reader, c -> c == skip);
39      }
40  
41      /**
42       * Constructs a new reader.
43       *
44       * @param reader the reader to filter.
45       * @param skip Skip test.
46       * @since 2.9.0
47       */
48      public CharacterFilterReader(final Reader reader, final IntPredicate skip) {
49          super(reader, skip);
50      }
51  
52  }