org.codehaus.groovy.grails.cli.parsing
Interface CommandLine

All Known Implementing Classes:

DefaultCommandLine

public interface CommandLine

Represents the parsed command line options.

Since:

2.0

Field Summary

static java.lang.String	AGENT_ARGUMENT
static java.lang.String	HELP_ARGUMENT
static java.lang.String	NOANSI_ARGUMENT
static java.lang.String	NON_INTERACTIVE_ARGUMENT
static java.lang.String	OFFLINE_ARGUMENT
static java.lang.String	REFRESH_DEPENDENCIES_ARGUMENT
static java.lang.String	STACKTRACE_ARGUMENT
static java.lang.String	VERBOSE_ARGUMENT
static java.lang.String	VERSION_ARGUMENT

Method Summary

java.lang.String	getCommandName()
java.lang.String	getEnvironment()
java.util.List<java.lang.String>	getRemainingArgs()
java.lang.String[]	getRemainingArgsArray()
java.lang.String	getRemainingArgsLineSeparated()
java.lang.String	getRemainingArgsString()
java.util.Properties	getSystemProperties()
java.util.Map<java.lang.String,java.lang.Object>	getUndeclaredOptions()
boolean	hasOption(java.lang.String name)
boolean	isEnvironmentSet()
java.lang.String	lookupEnvironmentForCommand()
java.lang.Object	optionValue(java.lang.String name) The value of an option
void	setCommand(java.lang.String scriptName)

Field Detail

OFFLINE_ARGUMENT

static final java.lang.String OFFLINE_ARGUMENT

See Also:

Constant Field Values

VERBOSE_ARGUMENT

static final java.lang.String VERBOSE_ARGUMENT

See Also:

Constant Field Values

STACKTRACE_ARGUMENT

static final java.lang.String STACKTRACE_ARGUMENT

See Also:

Constant Field Values

AGENT_ARGUMENT

static final java.lang.String AGENT_ARGUMENT

See Also:

Constant Field Values

VERSION_ARGUMENT

static final java.lang.String VERSION_ARGUMENT

See Also:

Constant Field Values

REFRESH_DEPENDENCIES_ARGUMENT

static final java.lang.String REFRESH_DEPENDENCIES_ARGUMENT

See Also:

Constant Field Values

HELP_ARGUMENT

static final java.lang.String HELP_ARGUMENT

See Also:

Constant Field Values

NOANSI_ARGUMENT

static final java.lang.String NOANSI_ARGUMENT

See Also:

Constant Field Values

NON_INTERACTIVE_ARGUMENT

static final java.lang.String NON_INTERACTIVE_ARGUMENT

See Also:

Constant Field Values

Method Detail

getEnvironment

java.lang.String getEnvironment()

Returns:

The environment specified

isEnvironmentSet

boolean isEnvironmentSet()

Returns:

Whether the environment is user specified

getCommandName

java.lang.String getCommandName()

Returns:

The command name specified

getRemainingArgs

java.util.List<java.lang.String> getRemainingArgs()

Returns:

The remaining arguments after the command name

getRemainingArgsArray

java.lang.String[] getRemainingArgsArray()

Returns:

The remaining arguments as an array

getSystemProperties

java.util.Properties getSystemProperties()

Returns:

The system properties specified

hasOption

boolean hasOption(java.lang.String name)

Parameters:

name - The name of the option

Returns:

Whether the given option is specified

optionValue

java.lang.Object optionValue(java.lang.String name)

The value of an option

Parameters:

name - The option

Returns:

The value

getRemainingArgsString

java.lang.String getRemainingArgsString()

Returns:

The remaining args as one big string

getRemainingArgsLineSeparated

java.lang.String getRemainingArgsLineSeparated()

Returns:

The remaining args separated by the line separator char

getUndeclaredOptions

java.util.Map<java.lang.String,java.lang.Object> getUndeclaredOptions()

lookupEnvironmentForCommand

java.lang.String lookupEnvironmentForCommand()

setCommand

void setCommand(java.lang.String scriptName)