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

java.lang.Object
  extended by java.lang.Enum<Flag>
      extended by gov.nasa.pds.harvest.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
HELP
          Flag to display the help.
KEYSTOREPASS
          Flag for the keystore password.
LOG
          Flag to output the logging to a file.
PASSWORD
          Flag for the username password.
PORT
          Flag for the daemon port number to be used if running the tool continuously.
USERNAME
          Flag for the username of an authorized user.
VERSION
          Flag to display the version.
WAIT
          Flag to specify the wait time in between crawls.
 
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

HELP

public static final Flag HELP
Flag to display the help.


KEYSTOREPASS

public static final Flag KEYSTOREPASS
Flag for the keystore password.


LOG

public static final Flag LOG
Flag to output the logging to a file.


PASSWORD

public static final Flag PASSWORD
Flag for the username password.


USERNAME

public static final Flag USERNAME
Flag for the username of an authorized user.


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.

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-2011 Planetary Data System. All Rights Reserved.