de.schlichtherle.io.archive.spi
Class TransientIOException

java.lang.Object
  java.lang.Throwable
      java.lang.Exception
          java.io.IOException
              de.schlichtherle.io.archive.spi.TransientIOException

All Implemented Interfaces:

Serializable

public final class TransientIOException
extends IOException

May be thrown by archive drivers to indicate that an IOException occured as a transient event when accessing an archive file and another try to access the same archive file may finally succeed. On the other hand, if the archive controller catches an IOException from an an archive driver when trying to access an archive file which is not a TransientIOException, then the archive controller may consider the archive file to be a false positive and cache the exception until File.umount() or File.update() is called.

This feature is primarily used by the RAES encrypted ZIP file driver family when prompting for passwords has been cancelled by the user. In this case, the driver will wrap the IOException in a TransientIOException and throw this instead to signal that another attempt to prompt the user should be allowed.

This class is marked final since the archive controller will throw away this exception anyway and deal with the transient cause only.

Since:

TrueZIP 6.4

Version:

$Id: TransientIOException.java,v 1.4 2010/08/20 13:09:48 christian_schlichtherle Exp $

Author:

Christian Schlichtherle

See Also:

Serialized Form

Constructor Summary

TransientIOException(IOException cause)

Method Summary

IOException

getTransientCause() Returns the transient cause of this exception as an IOException - null is never returned.

Methods inherited from class java.lang.Throwable

fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

TransientIOException

public TransientIOException(IOException cause)

Parameters:

cause - The transient cause of this exception.

Throws:

NullPointerException - If cause is null.

Method Detail

getTransientCause

public IOException getTransientCause()

Returns the transient cause of this exception as an IOException - null is never returned.