edu.mayo.bsi.ngsportal.server
Enum GetOpts.ArgType

java.lang.Object
  java.lang.Enum<GetOpts.ArgType>
      edu.mayo.bsi.ngsportal.server.GetOpts.ArgType

All Implemented Interfaces:

Serializable, Comparable<GetOpts.ArgType>

Enclosing class:

GetOpts

public static enum GetOpts.ArgType
extends Enum<GetOpts.ArgType>

Enumerated Type to specify the type of argument (if any) any option has

Author:

Gregory Dougherty

Enum Constant Summary

kMultiRequiredArgument
Parameter that can occur more than once, w/ new argument each time.

kNoArgument
Parameter that doesn't take an argument

kOptionalArgument
Parameter that can take an argument, but doesn't have to

kRequiredArgument
Parameter that requires an argument

Method Summary

static GetOpts.ArgType	valueOf(String name) Returns the enum constant of this type with the specified name.
static GetOpts.ArgType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

kNoArgument

public static final GetOpts.ArgType kNoArgument

Parameter that doesn't take an argument

kOptionalArgument

public static final GetOpts.ArgType kOptionalArgument

Parameter that can take an argument, but doesn't have to

kRequiredArgument

public static final GetOpts.ArgType kRequiredArgument

Parameter that requires an argument

kMultiRequiredArgument

public static final GetOpts.ArgType kMultiRequiredArgument

Parameter that can occur more than once, w/ new argument each time. If actually get more than one of occurrence of the parameter, the occurrences will be separated by '\n' within the result string

Method Detail

values

public static GetOpts.ArgType[] 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 (GetOpts.ArgType c : GetOpts.ArgType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static GetOpts.ArgType 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