org.neo4j.shell.apps

Class Man

java.lang.Object

org.neo4j.shell.impl.AbstractApp

org.neo4j.shell.apps.Man

All Implemented Interfaces:

App

Direct Known Subclasses:

Help

public class Man
extends org.neo4j.shell.impl.AbstractApp

Prints a short manual for an App.

Field Summary

Fields

Modifier and Type	Field and Description
static int	CONSOLE_WIDTH

Constructor Summary

Constructors

Constructor and Description
Man()

Method Summary

Modifier and Type	Method and Description
Continuation	execute(AppCommandParser parser, Session session, Output out) The actual code for the application.
static Collection<String>	getAvailableCommands(ShellServer server) Lists apps available at the server.
String	getDescription()
static void	printHelpString(Output out, ShellServer server, boolean list) Utility method for getting a short help string for a server.

Methods inherited from class org.neo4j.shell.impl.AbstractApp

completionCandidates, getAvailableOptions, getDescription, getName, getOptionDefinition, getServer, setServer, shutdown, takesOptions

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CONSOLE_WIDTH

public static final int CONSOLE_WIDTH

See Also:

Constant Field Values

Constructor Detail

Man

public Man()

Method Detail

execute

public Continuation execute(AppCommandParser parser,
                            Session session,
                            Output out)
                     throws Exception

Description copied from interface: App

The actual code for the application.

Parameters:

parser - holds the options (w/ or w/o values) as well as arguments.

session - the client session (sort of like the environment for the execution).

out - the output channel for the execution, just like System.out.

Returns:

the result of the execution. It is up to the client to interpret this string, one example is that all apps returns null and the "exit" app returns "e" so that the server interprets the "e" as a sign that it should exit.

Throws:

Exception - if the execution fails.

getDescription

public String getDescription()

Specified by:

getDescription in interface App

Overrides:

getDescription in class org.neo4j.shell.impl.AbstractApp

Returns:

a general description of this application.

printHelpString

public static void printHelpString(Output out,
                                   ShellServer server,
                                   boolean list)
                            throws RemoteException

Utility method for getting a short help string for a server. Basically it contains an introductory message and also lists all available apps for the server.

Parameters:

out - the output

server - the server to ask for

list - if true, a list of the commands is printed

Throws:

RemoteException - in case of remoting errors

getAvailableCommands

public static Collection<String> getAvailableCommands(ShellServer server)

Lists apps available at the server.

Parameters:

server - the ShellServer.

Returns:

a list of available commands a client can execute, whre the server is an AppShellServer.