    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 * Proxy stream that prevents the underlying reader from being closed.
    023 * <p>
    024 * This class is typically used in cases where a reader needs to be
    025 * passed to a component that wants to explicitly close the reader even if
    026 * more input would still be available to other components.
    027 * </p>
    028 *
    029 * @since 2.7
    030 */
    031public class CloseShieldReader extends ProxyReader {
    032
    033    /**
    034     * Creates a proxy that shields the given reader from being
    035     * closed.
    036     *
    037     * @param in underlying reader
    038     */
    039    public CloseShieldReader(final Reader in) {
    040        super(in);
    041    }
    042
    043    /**
    044     * Replaces the underlying reader with a {@link ClosedReader}
    045     * sentinel. The original reader will remain open, but this proxy
    046     * will appear closed.
    047     */
    048    @Override
    049    public void close() {
    050        in = ClosedReader.CLOSED_READER;
    051    }
    052
    053}