Enum Flag
- java.lang.Object
-
- java.lang.Enum<Flag>
-
- gov.nasa.pds.citool.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, hyunlee
-
-
Enum Constant Summary
Enum Constants Enum Constant Description ALIAS
Flag to enable aliasing.ALLREFS
Flag to specify the allrefs dictionary support file.CONFIG
Specify a configuration file.DOC_CONFIG
HELP
Flag to display the help.INCLUDES
Flag to specify the path(s) to search for file references.LOCAL
Flag to not traverse a directory.MODE
Flag to specify the tool mode.OUTPUT_DIR
PDSDD
Specify the PDS data dictionary files.REPORT
Flag to specify the report file.TARGET
Flag to explicitly specify the targets.VERBOSE
Flag to specify the severity level.VERSION
Flag to display the version.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method 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.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.
-
-
-
Enum Constant Detail
-
ALIAS
public static final Flag ALIAS
Flag to enable aliasing.
-
ALLREFS
public static final Flag ALLREFS
Flag to specify the allrefs dictionary support file.
-
CONFIG
public static final Flag CONFIG
Specify a configuration file.
-
DOC_CONFIG
public static final Flag DOC_CONFIG
-
PDSDD
public static final Flag PDSDD
Specify the PDS data dictionary files.
-
MODE
public static final Flag MODE
Flag to specify the tool mode.
-
INCLUDES
public static final Flag INCLUDES
Flag to specify the path(s) to search for file references.
-
LOCAL
public static final Flag LOCAL
Flag to not traverse a directory.
-
OUTPUT_DIR
public static final Flag OUTPUT_DIR
-
TARGET
public static final Flag TARGET
Flag to explicitly specify the targets.
-
REPORT
public static final Flag REPORT
Flag to specify the report file.
-
VERBOSE
public static final Flag VERBOSE
Flag to specify the severity level.
-
HELP
public static final Flag HELP
Flag to display the help.
-
VERSION
public static final Flag VERSION
Flag to display the version.
-
-
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 nameNullPointerException
- 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.
-
-