org.apache.creadur.whisker.app

Enum Act

java.lang.Object

java.lang.Enum<Act>

org.apache.creadur.whisker.app.Act

All Implemented Interfaces:

Serializable, Comparable<Act>

public enum Act
extends Enum<Act>

An operation to be performed by Whisker.

Enum Constant Summary

Enum Constants

Enum Constant and Description
AUDIT Validate contents against meta-data.
GENERATE Generate legal documentation.
REPORT Writes report on directories.
SKELETON Outlines the directory structure.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	isSourceRequired() Is source required for this operation?
static Act	valueOf(String name) Returns the enum constant of this type with the specified name.
static Act[]	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

GENERATE

public static final Act GENERATE

Generate legal documentation.

AUDIT

public static final Act AUDIT

Validate contents against meta-data.

REPORT

public static final Act REPORT

Writes report on directories.

SKELETON

public static final Act SKELETON

Outlines the directory structure.

Method Detail

values

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

Returns:

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

valueOf

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

isSourceRequired

public boolean isSourceRequired()

Is source required for this operation?

Returns:

true when the source is required, false otherwise