org.neo4j.shell

Class Session

java.lang.Object

org.neo4j.shell.Session

public class Session
extends Object

A session (or environment) for a shell client.

Constructor Summary

Constructors

Constructor and Description
Session(Serializable id)

Method Summary

Modifier and Type	Method and Description
Map<String,Object>	asMap() Returns the session as a Map representation.
Object	get(String key)
String	getAlias(String key)
Set<String>	getAliasKeys()
Integer	getCommitCount()
String	getCurrent()
Serializable	getId()
String	getMaxTitleLength()
String	getPath()
InterruptSignalHandler	getSignalHandler()
String	getTitleKeys()
boolean	has(String key)
String[]	keys()
Object	remove(String key) Removes a value from the session.
void	removeAlias(String key)
void	set(String key, Object value) Sets a session value.
void	setAlias(String key, String value)
void	setCommitCount(int commitCount)
void	setCurrent(String value)
void	setPath(String path)

Methods inherited from class java.lang.Object

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

Constructor Detail

Session

public Session(Serializable id)

Method Detail

getId

public Serializable getId()

getSignalHandler

public InterruptSignalHandler getSignalHandler()

set

public void set(String key,
                Object value)
         throws ShellException

Sets a session value.

Parameters:

key - the session key.

value - the value.

Throws:

ShellException - if the execution fails

get

public Object get(String key)
           throws ShellException

Parameters:

key - the key to get the session value for.

Returns:

the value for the key or null if not found.

Throws:

ShellException - if the execution fails

has

public boolean has(String key)

Parameters:

key - the key to check the session value for.

Returns:

true if the session contains a variable with that name.

remove

public Object remove(String key)
              throws ShellException

Removes a value from the session.

Parameters:

key - the session key to remove.

Returns:

the removed value, or null if none.

Throws:

ShellException - if the execution fails

keys

public String[] keys()

Returns:

all the available session keys.

asMap

public Map<String,Object> asMap()

Returns the session as a Map representation. Changes in the returned instance won't be reflected in the session.

Returns:

the session as a Map.

removeAlias

public void removeAlias(String key)

setAlias

public void setAlias(String key,
                     String value)

getAliasKeys

public Set<String> getAliasKeys()

getAlias

public String getAlias(String key)

setPath

public void setPath(String path)

getPath

public String getPath()

setCurrent

public void setCurrent(String value)

getCurrent

public String getCurrent()

getCommitCount

public Integer getCommitCount()

setCommitCount

public void setCommitCount(int commitCount)

getTitleKeys

public String getTitleKeys()
                    throws ShellException

Throws:

ShellException

getMaxTitleLength

public String getMaxTitleLength()
                         throws ShellException

Throws:

ShellException