gov.nasa.pds.transform.commandline.options
Enum Flag

java.lang.Object
  extended by java.lang.Enum<Flag>
      extended by gov.nasa.pds.transform.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
ALL
           
CONFIG
          Flag to specify a configuration file to configure the tool behavior.
DATAFILE
          Flag to specify the data file(s) to transform.
FORMAT
           
HELP
          Flag to display the help.
INDEX
          Flag to specify the index of the image or table to transform.
LOCAL
          Flag that disables recursion when traversing a target directory.
OBJECTS
          Flag to display a list of images and tables found within a given label.
OUTPUTDIR
           
REGEXP
          Flag to specify file patterns to look for when validating a target directory.
REPORT
          Flag to specify a report file name.
TARGET
          Flag to explicitly specify the target to validate.
VERBOSE
          Flag to specify the severity level and above to include in the report.
VERSION
          Displays the tool version.
 
Method Summary
 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.
static org.apache.commons.cli.Options getOptions()
          Get the command-line options.
 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

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.


HELP

public static final Flag HELP
Flag to display the help.


REPORT

public static final Flag REPORT
Flag to specify a report file name.


TARGET

public static final Flag TARGET
Flag to explicitly specify the target to validate.


OUTPUTDIR

public static final Flag OUTPUTDIR

FORMAT

public static final Flag FORMAT

VERBOSE

public static final Flag VERBOSE
Flag to specify the severity level and above to include in the report.


LOCAL

public static final Flag LOCAL
Flag that disables recursion when traversing a target directory.


VERSION

public static final Flag VERSION
Displays the tool version.


INDEX

public static final Flag INDEX
Flag to specify the index of the image or table to transform.


DATAFILE

public static final Flag DATAFILE
Flag to specify the data file(s) to transform.


ALL

public static final Flag ALL

OBJECTS

public static final Flag OBJECTS
Flag to display a list of images and tables found within a given label. Additionally,

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.

getOptions

public static org.apache.commons.cli.Options getOptions()
Get the command-line options.

Returns:
A class representation of the command-line options.


Copyright © 2010–2015 Planetary Data System. All rights reserved.