Module org.refcodes.filesystem

Package org.refcodes.filesystem

Class FileSystemException.FileException

java.lang.Object

java.lang.Throwable

java.lang.Exception

org.refcodes.exception.AbstractException

org.refcodes.filesystem.FileSystemException

org.refcodes.filesystem.FileSystemException.FileException

All Implemented Interfaces:

Serializable, org.refcodes.exception.ErrorCodeAccessor, org.refcodes.exception.Trap, FileHandleAccessor

Direct Known Subclasses:

ConcurrentAccessException, FileSystemException.FileException.NoAccessException, IllegalFileException, UnknownFileException

Enclosing class:

FileSystemException

protected abstract static class FileSystemException.FileException
extends FileSystemException
implements FileHandleAccessor

The Class FileSystemException.FileException.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	FileSystemException.FileException.NoAccessException	The Class FileSystemException.FileException.NoAccessException.

Nested classes/interfaces inherited from class org.refcodes.filesystem.FileSystemException

FileSystemException.FileException, FileSystemException.KeyException, FileSystemException.NameException, FileSystemException.NoFileSystemAccessException, FileSystemException.PathException

Nested classes/interfaces inherited from interface org.refcodes.exception.ErrorCodeAccessor

org.refcodes.exception.ErrorCodeAccessor.ErrorCodeBuilder<B extends org.refcodes.exception.ErrorCodeAccessor.ErrorCodeBuilder<B>>, org.refcodes.exception.ErrorCodeAccessor.ErrorCodeMutator, org.refcodes.exception.ErrorCodeAccessor.ErrorCodeProperty

Nested classes/interfaces inherited from interface org.refcodes.filesystem.FileHandleAccessor

FileHandleAccessor.FileHandleBuilder<B extends FileHandleAccessor.FileHandleBuilder<B>>, FileHandleAccessor.FileHandleMutator, FileHandleAccessor.FileHandleProperty

Field Summary

Fields

Modifier and Type	Field	Description
protected FileHandle	_fileHandle

Constructor Summary

Constructors

Constructor	Description
FileException(String aMessage, FileHandle aFileHandle)
FileException(String aMessage, FileHandle aFileHandle, String aErrorCode)
FileException(String aMessage, FileHandle aFileHandle, Throwable aCause)
FileException(String aMessage, FileHandle aFileHandle, Throwable aCause, String aErrorCode)
FileException(FileHandle aFileHandle, Throwable aCause)
FileException(FileHandle aFileHandle, Throwable aCause, String aErrorCode)

Method Summary

Modifier and Type	Method	Description
FileHandle	getFileHandle()	Retrieves the file handle from the file property.
Object[]	getPatternArguments()

Methods inherited from class org.refcodes.exception.AbstractException

getErrorCode, getMessage

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.refcodes.exception.Trap

toLocalizedMessage, toMessage, toMessage, toMessage, toShortLocalizedMessage, toShortMessage

Field Details

_fileHandle

protected FileHandle _fileHandle

Constructor Details

FileException

public FileException(String aMessage,
 FileHandle aFileHandle,
 String aErrorCode)

Parameters:

aFileHandle - The file (handle) involved in this exception.

FileException

public FileException(String aMessage,
 FileHandle aFileHandle,
 Throwable aCause,
 String aErrorCode)

Parameters:

aFileHandle - The file (handle) involved in this exception.

FileException

public FileException(String aMessage,
 FileHandle aFileHandle,
 Throwable aCause)

Parameters:

aFileHandle - The file (handle) involved in this exception.

FileException

public FileException(String aMessage,
 FileHandle aFileHandle)

Parameters:

aFileHandle - The file (handle) involved in this exception.

FileException

public FileException(FileHandle aFileHandle,
 Throwable aCause,
 String aErrorCode)

Parameters:

aFileHandle - The file (handle) involved in this exception.

FileException

public FileException(FileHandle aFileHandle,
 Throwable aCause)

Parameters:

aFileHandle - The file (handle) involved in this exception.

Method Details

getFileHandle

public FileHandle getFileHandle()

Retrieves the file handle from the file property.

Specified by:

getFileHandle in interface FileHandleAccessor

Returns:

The file handle stored by the file handle property.

getPatternArguments

public Object[] getPatternArguments()

Specified by:

getPatternArguments in interface org.refcodes.exception.Trap