org.neo4j.commandline.admin

Class AdminCommand.Provider

java.lang.Object

org.neo4j.helpers.Service

org.neo4j.commandline.admin.AdminCommand.Provider

Direct Known Subclasses:

HelpCommandProvider

Enclosing interface:

AdminCommand

public abstract static class AdminCommand.Provider
extends org.neo4j.helpers.Service

Nested Class Summary

Nested classes/interfaces inherited from class org.neo4j.helpers.Service

org.neo4j.helpers.Service.Implementation

Method Summary

Modifier and Type	Method and Description
abstract Arguments	allArguments()
abstract AdminCommandSection	commandSection()
abstract AdminCommand	create(Path homeDir, Path configDir, OutsideWorld outsideWorld)
abstract String	description()
String	name()
List<Arguments>	possibleArguments()
void	printSummary(Consumer<String> output)
abstract String	summary()

Methods inherited from class org.neo4j.helpers.Service

equals, getKeys, hashCode, load, load, loadSilently, matches, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

name

@Nonnull
public String name()

Returns:

The command's name

allArguments

@Nonnull
public abstract Arguments allArguments()

Returns:

The arguments this command accepts.

possibleArguments

@Nonnull
public List<Arguments> possibleArguments()

Returns:

A list of possibly mutually-exclusive argument sets for this command.

summary

@Nonnull
public abstract String summary()

Returns:

A single-line summary for the command. Should be 70 characters or less.

commandSection

@Nonnull
public abstract AdminCommandSection commandSection()

Returns:

AdminCommandSection the command using the provider is grouped under

description

@Nonnull
public abstract String description()

Returns:

A description for the command's help text.

create

@Nonnull
public abstract AdminCommand create(Path homeDir,
                                             Path configDir,
                                             OutsideWorld outsideWorld)

printSummary

public final void printSummary(Consumer<String> output)