Package org.jboss.as.cli.impl

Class ArgumentWithListValue

java.lang.Object

org.jboss.as.cli.impl.ArgumentWithoutValue

org.jboss.as.cli.impl.ArgumentWithValue

org.jboss.as.cli.impl.ArgumentWithListValue

All Implemented Interfaces:

CommandArgument

public class ArgumentWithListValue
extends ArgumentWithValue

Author:

Ryan Emerson

Field Summary

Fields inherited from class org.jboss.as.cli.impl.ArgumentWithValue

initialState

Fields inherited from class org.jboss.as.cli.impl.ArgumentWithoutValue

access, cantAppearAfter, exclusive, fullName, index, requiredPreceding, shortName

Constructor Summary

Constructors

Constructor	Description
ArgumentWithListValue(CommandHandlerWithArguments handler, String fullName)
ArgumentWithListValue(CommandHandlerWithArguments handler, CommandLineCompleter completer, String fullName)

Method Summary

Modifier and Type	Method	Description
String	getValue(ParsedCommandLine args, boolean required)	Returns the value of the argument specified on the command line.

Methods inherited from class org.jboss.as.cli.impl.ArgumentWithValue

getOriginalValue, getResolvedValue, getValueCompleter, getValueConverter, initParsingState, isValueComplete, isValueRequired, resolveValue, resolveValue, toModelNode

Methods inherited from class org.jboss.as.cli.impl.ArgumentWithoutValue

addCantAppearAfter, addRequiredPreceding, canAppearNext, getFullName, getIndex, getShortName, getValue, isExclusive, isPresent, setAccessRequirement, setExclusive

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jboss.as.cli.CommandArgument

getDecoratedName

Constructor Detail

ArgumentWithListValue

public ArgumentWithListValue(CommandHandlerWithArguments handler,
                             String fullName)

ArgumentWithListValue

public ArgumentWithListValue(CommandHandlerWithArguments handler,
                             CommandLineCompleter completer,
                             String fullName)

Method Detail

getValue

public String getValue(ParsedCommandLine args,
                       boolean required)
                throws CommandFormatException

Description copied from interface: CommandArgument

Returns the value of the argument specified on the command line. If the argument isn't specified and the value is not required null is returned. Otherwise an exception is thrown.

Specified by:

getValue in interface CommandArgument

Overrides:

getValue in class ArgumentWithValue

Parameters:

args - parsed arguments.

required - whether the value for this argument is required.

Returns:

the value of the argument or null if the argument isn't present and the value is not required.

Throws:

CommandFormatException