Package com.helger.commons.io.file

Class FileIOError

java.lang.Object

com.helger.commons.io.file.FileIOError

All Implemented Interfaces:

ISuccessIndicator, Serializable

@Immutable
public class FileIOError
extends Object
implements ISuccessIndicator, Serializable

Represents an error with an additional error object.

Author:

Philip Helger

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
FileIOError(EFileIOOperation eOperation, EFileIOErrorCode eCode)
FileIOError(EFileIOOperation eOperation, EFileIOErrorCode eCode, File aFile1)
FileIOError(EFileIOOperation eOperation, EFileIOErrorCode eCode, File aFile1, File aFile2)
FileIOError(EFileIOOperation eOperation, EFileIOErrorCode eCode, File aFile1, File aFile2, Exception aException)
FileIOError(EFileIOOperation eOperation, EFileIOErrorCode eCode, Exception aException)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
EFileIOErrorCode	getErrorCode()
Exception	getException()
File	getFile1()
File	getFile2()
EFileIOOperation	getOperation()
boolean	hasException()
boolean	hasFile1()
boolean	hasFile2()
int	hashCode()
boolean	isSuccess()
String	toString()
FileIOError	withoutErrorCode()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

and, isFailure, or

Constructor Detail

FileIOError

public FileIOError(@Nonnull
                   EFileIOOperation eOperation,
                   @Nonnull
                   EFileIOErrorCode eCode)

FileIOError

public FileIOError(@Nonnull
                   EFileIOOperation eOperation,
                   @Nonnull
                   EFileIOErrorCode eCode,
                   @Nonnull
                   File aFile1)

FileIOError

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

FileIOError

public FileIOError(@Nonnull
                   EFileIOOperation eOperation,
                   @Nonnull
                   EFileIOErrorCode eCode,
                   @Nonnull
                   Exception aException)

FileIOError

public FileIOError(@Nonnull
                   EFileIOOperation eOperation,
                   @Nonnull
                   EFileIOErrorCode eCode,
                   @Nullable
                   File aFile1,
                   @Nullable
                   File aFile2,
                   @Nullable
                   Exception aException)

Method Detail

getOperation

@Nonnull
public EFileIOOperation getOperation()

Returns:

The operation passed in the constructor. Never null.

getErrorCode

@Nonnull
public EFileIOErrorCode getErrorCode()

Returns:

The error code passed in the constructor. Never null.

isSuccess

public boolean isSuccess()

Specified by:

isSuccess in interface ISuccessIndicator

Returns:

true on success and false on failure.

getFile1

@Nullable
public File getFile1()

Returns:

The first file relevant to this error. May be null.

hasFile1

public boolean hasFile1()

Returns:

true if the first file is present, false if not.

getFile2

@Nullable
public File getFile2()

Returns:

The second file relevant to this error. May be null. This field can only be present, if getFile1() is present.

hasFile2

public boolean hasFile2()

Returns:

true if the second file is present, false if not.

getException

@Nullable
public Exception getException()

Returns:

The exception passed in the constructor. May be null.

hasException

public boolean hasException()

Returns:

true if an exception is present, false if not.

withoutErrorCode

@Nonnull
public FileIOError withoutErrorCode()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object