001/* 002 * Licensed to the Apache Software Foundation (ASF) under one or more 003 * contributor license agreements. See the NOTICE file distributed with 004 * this work for additional information regarding copyright ownership. 005 * The ASF licenses this file to You under the Apache License, Version 2.0 006 * (the "License"); you may not use this file except in compliance with 007 * the License. You may obtain a copy of the License at 008 * 009 * http://www.apache.org/licenses/LICENSE-2.0 010 * 011 * Unless required by applicable law or agreed to in writing, software 012 * distributed under the License is distributed on an "AS IS" BASIS, 013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 014 * See the License for the specific language governing permissions and 015 * limitations under the License. 016 */ 017package org.apache.commons.io.input; 018 019import java.io.Reader; 020 021/** 022 * A filter reader that filters out a given character represented as an <code>int</code> code point, handy to remove 023 * known junk characters from CSV files for example. This class is the most efficient way to filter out a single 024 * character, as opposed to using a {@link CharacterSetFilterReader}. You can also nest {@link CharacterFilterReader}s. 025 */ 026public class CharacterFilterReader extends AbstractCharacterFilterReader { 027 028 private final int skip; 029 030 /** 031 * Constructs a new reader. 032 * 033 * @param reader 034 * the reader to filter. 035 * @param skip 036 * the character to filter out. 037 */ 038 public CharacterFilterReader(final Reader reader, final int skip) { 039 super(reader); 040 this.skip = skip; 041 } 042 043 @Override 044 protected boolean filter(final int ch) { 045 return ch == skip; 046 } 047 048}