org.pfsw.tools.cda.darc
Enum CommandName

java.lang.Object
  extended by java.lang.Enum<CommandName>
      extended by org.pfsw.tools.cda.darc.CommandName
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<CommandName>

public enum CommandName
extends java.lang.Enum<CommandName>
implements java.io.Serializable

Specifies all commands that are currently supported by DARC.

Version:
1.0
Author:
M.Duchrow

Enum Constant Summary
ANALYZE_CYCLES
          Analyze the cyclic dependencies of the current element.
ANALYZE_DEPENDANTS
          Analyze the dependants of the current element.
ANALYZE_DEPENDENCIES
          Analyze the dependencies of the current element.
CLOSE_WORKSET
          Close the workset with the specified name.
EXPORT_FILE
          Export the current element and its dependency data to a file.
GET_CURRENT
          Retrieve the current selected element.
GET_CURRENT_INFO
          Retrieve the overview information of the current selected element.
LOAD_WORKSET
          Load the workset with the specified name.
SELECT_CURRENT
          Select a defined element to be the current element.
 
Method Summary
static CommandName fromString(java.lang.String valueName)
          Returns the enum value with the given name.
static CommandName valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static CommandName[] 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

ANALYZE_DEPENDENCIES

public static final CommandName ANALYZE_DEPENDENCIES
Analyze the dependencies of the current element.


ANALYZE_DEPENDANTS

public static final CommandName ANALYZE_DEPENDANTS
Analyze the dependants of the current element.


ANALYZE_CYCLES

public static final CommandName ANALYZE_CYCLES
Analyze the cyclic dependencies of the current element.


LOAD_WORKSET

public static final CommandName LOAD_WORKSET
Load the workset with the specified name.


CLOSE_WORKSET

public static final CommandName CLOSE_WORKSET
Close the workset with the specified name.


EXPORT_FILE

public static final CommandName EXPORT_FILE
Export the current element and its dependency data to a file.


GET_CURRENT

public static final CommandName GET_CURRENT
Retrieve the current selected element.


GET_CURRENT_INFO

public static final CommandName GET_CURRENT_INFO
Retrieve the overview information of the current selected element.


SELECT_CURRENT

public static final CommandName SELECT_CURRENT
Select a defined element to be the current element.

Method Detail

values

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

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

valueOf

public static CommandName 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

fromString

public static CommandName fromString(java.lang.String valueName)
Returns the enum value with the given name. If none with that name can be found null will be returned.

Parameters:
valueName - The name for which to return the corresponding enum value.