gov.nasa.pds.search.core.cli.options
Enum Flag

java.lang.Object
  extended by java.lang.Enum<Flag>
      extended by gov.nasa.pds.search.core.cli.options.Flag
All Implemented Interfaces:
Serializable, Comparable<Flag>

public enum Flag
extends Enum<Flag>

Describes all the flags used in the CLI

Author:
jpadams

Enum Constant Summary
ALL
          Flag to run all components of index.
CLEAN
          Flag to turn OFF removal of all directories from previous Search Core execution.
CONFIG_HOME
          Flag to specify a product class configuration directory.
DEBUG
          Flag to run in debug mode.
EXTRACTOR
          Flag to run the Registry Extractor component.
HELP
          Flag to display the help.
MAX
          Flag to specify query max for registry.
PROPERTIES
          Flag to specify a configuration file.
REGISTRY
          Flag to specify at least one Registry URL.
SEARCH_HOME
          Flag to specify Search Home.
SOLR
          Flag to generate a Solr Index.
VERSION
          Flag to display the 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

ALL

public static final Flag ALL
Flag to run all components of index.


CONFIG_HOME

public static final Flag CONFIG_HOME
Flag to specify a product class configuration directory.


CLEAN

public static final Flag CLEAN
Flag to turn OFF removal of all directories from previous Search Core execution.


DEBUG

public static final Flag DEBUG
Flag to run in debug mode.


EXTRACTOR

public static final Flag EXTRACTOR
Flag to run the Registry Extractor component.


HELP

public static final Flag HELP
Flag to display the help.


SEARCH_HOME

public static final Flag SEARCH_HOME
Flag to specify Search Home.


SOLR

public static final Flag SOLR
Flag to generate a Solr Index.


MAX

public static final Flag MAX
Flag to specify query max for registry.


PROPERTIES

public static final Flag PROPERTIES
Flag to specify a configuration file.


REGISTRY

public static final Flag REGISTRY
Flag to specify at least one Registry URL.


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 name
NullPointerException - if the argument is null

getOptions

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

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

allowsMultipleArgs

public boolean allowsMultipleArgs()
Find out if the flag can handle multiple arguments.

Returns:
'true' if yes.

getArgName

public String getArgName()
Get the argument name of the flag.

Returns:
The argument name.

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.

getLongName

public String getLongName()
Get the long name of the flag.

Returns:
The long name.

getShortName

public String getShortName()
Get the short name of the flag.

Returns:
The short name.


Copyright © 2010-2012 Planetary Data System. All Rights Reserved.