org.neo4j.shell

Interface App

All Known Implementing Classes:

org.neo4j.shell.impl.AbstractApp, Alias, Begin, Call, Cd, Commit, Create, Cypher, Dbinfo, Drop, Dump, Env, Explain, Export, Foreach, Gsh, Gsh, Help, IndexProviderShellApp, Jsh, Jsh, Load, Ls, Man, Match, Merge, Mknode, Mkrel, Mv, NonTransactionProvidingApp, NoopApp, Optional, PathShellApp, Planner, Profile, Pwd, Return, Rm, Rmnode, Rmrel, Rollback, Runtime, Schema, Set, Start, TransactionProvidingApp, Trav, Unwind, Using, With

public interface App

A completely server-side "application", sort of like a unix application (just like "ls" or "cd"). The API lets you define expected arguments and options which are required or optional.

Method Summary

Modifier and Type	Method and Description
List<String>	completionCandidates(String partOfLine, Session session) Tries to complete the partOfLine with likely candidates, think of this as a hook for writing TAB-completion.
Continuation	execute(AppCommandParser parser, Session session, Output out) The actual code for the application.
String[]	getAvailableOptions()
String	getDescription()
String	getDescription(String option)
String	getName()
OptionDefinition	getOptionDefinition(String option)
AppShellServer	getServer() Returns the server this app runs in.
void	shutdown() Put code here which will need to run before the shell server is shut down
boolean	takesOptions()

Method Detail

getName

String getName()

Returns:

the name of the application.

getOptionDefinition

OptionDefinition getOptionDefinition(String option)

Parameters:

option - the name of the option. An option could be like this: "ls -l" where "l" is an option.

Returns:

the option definition for option.

getAvailableOptions

String[] getAvailableOptions()

Returns:

the available options.

execute

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

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.

getServer

AppShellServer getServer()

Returns the server this app runs in.

Returns:

the server this app runs in.

getDescription

String getDescription()

Returns:

a general description of this application.

getDescription

String getDescription(String option)

Parameters:

option - the option to get the description for.

Returns:

a description of a certain option.

shutdown

void shutdown()

Put code here which will need to run before the shell server is shut down

completionCandidates

List<String> completionCandidates(String partOfLine,
                                  Session session)
                           throws ShellException

Tries to complete the partOfLine with likely candidates, think of this as a hook for writing TAB-completion. Returned candidates should contain the supplied part as well as possible completions. Implementing this is optional and it's OK to just return an empty list.

Parameters:

partOfLine - the part of the line which the client wants to complete using TAB-completion.

session - the Session from the client caller.

Returns:

a list of candidates which includes the supplied partOfLine as well as possible completions. Returns an empty list if no completions found or if the implementing class chooses not to implement it properly.

Throws:

ShellException - if the execution fails

takesOptions

boolean takesOptions()