org.jppf.doc
Enum ParameterNames

java.lang.Object
  java.lang.Enum<ParameterNames>
      org.jppf.doc.ParameterNames

All Implemented Interfaces:

Serializable, Comparable<ParameterNames>

public enum ParameterNames
extends Enum<ParameterNames>

Author:

Laurent Cohen

Enum Constant Summary

DEST_DIR
Name for the destination directory.

DIR_EXCLUDES
Name for the directory excludes.

DIR_INCLUDES
Name for the directory includes.

FILE_EXCLUDES
Name for the file excludes.

FILE_INCLUDES
Name for the file includes.

RECURSIVE
Name for the recursive directory processing flag.

SOURCE_DIR
Name for the source directory.

TEMPLATES_DIR
Name for the templates directory.

Method Summary

static ParameterNames	valueOf(String name) Returns the enum constant of this type with the specified name.
static ParameterNames[]	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

SOURCE_DIR

public static final ParameterNames SOURCE_DIR

Name for the source directory.

DEST_DIR

public static final ParameterNames DEST_DIR

Name for the destination directory.

TEMPLATES_DIR

public static final ParameterNames TEMPLATES_DIR

Name for the templates directory.

FILE_INCLUDES

public static final ParameterNames FILE_INCLUDES

Name for the file includes.

FILE_EXCLUDES

public static final ParameterNames FILE_EXCLUDES

Name for the file excludes.

DIR_INCLUDES

public static final ParameterNames DIR_INCLUDES

Name for the directory includes.

DIR_EXCLUDES

public static final ParameterNames DIR_EXCLUDES

Name for the directory excludes.

RECURSIVE

public static final ParameterNames RECURSIVE

Name for the recursive directory processing flag.

Method Detail

values

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

Returns:

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

valueOf

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