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.InputStream;
20 
21 /**
22  * Proxy stream that prevents the underlying input stream from being closed.
23  * <p>
24  * This class is typically used in cases where an input stream needs to be
25  * passed to a component that wants to explicitly close the stream even if
26  * more input would still be available to other components.
27  *
28  * @version $Id: CloseShieldInputStream.java 587913 2007-10-24 15:47:30Z niallp $
29  * @since Commons IO 1.4
30  */
31 public class CloseShieldInputStream extends ProxyInputStream {
32 
33     /**
34      * Creates a proxy that shields the given input stream from being
35      * closed.
36      *
37      * @param in underlying input stream
38      */
CloseShieldInputStream(InputStream in)39     public CloseShieldInputStream(InputStream in) {
40         super(in);
41     }
42 
43     /**
44      * Replaces the underlying input stream with a {@link ClosedInputStream}
45      * sentinel. The original input stream will remain open, but this proxy
46      * will appear closed.
47      */
close()48     public void close() {
49         in = new ClosedInputStream();
50     }
51 
52 }
53