CommandLine (Grace Framework

```
public interface CommandLine
```
Represents the parsed command line options.
Authors:
Graeme Rocher
Michael Yan
Since:
2.0

Methods Summary

Methods
Type Params	Return Type	Name and description
	`public String`	`getCommandName()` Returns: The command name specified
	`public Map<String, Object>`	`getDeclaredOptions()`
	`public String`	`getEnvironment()` Returns: The environment specified
	`public String[]`	`getRawArguments()`
	`public List<String>`	`getRemainingArgs()` Returns: The remaining arguments after the command name
	`public String[]`	`getRemainingArgsArray()` Returns: The remaining arguments as an array
	`public String`	`getRemainingArgsLineSeparated()` Returns: The remaining args separated by the line separator char
	`public String`	`getRemainingArgsString()` Returns: The remaining args as one big string
	`public String`	`getRemainingArgsWithOptionsString()` Returns: The remaining args as one big string without undeclared options
	`public Properties`	`getSystemProperties()` Returns: The system properties specified
	`public Map<String, Object>`	`getUndeclaredOptions()`
	`public boolean`	`hasOption(String name)` Parameters: `name` - The name of the option
	`public boolean`	`isEnvironmentSet()` Returns: Whether the environment is user specified
	`public Map.Entry<String, Object>`	`lastOption()` Returns: The last specified option
	`public String`	`lookupEnvironmentForCommand()`
	`public Object`	`optionValue(String name)` The value of an option
	`public CommandLine`	`parseNew(String[] args)` Parses a new CommandLine instance that combines this instance with the given arguments
	`public void`	`setCommand(String scriptName)`

- Method Detail
  - public String getCommandName()
    
    Returns:
    The command name specified
  - public Map<String, Object> getDeclaredOptions()
  - public String getEnvironment()
    
    Returns:
    The environment specified
  - public String[] getRawArguments()
  - public List<String> getRemainingArgs()
    
    Returns:
    The remaining arguments after the command name
  - public String[] getRemainingArgsArray()
    
    Returns:
    The remaining arguments as an array
  - public String getRemainingArgsLineSeparated()
    
    Returns:
    The remaining args separated by the line separator char
  - public String getRemainingArgsString()
    
    Returns:
    The remaining args as one big string
  - public String getRemainingArgsWithOptionsString()
    
    Returns:
    The remaining args as one big string without undeclared options
  - public Properties getSystemProperties()
    
    Returns:
    The system properties specified
  - public Map<String, Object> getUndeclaredOptions()
  - public boolean hasOption(String name)
    
    Parameters:
    name - The name of the option
    Returns:
    Whether the given option is specified
  - public boolean isEnvironmentSet()
    
    Returns:
    Whether the environment is user specified
  - public Map.Entry<String, Object> lastOption()
    
    Returns:
    The last specified option
  - public String lookupEnvironmentForCommand()
  - public Object optionValue(String name)
    
    The value of an option
    Parameters:
    name - The option
    Returns:
    The value
  - public CommandLine parseNew(String[] args)
    
    Parses a new CommandLine instance that combines this instance with the given arguments
    Parameters:
    args - The arguments
    Returns:
    A new CommandLine instance
  - public void setCommand(String scriptName)

Summary:
Method

| Detail:
Method

[Java] Interface CommandLine

Methods Summary

Method Detail

public String getCommandName()

public Map<String, Object> getDeclaredOptions()

public String getEnvironment()

public String[] getRawArguments()

public List<String> getRemainingArgs()

public String[] getRemainingArgsArray()

public String getRemainingArgsLineSeparated()

public String getRemainingArgsString()

public String getRemainingArgsWithOptionsString()

public Properties getSystemProperties()

public Map<String, Object> getUndeclaredOptions()

public boolean hasOption(String name)

public boolean isEnvironmentSet()

public Map.Entry<String, Object> lastOption()

public String lookupEnvironmentForCommand()

public Object optionValue(String name)

public CommandLine parseNew(String[] args)

public void setCommand(String scriptName)