    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 reader that prevents the underlying reader from being closed.
    023 * <p>
    024 * This class is typically used in cases where a reader needs to be passed to a
    025 * component that wants to explicitly close the reader even if more input would
    026 * 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 closed.
    035     *
    036     * @param reader the reader to wrap
    037     * @return the created proxy
    038     * @since 2.9.0
    039     */
    040    public static CloseShieldReader wrap(final Reader reader) {
    041        return new CloseShieldReader(reader);
    042    }
    043
    044    /**
    045     * Creates a proxy that shields the given reader from being closed.
    046     *
    047     * @param reader underlying reader
    048     * @deprecated Using this constructor prevents IDEs from warning if the
    049     *             underlying reader is never closed. Use {@link #wrap(Reader)}
    050     *             instead.
    051     */
    052    @Deprecated
    053    public CloseShieldReader(final Reader reader) {
    054        super(reader);
    055    }
    056
    057    /**
    058     * Replaces the underlying reader with a {@link ClosedReader} sentinel. The
    059     * original reader will remain open, but this proxy will appear closed.
    060     */
    061    @Override
    062    public void close() {
    063        in = ClosedReader.CLOSED_READER;
    064    }
    065
    066}