org.jboss.as.cli.impl

Class ArgumentWithoutValue

java.lang.Object

org.jboss.as.cli.impl.ArgumentWithoutValue

All Implemented Interfaces:

CommandArgument

Direct Known Subclasses:

ArgumentWithValue, RequestParamArgWithoutValue

public class ArgumentWithoutValue
extends Object
implements CommandArgument

Author:

Alexey Loubyansky

Field Summary

Fields

Modifier and Type	Field and Description
protected AccessRequirement	access
protected List<CommandArgument>	cantAppearAfter
protected boolean	exclusive
protected String	fullName
protected int	index
protected List<CommandArgument>	requiredPreceding
protected String	shortName

Constructor Summary

Constructors

Constructor and Description
ArgumentWithoutValue(CommandHandlerWithArguments handler, int index, String fullName)
ArgumentWithoutValue(CommandHandlerWithArguments handler, String fullName)
ArgumentWithoutValue(CommandHandlerWithArguments handler, String fullName, String shortName)

Method Summary

Modifier and Type	Method and Description
void	addCantAppearAfter(CommandArgument arg)
void	addRequiredPreceding(CommandArgument arg)
boolean	canAppearNext(CommandContext ctx) Checks whether the argument can appear on the command given the already present arguments.
String	getFullName() The default name of the argument.
int	getIndex() If the argument doesn't have a name its value can be found by index.
String	getShortName() Short name of the argument if exists.
String	getValue(ParsedCommandLine args) Returns the value of the argument specified on the command line.
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.
boolean	isPresent(ParsedCommandLine args) Checks whether the argument is present on the command line.
boolean	isValueComplete(ParsedCommandLine args) Checks whether the value is specified and complete.
boolean	isValueRequired() Checks whether the argument accepts value.
void	setAccessRequirement(AccessRequirement access)
void	setExclusive(boolean exclusive)

Methods inherited from class java.lang.Object

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

Field Detail

index

protected final int index

fullName

protected final String fullName

shortName

protected final String shortName

requiredPreceding

protected List<CommandArgument> requiredPreceding

cantAppearAfter

protected List<CommandArgument> cantAppearAfter

exclusive

protected boolean exclusive

access

protected AccessRequirement access

Constructor Detail

ArgumentWithoutValue

public ArgumentWithoutValue(CommandHandlerWithArguments handler,
                            String fullName)

ArgumentWithoutValue

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

ArgumentWithoutValue

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

Method Detail

setExclusive

public void setExclusive(boolean exclusive)

addRequiredPreceding

public void addRequiredPreceding(CommandArgument arg)

addCantAppearAfter

public void addCantAppearAfter(CommandArgument arg)

getIndex

public int getIndex()

Description copied from interface: CommandArgument

If the argument doesn't have a name its value can be found by index. Indexes start with 0. A command could have both a name and an index. In that case, the name is optional. If the command doesn't have a fixed index, the method will return -1.

Specified by:

getIndex in interface CommandArgument

Returns:

the index of the argument.

getValueCompleter

public CommandLineCompleter getValueCompleter()

Description copied from interface: CommandArgument

Returns the tab-completer for the value.

Specified by:

getValueCompleter in interface CommandArgument

Returns:

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

getValue

public String getValue(ParsedCommandLine args)

Description copied from interface: CommandArgument

Returns the value of the argument specified on the command line. If the argument isn't specified the returned value is null. Although, it might throw IllegalArgumentException in case the argument is a required one.

Specified by:

getValue in interface CommandArgument

Parameters:

args - parsed arguments.

Returns:

the value of the argument or null if the argument isn't present or is missing value.

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

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

isPresent

public boolean isPresent(ParsedCommandLine args)
                  throws CommandFormatException

Description copied from interface: CommandArgument

Checks whether the argument is present on the command line.

Specified by:

isPresent in interface CommandArgument

Parameters:

args - parsed arguments

Returns:

true if the argument is present, false - otherwise.

Throws:

CommandFormatException

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

Parameters:

args - the parsed arguments

Returns:

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

Throws:

CommandFormatException

getFullName

public String getFullName()

Description copied from interface: CommandArgument

The default name of the argument. An argument can have more than one name, e.g. --force and -f. Full name can't be null.

Specified by:

getFullName in interface CommandArgument

Returns:

the default name of the argument.

canAppearNext

public boolean canAppearNext(CommandContext ctx)
                      throws CommandFormatException

Description copied from interface: CommandArgument

Checks whether the argument can appear on the command given the already present arguments. (Used for tab-completion. Although, often isValueComplete(ParsedOperationRequest req) would be more appropriate.)

Specified by:

canAppearNext in interface CommandArgument

Returns:

true if the argument can appear on the command line next, false - otherwise.

Throws:

CommandFormatException

isValueRequired

public boolean isValueRequired()

Description copied from interface: CommandArgument

Checks whether the argument accepts value.

Specified by:

isValueRequired in interface CommandArgument

Returns:

true if this argument accepts a value, otherwise false.

getShortName

public String getShortName()

Description copied from interface: CommandArgument

Short name of the argument if exists.

Specified by:

getShortName in interface CommandArgument

Returns:

short name of the argument or null if the short name doesn't exist.

setAccessRequirement

public void setAccessRequirement(AccessRequirement access)