org.fhcrc.cpl.toolbox.commandline.arguments
Class IntegerArgumentDefinition

java.lang.Object
  org.fhcrc.cpl.toolbox.commandline.arguments.BaseArgumentDefinitionImpl
      org.fhcrc.cpl.toolbox.commandline.arguments.IntegerArgumentDefinition

All Implemented Interfaces:

CommandLineArgumentDefinition

public class IntegerArgumentDefinition
extends BaseArgumentDefinitionImpl
implements CommandLineArgumentDefinition

Field Summary

Fields inherited from class org.fhcrc.cpl.toolbox.commandline.arguments.BaseArgumentDefinitionImpl

mArgumentHelpText, mArgumentName, mDefaultValue, mDisplayName, mIsAdvanced, mRequired

Fields inherited from interface org.fhcrc.cpl.toolbox.commandline.arguments.CommandLineArgumentDefinition

UNNAMED_PARAMETER_VALUE_ARGUMENT, UNNAMED_PARAMETER_VALUE_SERIES_ARGUMENT

Constructor Summary

IntegerArgumentDefinition(java.lang.String argumentName)

IntegerArgumentDefinition(java.lang.String argumentName, boolean required, java.lang.String help)

IntegerArgumentDefinition(java.lang.String argumentName, boolean required, java.lang.String help, int defaultValue)

IntegerArgumentDefinition(java.lang.String argumentName, java.lang.String help)

Method Summary

javax.swing.JComponent	addComponentsForGUI(java.awt.Container parent, javax.swing.JDialog parentDialog, java.lang.String defaultValue) Same as base method, but resize the text field
java.lang.Object	convertArgumentValue(java.lang.String argumentValue) Any String is valid, no-op
java.lang.String	getValueDescriptor() Return a String that will be used as a generic example for the value to be used for this argument, in auto-generated usage

Methods inherited from class org.fhcrc.cpl.toolbox.commandline.arguments.BaseArgumentDefinitionImpl

addComponentsForGUISeries, getArgumentDisplayName, getArgumentName, getDefaultValue, getDefaultValueAsString, getDisplayName, getHelpText, getValueFromGUIComponent, hasDefaultValue, isAdvanced, isRequired, setAdvanced, setArgumentDisplayName, setDefaultValue, setDisplayName, setHelpText, setRequired, valueToString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.fhcrc.cpl.toolbox.commandline.arguments.CommandLineArgumentDefinition

addComponentsForGUISeries, getArgumentDisplayName, getArgumentName, getDefaultValue, getDefaultValueAsString, getHelpText, getValueFromGUIComponent, hasDefaultValue, isAdvanced, isRequired, setAdvanced, setArgumentDisplayName, setDefaultValue, setHelpText, setRequired, valueToString

Constructor Detail

IntegerArgumentDefinition

public IntegerArgumentDefinition(java.lang.String argumentName)

IntegerArgumentDefinition

public IntegerArgumentDefinition(java.lang.String argumentName,
                                 java.lang.String help)

IntegerArgumentDefinition

public IntegerArgumentDefinition(java.lang.String argumentName,
                                 boolean required,
                                 java.lang.String help)

IntegerArgumentDefinition

public IntegerArgumentDefinition(java.lang.String argumentName,
                                 boolean required,
                                 java.lang.String help,
                                 int defaultValue)

Method Detail

convertArgumentValue

public java.lang.Object convertArgumentValue(java.lang.String argumentValue)
                                      throws ArgumentValidationException

Any String is valid, no-op

Specified by:

convertArgumentValue in interface CommandLineArgumentDefinition

Specified by:

convertArgumentValue in class BaseArgumentDefinitionImpl

Parameters:

argumentValue -

Returns:

the argument as an Integer

Throws:

ArgumentValidationException - if the argument doesn't validate

getValueDescriptor

public java.lang.String getValueDescriptor()

Description copied from interface: CommandLineArgumentDefinition

Return a String that will be used as a generic example for the value to be used for this argument, in auto-generated usage

Specified by:

getValueDescriptor in interface CommandLineArgumentDefinition

Overrides:

getValueDescriptor in class BaseArgumentDefinitionImpl

Returns:

addComponentsForGUI

public javax.swing.JComponent addComponentsForGUI(java.awt.Container parent,
                                                  javax.swing.JDialog parentDialog,
                                                  java.lang.String defaultValue)

Same as base method, but resize the text field

Specified by:

addComponentsForGUI in interface CommandLineArgumentDefinition

Overrides:

addComponentsForGUI in class BaseArgumentDefinitionImpl

Parameters:

parent -

parentDialog -

defaultValue -

Returns: