Javadoc: CloseShieldInputStream (Apache Commons IO 2.11.0 API)

java.lang.Object
- java.io.InputStream
- - java.io.FilterInputStream
  - - org.apache.commons.io.input.ProxyInputStream
    - - org.apache.commons.io.input.CloseShieldInputStream

All Implemented Interfaces:

Closeable, AutoCloseable
```
public class CloseShieldInputStream
extends ProxyInputStream
```
Proxy stream that prevents the underlying input stream from being closed.
This class is typically used in cases where an input stream needs to be passed to a component that wants to explicitly close the stream even if more input would still be available to other components.

Since:

1.4

Field Summary
- Fields inherited from class java.io.FilterInputStream
  in

Constructor Summary

Constructors
Constructor and Description
`CloseShieldInputStream(InputStream inputStream)` Deprecated. Using this constructor prevents IDEs from warning if the underlying input stream is never closed. Use `wrap(InputStream)` instead.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`close()` Replaces the underlying input stream with a `ClosedInputStream` sentinel.
`static CloseShieldInputStream`	`wrap(InputStream inputStream)` Creates a proxy that shields the given input stream from being closed.

Methods inherited from class org.apache.commons.io.input.ProxyInputStream
afterRead, available, beforeRead, handleIOException, mark, markSupported, read, read, read, reset, skip

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - CloseShieldInputStream
```
@Deprecated
public CloseShieldInputStream(InputStream inputStream)
```
    Deprecated. Using this constructor prevents IDEs from warning if the underlying input stream is never closed. Use wrap(InputStream) instead.
    
    Creates a proxy that shields the given input stream from being closed.
    
    Parameters:
    
    inputStream - underlying input stream
- Method Detail
  - wrap
```
public static CloseShieldInputStream wrap(InputStream inputStream)
```
    Creates a proxy that shields the given input stream from being closed.
    
    Parameters:
    
    inputStream - the input stream to wrap
    
    Returns:
    
    the created proxy
    
    Since:
    
    2.9.0
  - close
```
public void close()
```
    Replaces the underlying input stream with a ClosedInputStream sentinel. The original input stream will remain open, but this proxy will appear closed.
    
    Specified by:
    
    close in interface Closeable
    
    Specified by:
    
    close in interface AutoCloseable
    
    Overrides:
    
    close in class ProxyInputStream

Copyright © 2002–2021 The Apache Software Foundation. All rights reserved.