Package com.gengoai.io

Enum SaveMode

java.lang.Object

java.lang.Enum<SaveMode>

com.gengoai.io.SaveMode

All Implemented Interfaces:

Serializable, Comparable<SaveMode>

public enum SaveMode
extends Enum<SaveMode>

The enum Save mode.

Author:

David B. Bracewell

Enum Constant Summary

Enum Constants

Enum Constant	Description
ERROR	Throws an error if the directory / file exists
IGNORE	Ignores writing the corpus
OVERWRITE	Overwrites the file/directory

Method Summary

Modifier and Type	Method	Description
abstract boolean	validate(Resource resource)	Performs validation on the given resource to check if writing is possible
static SaveMode	valueOf(String name)	Returns the enum constant of this type with the specified name.
static SaveMode[]	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

Enum Constant Detail

ERROR

public static final SaveMode ERROR

Throws an error if the directory / file exists

IGNORE

public static final SaveMode IGNORE

Ignores writing the corpus

OVERWRITE

public static final SaveMode OVERWRITE

Overwrites the file/directory

Method Detail

values

public static SaveMode[] 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 (SaveMode c : SaveMode.values())
    System.out.println(c);

Returns:

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

valueOf

public static SaveMode 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

validate

public abstract boolean validate(Resource resource)
                          throws IOException

Performs validation on the given resource to check if writing is possible

Parameters:

resource - the resource to write to

Returns:

True if the corpus can be written

Throws:

IOException - Error in validation