Package org.apache.commons.io.input

Class CloseShieldInputStream

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
void	close()	Replaces the underlying input stream with a ClosedInputStream sentinel.
static CloseShieldInputStream	wrap(InputStream inputStream)	Constructs a proxy that shields the given input stream from being closed.

Methods inherited from class org.apache.commons.io.input.ProxyInputStream

available, mark, markSupported, read, read, read, reset, skip, unwrap

Methods inherited from class java.io.InputStream

nullInputStream, readAllBytes, readNBytes, readNBytes, skipNBytes, transferTo

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

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.

Constructs a proxy that shields the given input stream from being closed.

Parameters:

inputStream - underlying input stream

Method Details

wrap

public static CloseShieldInputStream wrap(InputStream inputStream)

Constructs 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 AutoCloseable

Specified by:

close in interface Closeable

Overrides:

close in class ProxyInputStream