org.jboss.as.cli.impl

Class ArgumentWithValue

java.lang.Object

org.jboss.as.cli.impl.ArgumentWithoutValue

org.jboss.as.cli.impl.ArgumentWithValue

All Implemented Interfaces:

CommandArgument

Direct Known Subclasses:

RequestParamArgWithValue

public class ArgumentWithValue
extends ArgumentWithoutValue

Author:

Alexey Loubyansky

Field Summary

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

cantAppearAfter, exclusive, fullName, index, requiredPreceding, shortName

Constructor Summary

Constructors

Constructor and Description
ArgumentWithValue(CommandHandlerWithArguments handler, CommandLineCompleter valueCompleter, ArgumentValueConverter valueConverter, String fullName)
ArgumentWithValue(CommandHandlerWithArguments handler, CommandLineCompleter valueCompleter, ArgumentValueConverter valueConverter, String fullName, String shortName)
ArgumentWithValue(CommandHandlerWithArguments handler, CommandLineCompleter valueCompleter, int index, String fullName)
ArgumentWithValue(CommandHandlerWithArguments handler, CommandLineCompleter valueCompleter, String fullName)
ArgumentWithValue(CommandHandlerWithArguments handler, int index, String fullName)
ArgumentWithValue(CommandHandlerWithArguments handler, String fullName)
ArgumentWithValue(CommandHandlerWithArguments handler, String fullName, String shortName)

Method Summary

Methods

Modifier and Type	Method and Description
String	getValue(ParsedCommandLine args, boolean required) Returns the value of the argument specified on the command line.
CommandLineCompleter	getValueCompleter() Returns the tab-completer for the value.
ArgumentValueConverter	getValueConverter()
boolean	isValueComplete(ParsedCommandLine args) Checks whether the value is specified and complete.
boolean	isValueRequired() Checks whether the argument accepts value.

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

ArgumentWithValue

public ArgumentWithValue(CommandHandlerWithArguments handler,
                 String fullName)

ArgumentWithValue

public ArgumentWithValue(CommandHandlerWithArguments handler,
                 CommandLineCompleter valueCompleter,
                 String fullName)

ArgumentWithValue

public ArgumentWithValue(CommandHandlerWithArguments handler,
                 CommandLineCompleter valueCompleter,
                 ArgumentValueConverter valueConverter,
                 String fullName)

ArgumentWithValue

public ArgumentWithValue(CommandHandlerWithArguments handler,
                 String fullName,
                 String shortName)

ArgumentWithValue

public ArgumentWithValue(CommandHandlerWithArguments handler,
                 int index,
                 String fullName)

ArgumentWithValue

public ArgumentWithValue(CommandHandlerWithArguments handler,
                 CommandLineCompleter valueCompleter,
                 int index,
                 String fullName)

ArgumentWithValue

public ArgumentWithValue(CommandHandlerWithArguments handler,
                 CommandLineCompleter valueCompleter,
                 ArgumentValueConverter valueConverter,
                 String fullName,
                 String shortName)

Method Detail

getValueCompleter

public CommandLineCompleter getValueCompleter()

Description copied from interface: CommandArgument

Returns the tab-completer for the value.

Specified by:

getValueCompleter in interface CommandArgument

Overrides:

getValueCompleter in class ArgumentWithoutValue

Returns:

tab-completer for the value or null of none available.

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 ArgumentWithoutValue

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

isValueRequired

public boolean isValueRequired()

Description copied from interface: CommandArgument

Checks whether the argument accepts value.

Specified by:

isValueRequired in interface CommandArgument

Overrides:

isValueRequired in class ArgumentWithoutValue

Returns:

true if this argument accepts a value, otherwise false.

isValueComplete

public boolean isValueComplete(ParsedCommandLine args)
                        throws CommandFormatException

Description copied from interface: CommandArgument

Checks whether the value is specified and complete. The value is considered complete only if it is followed by a separator (argument separator, end of argument list but not end-of-content).

Specified by:

isValueComplete in interface CommandArgument

Overrides:

isValueComplete in class ArgumentWithoutValue

Parameters:

args - the parsed arguments

Returns:

true if the value of the argument is complete, false otherwise.

Throws:

CommandFormatException

getValueConverter

public ArgumentValueConverter getValueConverter()