CommandCatalog.DefaultCommandCatalog

java.lang.Object

org.springframework.shell.command.CommandCatalog.DefaultCommandCatalog

All Implemented Interfaces:: CommandCatalog

Enclosing interface:: CommandCatalog

public static class CommandCatalog.DefaultCommandCatalog extends Object implements CommandCatalog

Default implementation of a CommandCatalog.

Nested Class Summary

Nested classes/interfaces inherited from interface org.springframework.shell.command.CommandCatalog
CommandCatalog.DefaultCommandCatalog
Method Summary

Modifier and Type

Method

Description

Map<String,CommandRegistration>

getRegistrations()

Gets all CommandRegistrations mapped with their names.

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.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details
- register
  
  public void register(CommandRegistration... registration)
  
  Description copied from interface: CommandCatalog
  
  Register a CommandRegistration.
  
  Specified by:
  
  register in interface CommandCatalog
  
  Parameters:
  
  registration - the command registration
- unregister
  
  public void unregister(CommandRegistration... registration)
  
  Description copied from interface: CommandCatalog
  
  Unregister a CommandRegistration.
  
  Specified by:
  
  unregister in interface CommandCatalog
  
  Parameters:
  
  registration - the command registration
- unregister
  
  public void unregister(String... commandName)
  
  Description copied from interface: CommandCatalog
  
  Unregister a CommandRegistration by its command name.
  
  Specified by:
  
  unregister in interface CommandCatalog
  
  Parameters:
  
  commandName - the command name
- getRegistrations
  
  public Map<String,CommandRegistration> getRegistrations()
  
  Description copied from interface: CommandCatalog
  
  Gets all CommandRegistrations mapped with their names. Returned map is a copy and cannot be used to register new commands.
  
  Specified by:
  
  getRegistrations in interface CommandCatalog
  
  Returns:
  
  all command registrations