gov.nasa.pds.validate.commandline.options

Enum Flag

java.lang.Object

java.lang.Enum<Flag>

gov.nasa.pds.validate.commandline.options.Flag

All Implemented Interfaces:

Serializable, Comparable<Flag>

public enum Flag
extends Enum<Flag>

Class that holds the command-line option flags.

Author:

mcayanan

Enum Constant Summary

Enum Constants

Enum Constant and Description
BASE_PATH
CATALOG
CHECKSUM_MANIFEST Flag to specify one or more checksum manifest files in order to perform checksum validation.
CONFIG Flag to specify a configuration file to configure the tool behavior.
FORCE Flag to force the tool to perform validation against the schema and schematron specified in a given label.
HELP Flag to display the help.
LOCAL Flag that disables recursion when traversing a target directory.
MODEL Flag to specify a model version to use during validation.
REGEXP Flag to specify file patterns to look for when validating a target directory.
REPORT Flag to specify a report file name.
RULE
SCHEMA Flag to specify a list of schemas to use during validation.
SCHEMATRON Flag to specify a list of schematron files to use during validation.
STYLE Flag to specify the report style.
TARGET Flag to explicitly specify the targets to validate.
VERBOSE Flag to specify the severity level and above to include in the report.
VERSION Displays the tool version.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	allowsMultipleArgs() Find out if the flag can handle multiple arguments.
String	getArgName() Get the argument name of the flag.
Object	getArgType() Get the argument type of the flag.
String	getDescription() Get the flag description.
String	getLongName() Get the long name of the flag.
String	getShortName() Get the short name of the flag.
static Flag	valueOf(String name) Returns the enum constant of this type with the specified name.
static Flag[]	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

BASE_PATH

public static final Flag BASE_PATH

CATALOG

public static final Flag CATALOG

CONFIG

public static final Flag CONFIG

Flag to specify a configuration file to configure the tool behavior.

REGEXP

public static final Flag REGEXP

Flag to specify file patterns to look for when validating a target directory.

FORCE

public static final Flag FORCE

Flag to force the tool to perform validation against the schema and schematron specified in a given label.

HELP

public static final Flag HELP

Flag to display the help.

LOCAL

public static final Flag LOCAL

Flag that disables recursion when traversing a target directory.

CHECKSUM_MANIFEST

public static final Flag CHECKSUM_MANIFEST

Flag to specify one or more checksum manifest files in order to perform checksum validation.

MODEL

public static final Flag MODEL

Flag to specify a model version to use during validation.

REPORT

public static final Flag REPORT

Flag to specify a report file name.

SCHEMATRON

public static final Flag SCHEMATRON

Flag to specify a list of schematron files to use during validation.

STYLE

public static final Flag STYLE

Flag to specify the report style.

TARGET

public static final Flag TARGET

Flag to explicitly specify the targets to validate.

VERSION

public static final Flag VERSION

Displays the tool version.

VERBOSE

public static final Flag VERBOSE

Flag to specify the severity level and above to include in the report.

SCHEMA

public static final Flag SCHEMA

Flag to specify a list of schemas to use during validation.

RULE

public static final Flag RULE

Method Detail

values

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

Returns:

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

valueOf

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

getShortName

public String getShortName()

Get the short name of the flag.

Returns:

The short name.

getLongName

public String getLongName()

Get the long name of the flag.

Returns:

The long name.

getArgName

public String getArgName()

Get the argument name of the flag.

Returns:

The argument name.

allowsMultipleArgs

public boolean allowsMultipleArgs()

Find out if the flag can handle multiple arguments.

Returns:

'true' if yes.

getArgType

public Object getArgType()

Get the argument type of the flag.

Returns:

The argument type.

getDescription

public String getDescription()

Get the flag description.

Returns:

The description.