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