Package gov.nih.mipav.view

Enum Argument.InstanceArgument

java.lang.Object

java.lang.Enum<Argument.InstanceArgument>

gov.nih.mipav.view.Argument.InstanceArgument

All Implemented Interfaces:

Argument, java.io.Serializable, java.lang.Comparable<Argument.InstanceArgument>

Enclosing interface:

Argument

public static enum Argument.InstanceArgument
extends java.lang.Enum<Argument.InstanceArgument>
implements Argument

Nested Class Summary

Nested classes/interfaces inherited from interface gov.nih.mipav.view.Argument

Argument.InstanceArgument, Argument.StaticArgument

Enum Constant Summary

Enum Constants

Enum Constant	Description
Hide
Image
MultiImage
Plugin
RawImage
SavedImageName
Script
ScriptVariable
Voi

Field Summary

Fields

Modifier and Type	Field	Description
private java.lang.String[]	altCommand	Alternate commands for a given action
private java.lang.String	command	The case-independent form of the command
private java.lang.String	help	Help for using a command.

Constructor Summary

Constructors

Modifier	Constructor	Description
private	InstanceArgument(java.lang.String command, java.lang.String help, java.lang.String... altCommand)

Method Summary

Modifier and Type	Method	Description
java.lang.String	generateCmdUsageInfo()	Prints usage info for specific command
java.lang.String	getArgument()	Returns command in lower-case form.
static Argument.InstanceArgument	getArgument(java.lang.String str, boolean quiet)
static Argument.InstanceArgument	getCommand(java.lang.String str)
java.lang.String	getHelp()	Returns help for using command.
java.lang.String	toString()
static Argument.InstanceArgument	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static Argument.InstanceArgument[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

Image

public static final Argument.InstanceArgument Image

MultiImage

public static final Argument.InstanceArgument MultiImage

RawImage

public static final Argument.InstanceArgument RawImage

Hide

public static final Argument.InstanceArgument Hide

Script

public static final Argument.InstanceArgument Script

Voi

public static final Argument.InstanceArgument Voi

SavedImageName

public static final Argument.InstanceArgument SavedImageName

ScriptVariable

public static final Argument.InstanceArgument ScriptVariable

Plugin

public static final Argument.InstanceArgument Plugin

Field Detail

help

private java.lang.String help

Help for using a command.

command

private java.lang.String command

The case-independent form of the command

altCommand

private java.lang.String[] altCommand

Alternate commands for a given action

Constructor Detail

InstanceArgument

private InstanceArgument(java.lang.String command,
                         java.lang.String help,
                         java.lang.String... altCommand)

Method Detail

values

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

Returns:

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

valueOf

public static Argument.InstanceArgument 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

getHelp

public java.lang.String getHelp()

Description copied from interface: Argument

Returns help for using command.

Specified by:

getHelp in interface Argument

getArgument

public java.lang.String getArgument()

Description copied from interface: Argument

Returns command in lower-case form.

Specified by:

getArgument in interface Argument

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Enum<Argument.InstanceArgument>

generateCmdUsageInfo

public java.lang.String generateCmdUsageInfo()

Description copied from interface: Argument

Prints usage info for specific command

Specified by:

generateCmdUsageInfo in interface Argument

getCommand

public static Argument.InstanceArgument getCommand(java.lang.String str)

getArgument

public static Argument.InstanceArgument getArgument(java.lang.String str,
                                                    boolean quiet)