org.neo4j.shell.kernel.apps.cypher

Class Dump

java.lang.Object

org.neo4j.shell.impl.AbstractApp

org.neo4j.shell.kernel.apps.TransactionProvidingApp

org.neo4j.shell.kernel.apps.cypher.Start

org.neo4j.shell.kernel.apps.cypher.Dump

All Implemented Interfaces:

App

public class Dump
extends Start

Constructor Summary

Constructors

Constructor and Description
Dump()

Method Summary

Modifier and Type	Method and Description
Continuation	execute(AppCommandParser parser, Session session, Output out) The actual code for the application.
String	getDescription()

Methods inherited from class org.neo4j.shell.kernel.apps.TransactionProvidingApp

completionCandidates, getCurrent, getDisplayName, getDisplayName, getDisplayName, getDisplayName, getDisplayNameForNonExistent, getServer, isCurrent, readCurrentWorkingDir, withArrows, writeCurrentWorkingDir

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

Dump

public Dump()

Method Detail

getDescription

public String getDescription()

Specified by:

getDescription in interface App

Overrides:

getDescription in class Start

Returns:

a general description of this application.

execute

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

Description copied from interface: App

The actual code for the application.

Specified by:

execute in interface App

Overrides:

execute in class Start

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.