Package org.apache.commons.io.input
Class MarkShieldInputStream
java.lang.Object
java.io.InputStream
java.io.FilterInputStream
org.apache.commons.io.input.ProxyInputStream
org.apache.commons.io.input.MarkShieldInputStream
- All Implemented Interfaces:
Closeable,AutoCloseable
This is an alternative to
ByteArrayInputStream
which removes the synchronization overhead for non-concurrent
access; as such this class is not thread-safe.
Proxy stream that prevents the underlying input stream from being marked/reset.
This class is typically used in cases where an input stream that supports marking needs to be passed to a component that wants to explicitly mark the stream, but it is not desirable to allow marking of the stream.
- Since:
- 2.8.0
-
Nested Class Summary
Nested classes/interfaces inherited from class org.apache.commons.io.input.ProxyInputStream
ProxyInputStream.AbstractBuilder<T,B extends AbstractStreamBuilder<T, B>> -
Field Summary
Fields inherited from class java.io.FilterInputStream
in -
Constructor Summary
ConstructorsConstructorDescriptionConstructs a proxy that shields the given input stream from being marked or rest. -
Method Summary
Modifier and TypeMethodDescriptionvoidmark(int readLimit) Invokes the delegate'sInputStream.mark(int)method.booleanInvokes the delegate'sInputStream.markSupported()method.voidreset()Invokes the delegate'sInputStream.reset()method.Methods inherited from class org.apache.commons.io.input.ProxyInputStream
afterRead, available, beforeRead, close, handleIOException, read, read, read, setReference, skip, unwrap
-
Constructor Details
-
MarkShieldInputStream
Constructs a proxy that shields the given input stream from being marked or rest.- Parameters:
in- underlying input stream
-
-
Method Details
-
mark
Description copied from class:ProxyInputStreamInvokes the delegate'sInputStream.mark(int)method.- Overrides:
markin classProxyInputStream- Parameters:
readLimit- read ahead limit.
-
markSupported
Description copied from class:ProxyInputStreamInvokes the delegate'sInputStream.markSupported()method.- Overrides:
markSupportedin classProxyInputStream- Returns:
trueif this stream instance supports the mark and reset methods;falseotherwise.- See Also:
-
reset
Description copied from class:ProxyInputStreamInvokes the delegate'sInputStream.reset()method.- Overrides:
resetin classProxyInputStream- Throws:
IOException- if this stream has not been marked or if the mark has been invalidated.
-