PluginCommandModule (Gerrit Review Plugin API Documentation)

java.lang.Object
- com.google.inject.AbstractModule
- - com.google.gerrit.extensions.config.FactoryModule
  - - com.google.gerrit.lifecycle.LifecycleModule
    - - com.google.gerrit.sshd.CommandModule
      - com.google.gerrit.sshd.PluginCommandModule

All Implemented Interfaces:: com.google.inject.Module

public abstract class PluginCommandModule
extends CommandModule

Field Summary
- Fields inherited from class com.google.gerrit.sshd.CommandModule
  slaveMode

Constructor Summary

Constructors
Constructor Description

PluginCommandModule()

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`protected void`	`alias(String name, Class<? extends BaseCommand> clazz)`
`protected void`	`command(Class<? extends BaseCommand> clazz)`
`protected com.google.inject.binder.LinkedBindingBuilder<org.apache.sshd.server.Command>`	`command(String subCmd)`	Configure a command to be invoked by name.
`protected void`	`configure()`
`protected abstract void`	`configureCommands()`

Methods inherited from class com.google.gerrit.sshd.CommandModule
alias, alias, command, command, command

Methods inherited from class com.google.gerrit.lifecycle.LifecycleModule
listener

Methods inherited from class com.google.gerrit.extensions.config.FactoryModule
factory

Methods inherited from class com.google.inject.AbstractModule
addError, addError, addError, bind, bind, bind, bindConstant, binder, bindInterceptor, bindListener, bindListener, bindScope, configure, convertToTypes, currentStage, getMembersInjector, getMembersInjector, getProvider, getProvider, install, requestInjection, requestStaticInjection, requireBinding, requireBinding

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

- Constructor Detail
  - PluginCommandModule
```
public PluginCommandModule()
```
- Method Detail
  - configure
```
protected final void configure()
```
    Overrides:
    
    configure in class com.google.inject.AbstractModule
  - configureCommands
```
protected abstract void configureCommands()
```
  - command
```
protected com.google.inject.binder.LinkedBindingBuilder<org.apache.sshd.server.Command> command(String subCmd)
```
    Description copied from class: CommandModule
    
    Configure a command to be invoked by name.
    
    Overrides:
    
    command in class CommandModule
    
    Parameters:
    
    subCmd - the name of the command the client will provide in order to call the command.
    
    Returns:
    
    a binding that must be bound to a non-singleton provider for a Command object.
  - command
```
protected void command(Class<? extends BaseCommand> clazz)
```
  - alias
```
protected void alias(String name,
                     Class<? extends BaseCommand> clazz)
```