org.neo4j.commandline.admin

Class HelpCommandProvider

java.lang.Object

org.neo4j.helpers.Service

org.neo4j.commandline.admin.AdminCommand.Provider

org.neo4j.commandline.admin.HelpCommandProvider

public class HelpCommandProvider
extends AdminCommand.Provider

Nested Class Summary

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

org.neo4j.helpers.Service.Implementation

Constructor Summary

Constructors

Constructor and Description
HelpCommandProvider(Usage usage)

Method Summary

Modifier and Type	Method and Description
Arguments	allArguments()
AdminCommandSection	commandSection()
AdminCommand	create(Path homeDir, Path configDir, OutsideWorld outsideWorld)
String	description()
String	summary()

Methods inherited from class org.neo4j.commandline.admin.AdminCommand.Provider

name, possibleArguments, printSummary

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

Constructor Detail

HelpCommandProvider

public HelpCommandProvider(Usage usage)

Method Detail

allArguments

@Nonnull
public Arguments allArguments()

Specified by:

allArguments in class AdminCommand.Provider

Returns:

The arguments this command accepts.

description

@Nonnull
public String description()

Specified by:

description in class AdminCommand.Provider

Returns:

A description for the command's help text.

summary

@Nonnull
public String summary()

Specified by:

summary in class AdminCommand.Provider

Returns:

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

commandSection

@Nonnull
public AdminCommandSection commandSection()

Specified by:

commandSection in class AdminCommand.Provider

Returns:

AdminCommandSection the command using the provider is grouped under

create

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

Specified by:

create in class AdminCommand.Provider