org.neo4j.commandline.admin

Interface CommandLocator

public interface CommandLocator

The CommandLocator locates named commands for the AdminTool, or supplies the set of available commands for printing help output.

Method Summary

Modifier and Type	Method and Description
AdminCommand.Provider	findProvider(String name) Find a command provider that matches the given key or name, or throws NoSuchElementException if no matching provider was found.
static CommandLocator	fromServiceLocator() Get a command locator that uses the service locator mechanism to find providers by their service key.
Iterable<AdminCommand.Provider>	getAllProviders() Get an iterable of all of the command providers that are available through this command locator instance.
static CommandLocator	withAdditionalCommand(Supplier<AdminCommand.Provider> command, CommandLocator commands) Augment the given command locator such that it also considers the command provider given through the supplier.

Method Detail

findProvider

AdminCommand.Provider findProvider(String name)
                            throws NoSuchElementException

Find a command provider that matches the given key or name, or throws NoSuchElementException if no matching provider was found.

Parameters:

name - The name of the provider to look for.

Returns:

Any matching command provider.

Throws:

NoSuchElementException

getAllProviders

Iterable<AdminCommand.Provider> getAllProviders()

Get an iterable of all of the command providers that are available through this command locator instance.

Returns:

An iterable of command providers.

fromServiceLocator

static CommandLocator fromServiceLocator()

Get a command locator that uses the service locator mechanism to find providers by their service key.

Returns:

A service locator based command locator.

withAdditionalCommand

static CommandLocator withAdditionalCommand(Supplier<AdminCommand.Provider> command,
                                            CommandLocator commands)

Augment the given command locator such that it also considers the command provider given through the supplier.

Parameters:

command - A supplier of an additional command. Note that this may be called multiple times.

commands - The command locator to augment with the additional command provider.

Returns:

The augmented command locator.