com.helger.commons.io.file

Enum EFileIOErrorCode

java.lang.Object

java.lang.Enum<EFileIOErrorCode>

com.helger.commons.io.file.EFileIOErrorCode

All Implemented Interfaces:

IHasIntID, ISuccessIndicator, Serializable, Comparable<EFileIOErrorCode>

public enum EFileIOErrorCode
extends Enum<EFileIOErrorCode>
implements ISuccessIndicator, IHasIntID

Represents a set of predefined error codes that can occur in file operations.

Author:

Philip Helger

Enum Constant Summary

Enum Constants

Enum Constant and Description
IO_ERROR Generic IO code: an IOException occurred.
NO_ERROR Generic error code: no error.
OBJECT_CANNOT_BE_HANDLED We stumble across an object that is neither a file nor a directory.
OBJECT_HAS_NO_PARENT An object's parent could not be retrieved.
OPERATION_FAILED Generic error code: operation failed but we don't know why.
SECURITY_ERROR Generic error code: a SecurityException occurred.
SOURCE_DOES_NOT_EXIST A source file or directory does not exist.
SOURCE_EQUALS_TARGET Source and destination object are identical.
SOURCE_NOT_READABLE The source object cannot be read.
SOURCE_PARENT_NOT_WRITABLE The source parent object is read-only (not writable).
TARGET_ALREADY_EXISTS A destination file or directory already exists.
TARGET_IS_CHILD_OF_SOURCE Avoid recursive dependencies.
TARGET_PARENT_NOT_WRITABLE The target parent object is read-only (not writable).

Method Summary

Modifier and Type	Method and Description
FileIOError	getAsIOError(EFileIOOperation eOperation, File aFile) Use this error code to create a new FileIOError instance.
FileIOError	getAsIOError(EFileIOOperation eOperation, File aFile1, File aFile2) Use this error code to create a new FileIOError instance.
static FileIOError	getAsIOError(EFileIOOperation eOperation, IOException ex) Static method to create a FileIOError for an IOException.
FileIOError	getAsIOError(EFileIOOperation eOperation, Path aPath) Use this error code to create a new FileIOError instance.
FileIOError	getAsIOError(EFileIOOperation eOperation, Path aFile1, Path aFile2) Use this error code to create a new FileIOError instance.
static FileIOError	getAsIOError(EFileIOOperation eOperation, UncheckedIOException ex) Static method to create a FileIOError for an UncheckedIOException.
static EFileIOErrorCode	getFromIDOrNull(int nID)
int	getID() An internal ID for easier referencing.
static FileIOError	getSecurityAsIOError(EFileIOOperation eOperation, SecurityException ex) Static method to create a FileIOError for a SecurityException.
boolean	isSuccess()
static EFileIOErrorCode	valueOf(String name) Returns the enum constant of this type with the specified name.
static EFileIOErrorCode[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.helger.commons.state.ISuccessIndicator

and, isFailure, or

Methods inherited from interface com.helger.commons.id.IHasIntID

getComparatorID, getIDObj

Enum Constant Detail

NO_ERROR

public static final EFileIOErrorCode NO_ERROR

Generic error code: no error.

OPERATION_FAILED

public static final EFileIOErrorCode OPERATION_FAILED

Generic error code: operation failed but we don't know why.

SECURITY_ERROR

public static final EFileIOErrorCode SECURITY_ERROR

Generic error code: a SecurityException occurred.

SOURCE_DOES_NOT_EXIST

public static final EFileIOErrorCode SOURCE_DOES_NOT_EXIST

A source file or directory does not exist.

TARGET_ALREADY_EXISTS

public static final EFileIOErrorCode TARGET_ALREADY_EXISTS

A destination file or directory already exists.

SOURCE_EQUALS_TARGET

public static final EFileIOErrorCode SOURCE_EQUALS_TARGET

Source and destination object are identical.

TARGET_IS_CHILD_OF_SOURCE

public static final EFileIOErrorCode TARGET_IS_CHILD_OF_SOURCE

Avoid recursive dependencies.

OBJECT_CANNOT_BE_HANDLED

public static final EFileIOErrorCode OBJECT_CANNOT_BE_HANDLED

We stumble across an object that is neither a file nor a directory.

OBJECT_HAS_NO_PARENT

public static final EFileIOErrorCode OBJECT_HAS_NO_PARENT

An object's parent could not be retrieved.

SOURCE_NOT_READABLE

public static final EFileIOErrorCode SOURCE_NOT_READABLE

The source object cannot be read.

SOURCE_PARENT_NOT_WRITABLE

public static final EFileIOErrorCode SOURCE_PARENT_NOT_WRITABLE

The source parent object is read-only (not writable).

TARGET_PARENT_NOT_WRITABLE

public static final EFileIOErrorCode TARGET_PARENT_NOT_WRITABLE

The target parent object is read-only (not writable).

IO_ERROR

public static final EFileIOErrorCode IO_ERROR

Generic IO code: an IOException occurred.

Method Detail

values

public static EFileIOErrorCode[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (EFileIOErrorCode c : EFileIOErrorCode.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static EFileIOErrorCode valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getID

@Nonnegative
public int getID()

An internal ID for easier referencing. NO_ERROR has ID 0. All errors have positive numbers.

Specified by:

getID in interface IHasIntID

Returns:

The primitive int ID of this object.

getAsIOError

@Nonnull
public FileIOError getAsIOError(@Nonnull
                                          EFileIOOperation eOperation,
                                          @Nonnull
                                          File aFile)

Use this error code to create a new FileIOError instance.

Parameters:

eOperation - The operation carried out. May not be null.

aFile - The file on which operation was carried out. May not be null.

Returns:

The new FileIOError and never null.

getAsIOError

@Nonnull
public FileIOError getAsIOError(@Nonnull
                                          EFileIOOperation eOperation,
                                          @Nonnull
                                          Path aPath)

Use this error code to create a new FileIOError instance.

Parameters:

eOperation - The operation carried out. May not be null.

aPath - The path on which operation was carried out. May not be null.

Returns:

The new FileIOError and never null.

getAsIOError

@Nonnull
public FileIOError getAsIOError(@Nonnull
                                          EFileIOOperation eOperation,
                                          @Nonnull
                                          File aFile1,
                                          @Nonnull
                                          File aFile2)

Use this error code to create a new FileIOError instance.

Parameters:

eOperation - The operation carried out. May not be null.

aFile1 - The first file on which operation was carried out. May not be null.

aFile2 - The second file on which operation was carried out. May not be null.

Returns:

The new FileIOError and never null.

getAsIOError

@Nonnull
public FileIOError getAsIOError(@Nonnull
                                          EFileIOOperation eOperation,
                                          @Nonnull
                                          Path aFile1,
                                          @Nonnull
                                          Path aFile2)

Use this error code to create a new FileIOError instance.

Parameters:

eOperation - The operation carried out. May not be null.

aFile1 - The first file on which operation was carried out. May not be null.

aFile2 - The second file on which operation was carried out. May not be null.

Returns:

The new FileIOError and never null.

isSuccess

public boolean isSuccess()

Specified by:

isSuccess in interface ISuccessIndicator

Returns:

true if this is NO_ERROR, false otherwise.

getSecurityAsIOError

@Nonnull
public static FileIOError getSecurityAsIOError(@Nonnull
                                                         EFileIOOperation eOperation,
                                                         @Nonnull
                                                         SecurityException ex)

Static method to create a FileIOError for a SecurityException.

Parameters:

eOperation - The performed operation. May not be null.

ex - The occurred SecurityException. Never null.

Returns:

The non-null FileIOError.

getAsIOError

@Nonnull
public static FileIOError getAsIOError(@Nonnull
                                                 EFileIOOperation eOperation,
                                                 @Nonnull
                                                 IOException ex)

Static method to create a FileIOError for an IOException.

Parameters:

eOperation - The performed operation. May not be null.

ex - The occurred IOException. Never null.

Returns:

The non-null FileIOError.

getAsIOError

@Nonnull
public static FileIOError getAsIOError(@Nonnull
                                                 EFileIOOperation eOperation,
                                                 @Nonnull
                                                 UncheckedIOException ex)

Static method to create a FileIOError for an UncheckedIOException.

Parameters:

eOperation - The performed operation. May not be null.

ex - The occurred UncheckedIOException. Never null.

Returns:

The non-null FileIOError.

getFromIDOrNull

@Nullable
public static EFileIOErrorCode getFromIDOrNull(int nID)