Enum Flag
- java.lang.Object
-
- java.lang.Enum<Flag>
-
- gov.nasa.pds.harvest.search.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 Description CONFIG
Flag to specify a configuration file to configure the tool behavior.DOC_CONFIG
HELP
Flag to display the help.IGNOREDIR
Flag to specify patterns to look for when crawling a target directory for sub-directories to ignore.ISPDS3DIR
Flag to specify a PDS3 directory to crawl for harvesting.LOG
Flag to output the logging to a file.OUTPUT_DIR
PORT
Flag for the daemon port number to be used if running the tool continuously.REGEXP
Flag to specify file patterns to look for when validating a target directory.VERBOSE
Flag to change the severity level of the messaging in the report.VERSION
Flag to display the version.WAIT
Flag to specify the wait time in between crawls.
-
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
-
CONFIG
public static final Flag CONFIG
Flag to specify a configuration file to configure the tool behavior.
-
DOC_CONFIG
public static final Flag DOC_CONFIG
-
REGEXP
public static final Flag REGEXP
Flag to specify file patterns to look for when validating a target directory.
-
IGNOREDIR
public static final Flag IGNOREDIR
Flag to specify patterns to look for when crawling a target directory for sub-directories to ignore.
-
ISPDS3DIR
public static final Flag ISPDS3DIR
Flag to specify a PDS3 directory to crawl for harvesting.
-
HELP
public static final Flag HELP
Flag to display the help.
-
LOG
public static final Flag LOG
Flag to output the logging to a file.
-
OUTPUT_DIR
public static final Flag OUTPUT_DIR
-
PORT
public static final Flag PORT
Flag for the daemon port number to be used if running the tool continuously.
-
WAIT
public static final Flag WAIT
Flag to specify the wait time in between crawls.
-
VERSION
public static final Flag VERSION
Flag to display the version.
-
VERBOSE
public static final Flag VERBOSE
Flag to change the severity level of the messaging in the report.
-
-
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.
-
-