org.codehaus.mojo.license

Enum FileState

java.lang.Object

java.lang.Enum<FileState>

org.codehaus.mojo.license.FileState

All Implemented Interfaces:

Serializable, Comparable<FileState>

public enum FileState
extends Enum<FileState>

Defines state of a file after process.

Since:

1.0

Author:

tchemit dev@tchemit.fr

Enum Constant Summary

Enum Constants

Enum Constant and Description
add something was added on file
fail treatment failed for file
ignore file was ignored
remove something was removed from file
update file was updated
uptodate file was up to date

Method Summary

Modifier and Type	Method and Description
void	addFile(File file, EnumMap<FileState,Set<File>> results) Register a file for this state on result dictionary.
static FileState	valueOf(String name) Returns the enum constant of this type with the specified name.
static FileState[]	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

update

public static final FileState update

file was updated

uptodate

public static final FileState uptodate

file was up to date

add

public static final FileState add

something was added on file

remove

public static final FileState remove

something was removed from file

ignore

public static final FileState ignore

file was ignored

fail

public static final FileState fail

treatment failed for file

Method Detail

values

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

Returns:

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

valueOf

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

addFile

public void addFile(File file,
                    EnumMap<FileState,Set<File>> results)

Register a file for this state on result dictionary.

Parameters:

file - file to add

results - dictionary to update