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
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
- 
Nested Class SummaryNested classes/interfaces inherited from class org.apache.commons.io.input.ProxyInputStreamProxyInputStream.AbstractBuilder<T,B extends AbstractStreamBuilder<T, B>> 
- 
Field SummaryFields inherited from class java.io.FilterInputStreamin
- 
Constructor SummaryConstructorsConstructorDescriptionCloseShieldInputStream(InputStream inputStream) Deprecated.Using this constructor prevents IDEs from warning if the underlying input stream is never closed.
- 
Method SummaryModifier and TypeMethodDescriptionvoidclose()Replaces the underlying input stream with aClosedInputStreamsentinel.static InputStreamsystemIn(InputStream inputStream) Constructs a proxy that only shieldsSystem.infrom closing.static CloseShieldInputStreamwrap(InputStream inputStream) Constructs a proxy that shields the given input stream from being closed.Methods inherited from class org.apache.commons.io.input.ProxyInputStreamafterRead, available, beforeRead, handleIOException, mark, markSupported, read, read, read, reset, setReference, skip, unwrap
- 
Constructor Details- 
CloseShieldInputStreamDeprecated.Using this constructor prevents IDEs from warning if the underlying input stream is never closed. Usewrap(InputStream)instead.Constructs a proxy that shields the given input stream from being closed.- Parameters:
- inputStream- underlying input stream
 
 
- 
- 
Method Details- 
systemInConstructs a proxy that only shieldsSystem.infrom closing.- Parameters:
- inputStream- the candidate input stream.
- Returns:
- the given stream or a proxy on System.in.
- Since:
- 2.17.0
 
- 
wrapConstructs 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
 
- 
closeReplaces the underlying input stream with aClosedInputStreamsentinel. The original input stream will remain open, but this proxy will appear closed.- Specified by:
- closein interface- AutoCloseable
- Specified by:
- closein interface- Closeable
- Overrides:
- closein class- ProxyInputStream
 
 
-