Package org.apache.commons.io.output
Class TaggedWriter
java.lang.Object
java.io.Writer
java.io.FilterWriter
org.apache.commons.io.output.ProxyWriter
org.apache.commons.io.output.TaggedWriter
- All Implemented Interfaces:
- Closeable,- Flushable,- Appendable,- AutoCloseable
A writer decorator that tags potential exceptions so that the
 reader 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.
 
 TaggedReader reader = new TaggedReader(...);
 try {
     // Processing that may throw an IOException either from this reader
     // or from some other IO activity like temporary files, etc.
     writeToWriter(writer);
 } catch (IOException e) {
     if (writer.isCauseOf(e)) {
         // The exception was caused by this writer.
         // Use e.getCause() to get the original exception.
     } else {
         // The exception was caused by something else.
     }
 }
 
 
 Alternatively, the throwIfCauseOf(Exception) method can be
 used to let higher levels of code handle the exception caused by this
 writer while other processing errors are being taken care of at this
 lower level.
 
 TaggedWriter writer = new TaggedWriter(...);
 try {
     writeToWriter(writer);
 } catch (IOException e) {
     writer.throwIfCauseOf(e);
     // ... or process the exception that was caused by something else
 }
 - Since:
- 2.0
- See Also:
- 
Field SummaryFields inherited from class java.io.FilterWriterout
- 
Constructor SummaryConstructorsConstructorDescriptionTaggedWriter(Writer proxy) Constructs a tagging decorator for the given writer.
- 
Method SummaryModifier and TypeMethodDescriptionprotected voidTags any IOExceptions thrown, wrapping and re-throwing.booleanTests if the given exception was caused by this writer.voidthrowIfCauseOf(Exception exception) Re-throws the original exception thrown by this writer.Methods inherited from class org.apache.commons.io.output.ProxyWriterafterWrite, append, append, append, beforeWrite, close, flush, write, write, write, write, write
- 
Constructor Details- 
TaggedWriterConstructs a tagging decorator for the given writer.- Parameters:
- proxy- writer to be decorated
 
 
- 
- 
Method Details- 
handleIOExceptionTags any IOExceptions thrown, wrapping and re-throwing.- Overrides:
- handleIOExceptionin class- ProxyWriter
- Parameters:
- e- The IOException thrown
- Throws:
- IOException- if an I/O error occurs.
 
- 
isCauseOfTests if the given exception was caused by this writer.- Parameters:
- exception- an exception
- Returns:
- trueif the exception was thrown by this writer,- falseotherwise
 
- 
throwIfCauseOfRe-throws the original exception thrown by this writer. 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 writer.- Parameters:
- exception- an exception
- Throws:
- IOException- original exception, if any, thrown by this writer
 
 
-