org.apache.commons.vfs2

Class FileSystemException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.io.IOException

org.apache.commons.vfs2.FileSystemException

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

FileNotFolderException, FileNotFoundException, FileTypeHasNoContentException

public class FileSystemException
extends IOException

Thrown for file system errors.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
FileSystemException(String code) Constructs exception with the specified detail message.
FileSystemException(String code, Object... info) Constructs exception with the specified detail message.
FileSystemException(String code, Object info) Constructs exception with the specified detail message.
FileSystemException(String code, Object[] info, Throwable cause) Deprecated. Use instead FileSystemException(String, Throwable, Object[]). Will be removed in 3.0.
FileSystemException(String code, Object info, Throwable cause) Constructs exception with the specified detail message and cause.
FileSystemException(String code, Throwable cause) Constructs exception with the specified detail message.
FileSystemException(String code, Throwable cause, Object... info) Constructs exception with the specified detail message.
FileSystemException(Throwable cause) Constructs wrapper exception.

Method Summary

Modifier and Type	Method and Description
String	getCode() Retrieves error code of the exception.
String[]	getInfo() Retrieves array of complementary info (context).
String	getMessage() Retrieves message from bundle.
static <T> T	requireNonNull(T obj, String code) Throws a FileSystemException when the given object is null.
static <T> T	requireNonNull(T obj, String code, Object... info) Throws a FileSystemException when the given object is null.

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

Constructor Detail

FileSystemException

public FileSystemException(String code)

Constructs exception with the specified detail message.

Parameters:

code - the error code of the message.

FileSystemException

public FileSystemException(String code,
                           Object info)

Constructs exception with the specified detail message.

Parameters:

code - the error code of the message.

info - one context information.

FileSystemException

public FileSystemException(String code,
                           Object... info)

Constructs exception with the specified detail message.

Parameters:

code - the error code of the message.

info - array of complementary info (context).

FileSystemException

public FileSystemException(String code,
                           Object info,
                           Throwable cause)

Constructs exception with the specified detail message and cause.

Parameters:

code - the error code of the message.

info - one context information.

cause - the cause.

FileSystemException

@Deprecated
public FileSystemException(String code,
                                       Object[] info,
                                       Throwable cause)

Deprecated. Use instead FileSystemException(String, Throwable, Object[]). Will be removed in 3.0.

Constructs exception with the specified detail message.

Parameters:

code - the error code of the message.

info - array of complementary info (context).

cause - the cause.

FileSystemException

public FileSystemException(String code,
                           Throwable cause)

Constructs exception with the specified detail message.

Parameters:

code - the error code of the message.

cause - the original cause

FileSystemException

public FileSystemException(String code,
                           Throwable cause,
                           Object... info)

Constructs exception with the specified detail message.

Parameters:

code - the error code of the message.

info - array of complementary info (context).

cause - the cause.

FileSystemException

public FileSystemException(Throwable cause)

Constructs wrapper exception.

Parameters:

cause - the root cause to wrap.

Method Detail

requireNonNull

public static <T> T requireNonNull(T obj,
                                   String code)
                            throws FileSystemException

Throws a FileSystemException when the given object is null.

Type Parameters:

T - the type of the reference

Parameters:

obj - the object reference to check for null.

code - message used when FileSystemException is thrown

Returns:

obj if not null

Throws:

FileSystemException - if obj is null

Since:

2.3

requireNonNull

public static <T> T requireNonNull(T obj,
                                   String code,
                                   Object... info)
                            throws FileSystemException

Throws a FileSystemException when the given object is null.

Type Parameters:

T - the type of the reference

Parameters:

obj - the object reference to check for null.

code - message used when FileSystemException is thrown

info - one context information.

Returns:

obj if not null

Throws:

FileSystemException - if obj is null

Since:

2.3

getCode

public String getCode()

Retrieves error code of the exception. Could be used as key for internationalization.

Returns:

the code.

getInfo

public String[] getInfo()

Retrieves array of complementary info (context). Could be used as parameter for internationalization.

Returns:

the context info.

getMessage

public String getMessage()

Retrieves message from bundle.

Overrides:

getMessage in class Throwable

Returns:

The exception message.