Package org.springframework.shell.command

Class CommandContext.DefaultCommandContext

java.lang.Object

org.springframework.shell.command.CommandContext.DefaultCommandContext

All Implemented Interfaces:

CommandContext

Enclosing interface:

CommandContext

public static class CommandContext.DefaultCommandContext
extends Object
implements CommandContext

Default implementation of a CommandContext.

Nested Class Summary

Nested classes/interfaces inherited from interface org.springframework.shell.command.CommandContext

CommandContext.DefaultCommandContext

Method Summary

Modifier and Type	Method	Description
CommandRegistration	getCommandRegistration()	Gets a command registration.
<T> T	getOptionValue(String name)	Gets an mapped option value.
CommandParser.CommandParserResults	getParserResults()	Gets a command option parser results.
String[]	getRawArgs()	Gets a raw args passed into a currently executing command.
ShellContext	getShellContext()	Gets a ShellContext associated with CommandContext.
org.jline.terminal.Terminal	getTerminal()	Gets a terminal.
boolean	hasMappedOption(String name)	Gets if option has been mapped.

Methods inherited from class java.lang.Object

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

Method Details

getRawArgs

public String[] getRawArgs()

Description copied from interface: CommandContext

Gets a raw args passed into a currently executing command.

Specified by:

getRawArgs in interface CommandContext

Returns:

raw command arguments

hasMappedOption

public boolean hasMappedOption(String name)

Description copied from interface: CommandContext

Gets if option has been mapped.

Specified by:

hasMappedOption in interface CommandContext

Parameters:

name - the option name

Returns:

true if option has been mapped, false otherwise

getParserResults

public CommandParser.CommandParserResults getParserResults()

Description copied from interface: CommandContext

Gets a command option parser results.

Specified by:

getParserResults in interface CommandContext

Returns:

the command option parser results

getCommandRegistration

public CommandRegistration getCommandRegistration()

Description copied from interface: CommandContext

Gets a command registration.

Specified by:

getCommandRegistration in interface CommandContext

Returns:

the command registration

getOptionValue

public <T> T getOptionValue(String name)

Description copied from interface: CommandContext

Gets an mapped option value.

Specified by:

getOptionValue in interface CommandContext

Type Parameters:

T - the type to map to

Parameters:

name - the option name

Returns:

mapped value

getTerminal

public org.jline.terminal.Terminal getTerminal()

Description copied from interface: CommandContext

Gets a terminal.

Specified by:

getTerminal in interface CommandContext

Returns:

a terminal

getShellContext

public ShellContext getShellContext()

Description copied from interface: CommandContext

Gets a ShellContext associated with CommandContext.

Specified by:

getShellContext in interface CommandContext

Returns:

a shell context