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 SummaryEnum Constants Enum Constant Description CONFIGFlag to specify a configuration file to configure the tool behavior.DOC_CONFIGHELPFlag to display the help.IGNOREDIRFlag to specify patterns to look for when crawling a target directory for sub-directories to ignore.ISPDS3DIRFlag to specify a PDS3 directory to crawl for harvesting.LOGFlag to output the logging to a file.OUTPUT_DIRPORTFlag for the daemon port number to be used if running the tool continuously.REGEXPFlag to specify file patterns to look for when validating a target directory.VERBOSEFlag to change the severity level of the messaging in the report.VERSIONFlag to display the version.WAITFlag to specify the wait time in between crawls.
 - 
Method SummaryAll Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description booleanallowsMultipleArgs()Find out if the flag can handle multiple arguments.StringgetArgName()Get the argument name of the flag.ObjectgetArgType()Get the argument type of the flag.StringgetDescription()Get the flag description.StringgetLongName()Get the long name of the flag.static org.apache.commons.cli.OptionsgetOptions()Get the command-line options.StringgetShortName()Get the short name of the flag.static FlagvalueOf(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- 
CONFIGpublic static final Flag CONFIG Flag to specify a configuration file to configure the tool behavior.
 - 
DOC_CONFIGpublic static final Flag DOC_CONFIG 
 - 
REGEXPpublic static final Flag REGEXP Flag to specify file patterns to look for when validating a target directory.
 - 
IGNOREDIRpublic static final Flag IGNOREDIR Flag to specify patterns to look for when crawling a target directory for sub-directories to ignore.
 - 
ISPDS3DIRpublic static final Flag ISPDS3DIR Flag to specify a PDS3 directory to crawl for harvesting.
 - 
HELPpublic static final Flag HELP Flag to display the help.
 - 
LOGpublic static final Flag LOG Flag to output the logging to a file.
 - 
OUTPUT_DIRpublic static final Flag OUTPUT_DIR 
 - 
PORTpublic static final Flag PORT Flag for the daemon port number to be used if running the tool continuously.
 - 
WAITpublic static final Flag WAIT Flag to specify the wait time in between crawls.
 - 
VERSIONpublic static final Flag VERSION Flag to display the version.
 - 
VERBOSEpublic static final Flag VERBOSE Flag to change the severity level of the messaging in the report.
 
- 
 - 
Method Detail- 
valuespublic 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
 
 - 
valueOfpublic 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
 
 - 
getShortNamepublic String getShortName() Get the short name of the flag.- Returns:
- The short name.
 
 - 
getLongNamepublic String getLongName() Get the long name of the flag.- Returns:
- The long name.
 
 - 
getArgNamepublic String getArgName() Get the argument name of the flag.- Returns:
- The argument name.
 
 - 
allowsMultipleArgspublic boolean allowsMultipleArgs() Find out if the flag can handle multiple arguments.- Returns:
- 'true' if yes.
 
 - 
getArgTypepublic Object getArgType() Get the argument type of the flag.- Returns:
- The argument type.
 
 - 
getDescriptionpublic String getDescription() Get the flag description.- Returns:
- The description.
 
 - 
getOptionspublic static org.apache.commons.cli.Options getOptions() Get the command-line options.- Returns:
- A class representation of the command-line options.
 
 
- 
 
-