Package org.apache.commons.io.input
Class TaggedInputStream
java.lang.Object
java.io.InputStream
java.io.FilterInputStream
org.apache.commons.io.input.ProxyInputStream
org.apache.commons.io.input.TaggedInputStream
- All Implemented Interfaces:
- Closeable,- AutoCloseable
An input stream decorator that tags potential exceptions so that the
 stream that caused the exception can easily be identified. This is
 done by using the 
TaggedIOException class to wrap all thrown
 IOExceptions. See below for an example of using this class.
 
 TaggedInputStream stream = new TaggedInputStream(...);
 try {
     // Processing that may throw an IOException either from this stream
     // or from some other IO activity like temporary files, etc.
     processStream(stream);
 } catch (IOException e) {
     if (stream.isCauseOf(e)) {
         // The exception was caused by this stream.
         // Use e.getCause() to get the original exception.
     } else {
         // The exception was caused by something else.
     }
 }
 
 
 Alternatively, the throwIfCauseOf(Throwable) method can be
 used to let higher levels of code handle the exception caused by this
 stream while other processing errors are being taken care of at this
 lower level.
 
 TaggedInputStream stream = new TaggedInputStream(...);
 try {
     processStream(stream);
 } catch (IOException e) {
     stream.throwIfCauseOf(e);
     // ... or process the exception that was caused by something else
 }
 
 Deprecating Serialization
Serialization is deprecated and will be removed in 3.0.
- Since:
- 2.0
- See Also:
- 
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 SummaryConstructorsConstructorDescriptionTaggedInputStream(InputStream proxy) Constructs a tagging decorator for the given input stream.
- 
Method SummaryModifier and TypeMethodDescriptionprotected voidTags any IOExceptions thrown, wrapping and re-throwing.booleanTests if the given exception was caused by this stream.voidthrowIfCauseOf(Throwable throwable) Re-throws the original exception thrown by this stream.Methods inherited from class org.apache.commons.io.input.ProxyInputStreamafterRead, available, beforeRead, close, mark, markSupported, read, read, read, reset, setReference, skip, unwrap
- 
Constructor Details- 
TaggedInputStreamConstructs a tagging decorator for the given input stream.- Parameters:
- proxy- input stream to be decorated
 
 
- 
- 
Method Details- 
handleIOExceptionTags any IOExceptions thrown, wrapping and re-throwing.- Overrides:
- handleIOExceptionin class- ProxyInputStream
- Parameters:
- e- The IOException thrown
- Throws:
- IOException- if an I/O error occurs.
 
- 
isCauseOfTests if the given exception was caused by this stream.- Parameters:
- exception- an exception
- Returns:
- trueif the exception was thrown by this stream,- falseotherwise
 
- 
throwIfCauseOfRe-throws the original exception thrown by this stream. This method first checks whether the given exception is aTaggedIOExceptionwrapper created by this decorator, and then unwraps and throws the original wrapped exception. Returns normally if the exception was not thrown by this stream.- Parameters:
- throwable- an exception
- Throws:
- IOException- original exception, if any, thrown by this stream
 
 
-