View Javadoc

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.tika.io;
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   * @since Apache Tika 0.4, copied from Commons IO 1.4
29   */
30  public class CloseShieldInputStream extends ProxyInputStream {
31  
32      /**
33       * Creates a proxy that shields the given input stream from being
34       * closed.
35       *
36       * @param in underlying input stream
37       */
38      public CloseShieldInputStream(InputStream in) {
39          super(in);
40      }
41  
42      /**
43       * Replaces the underlying input stream with a {@link ClosedInputStream}
44       * sentinel. The original input stream will remain open, but this proxy
45       * will appear closed.
46       */
47      @Override
48      public void close() {
49          in = new ClosedInputStream();
50      }
51  
52  }