CommandCatalog

All Known Implementing Classes:: CommandCatalog.DefaultCommandCatalog

public interface CommandCatalog

Interface defining contract to handle existing CommandRegistrations.

Nested Class Summary

Nested Classes

Modifier and Type

Interface

Description

static class

CommandCatalog.DefaultCommandCatalog

Default implementation of a CommandCatalog.
Method Summary

Modifier and Type

Method

Description

Map<String,CommandRegistration>

getRegistrations()

Gets all CommandRegistrations mapped with their names.

static CommandCatalog

of()

Gets an instance of a default CommandCatalog.

static CommandCatalog

of(Collection<CommandResolver> resolvers, ShellContext shellContext)

Gets an instance of a default CommandCatalog.

void

register(CommandRegistration... registration)

Register a CommandRegistration.

void

unregister(String... commandName)

Unregister a CommandRegistration by its command name.

void

unregister(CommandRegistration... registration)

Unregister a CommandRegistration.

Method Details
- register
  
  void register(CommandRegistration... registration)
  
  Register a CommandRegistration.
  
  Parameters:
  
  registration - the command registration
- unregister
  
  void unregister(CommandRegistration... registration)
  
  Unregister a CommandRegistration.
  
  Parameters:
  
  registration - the command registration
- unregister
  
  void unregister(String... commandName)
  
  Unregister a CommandRegistration by its command name.
  
  Parameters:
  
  commandName - the command name
- getRegistrations
  
  Map<String,CommandRegistration> getRegistrations()
  
  Gets all CommandRegistrations mapped with their names. Returned map is a copy and cannot be used to register new commands.
  
  Returns:
  
  all command registrations
- of
  
  static CommandCatalog of()
  
  Gets an instance of a default CommandCatalog.
  
  Returns:
  
  default command catalog
- of
  
  static CommandCatalog of(Collection<CommandResolver> resolvers, ShellContext shellContext)
  
  Gets an instance of a default CommandCatalog.
  
  Parameters:
  
  resolvers - the command resolvers
  
  shellContext - the shell context
  
  Returns:
  
  default command catalog