org.codehaus.enunciate.main
Enum Main.Option

java.lang.Object
  java.lang.Enum<Main.Option>
      org.codehaus.enunciate.main.Main.Option

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Main.Option>

Enclosing class:

Main

public static enum Main.Option
extends java.lang.Enum<Main.Option>

Enum Constant Summary

buildDir

classpath

compileDir

configFile

debug

disableDebugInfo

export

generateDir

javacCheck

packageDir

target

verbose

Method Summary

java.lang.String	getDescription() The description of the option.
java.lang.String	getHelpInfo() Print out the help information for this option.
java.lang.String	getId() The id of the option.
java.lang.String	getName() The name of the option.
java.lang.String	getValueName() The name of the value.
boolean	handle(java.lang.String option, Enunciate enunciate) Handle the specified option (with no value).
boolean	handle(java.lang.String option, java.lang.String value, Enunciate enunciate) Handle the specified option with the specified value for the given enunciate mechanism.
static Main.Option	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static Main.Option[]	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

verbose

public static final Main.Option verbose

debug

public static final Main.Option debug

disableDebugInfo

public static final Main.Option disableDebugInfo

javacCheck

public static final Main.Option javacCheck

configFile

public static final Main.Option configFile

generateDir

public static final Main.Option generateDir

compileDir

public static final Main.Option compileDir

buildDir

public static final Main.Option buildDir

packageDir

public static final Main.Option packageDir

classpath

public static final Main.Option classpath

target

public static final Main.Option target

export

public static final Main.Option export

Method Detail

values

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

Returns:

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

valueOf

public static Main.Option valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getId

public java.lang.String getId()

The id of the option.

Returns:

The id of the option.

getName

public java.lang.String getName()

The name of the option.

Returns:

The name of the option.

getValueName

public java.lang.String getValueName()

The name of the value.

Returns:

The name of the value.

getDescription

public java.lang.String getDescription()

The description of the option.

Returns:

The description of the option.

getHelpInfo

public java.lang.String getHelpInfo()

Print out the help information for this option.

Returns:

The help information.

handle

public boolean handle(java.lang.String option,
                      Enunciate enunciate)

Handle the specified option (with no value).

Parameters:

option - The option to handle.

enunciate - The mechanism to manipulate.

Returns:

Whether the option was successfully handled without a value.

handle

public boolean handle(java.lang.String option,
                      java.lang.String value,
                      Enunciate enunciate)

Handle the specified option with the specified value for the given enunciate mechanism.

Parameters:

option - The option to handle.

value - The value to handle.

enunciate - The mechansim to use.

Returns:

Whether the option was successfully handled with the specified value.