Package org.jline.console.impl

Class GogoCommandGroup

java.lang.Object

org.jline.console.impl.GogoCommandGroup

All Implemented Interfaces:

CommandGroup

public class GogoCommandGroup
extends Object
implements CommandGroup

A CommandGroup that wraps a legacy CommandRegistry's commands as shell Commands.

This provides a migration path from the console module's CommandRegistry API to the shell module's CommandGroup API. Each command in the registry is wrapped as a shell Command that delegates to the registry's CommandRegistry.invoke(CommandRegistry.CommandSession, String, Object...) method.

Example:

 CommandRegistry registry = ...; // existing Gogo/console registry
 dispatcher.addGroup(new GogoCommandGroup("Gogo", registry));
 

Since:

4.0

Constructor Summary

Constructors

Constructor	Description
GogoCommandGroup(String name, CommandRegistry registry)	Creates a new GogoCommandGroup wrapping the given registry.

Method Summary

Modifier and Type	Method	Description
Collection<Command>	commands()	Returns all commands in this group.
String	name()	Returns the name of this command group.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jline.shell.CommandGroup

command, hasCommand

Constructor Details

GogoCommandGroup

public GogoCommandGroup(String name,
 CommandRegistry registry)

Creates a new GogoCommandGroup wrapping the given registry.

Parameters:

name - the group name

registry - the command registry to wrap

Method Details

name

public String name()

Description copied from interface: CommandGroup

Returns the name of this command group.

The default implementation returns the simple class name.

Specified by:

name in interface CommandGroup

Returns:

the group name

commands

public Collection<Command> commands()

Description copied from interface: CommandGroup

Returns all commands in this group.

Specified by:

commands in interface CommandGroup

Returns:

the collection of commands, never null