Module tagtraum.japlscript.executor

Package com.tagtraum.japlscript.execution

Class Session

java.lang.Object

com.tagtraum.japlscript.execution.Session

public class Session
extends Object

Per-thread session. Allows the executions of multiple setters or commands in a single AppleScript snippet, thus saving some roundtrips.

To use,

• call Session session = startSession(); ,
• call any number of setters or commands that don't have return values
• then call session.commit(); to execute all calls in one AppleScript

In order to "rollback" any uncommitted AppleScript fragments, call reset().

Author:

Hendrik Schreiber

Field Summary

Fields

Modifier and Type	Field	Description
static int	DEFAULT_TIMEOUT

Constructor Summary

Constructors

Constructor	Description
Session()	Session.

Method Summary

Modifier and Type	Method	Description
void	add(CharSequence applescriptFragment)	Adds an AppleScript fragment to the session.
void	addAspect(Aspect aspect)
void	commit()	Executes the current script (collection of fragments) and removes the registered session.
static Session	get()	If there is a session associated with the current thread, return that session.
List<Aspect>	getAspects()
String	getScript()	Return the current script or script fragments.
static Session	getSession()	Deprecated, for removal: This API element is subject to removal in a future version.
int	getTimeout()
boolean	isCompile()
boolean	isDefaultTimeout()
boolean	isIgnoreReturnValues()
static boolean	isStarted()	Indicates whether there is already a started session belonging to the current thread.
boolean	removeAspect(Aspect aspect)
void	reset()	Resets the session.
void	setCompile(boolean compile)
void	setIgnoreReturnValues(boolean ignoreReturnValues)
void	setTimeout(int timeout)
static Session	startSession()

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_TIMEOUT

public static final int DEFAULT_TIMEOUT

See Also:

Constant Field Values

Constructor Detail

Session

public Session()

Session.

Method Detail

startSession

public static Session startSession()

addAspect

public void addAspect(Aspect aspect)

removeAspect

public boolean removeAspect(Aspect aspect)

getAspects

public List<Aspect> getAspects()

Returns:

copy of the aspect list

getTimeout

public int getTimeout()

Returns:

timeout in seconds

setTimeout

public void setTimeout(int timeout)

Parameters:

timeout - in seconds

isDefaultTimeout

public boolean isDefaultTimeout()

isIgnoreReturnValues

public boolean isIgnoreReturnValues()

setIgnoreReturnValues

public void setIgnoreReturnValues(boolean ignoreReturnValues)

isCompile

public boolean isCompile()

setCompile

public void setCompile(boolean compile)

add

public void add(CharSequence applescriptFragment)

Adds an AppleScript fragment to the session.

Parameters:

applescriptFragment - AppleScript fragment

reset

public void reset()

Resets the session. All previously added, but uncommitted fragments are lost.

isStarted

public static boolean isStarted()

Indicates whether there is already a started session belonging to the current thread. "Started" means that AppleScript fragments have already been added that would be discarded upon a call of startSession().

Returns:

true, if there is already a started session belonging to this thread

getScript

public String getScript()

Return the current script or script fragments.

Returns:

current script

commit

public void commit()

Executes the current script (collection of fragments) and removes the registered session.

getSession

@Deprecated(forRemoval=true,
            since="3.4.12")
public static Session getSession()

Deprecated, for removal: This API element is subject to removal in a future version.

Deprecated. Use get() instead.

Returns:

this thread's session, or null, if there is none

get

public static Session get()

If there is a session associated with the current thread, return that session. Otherwise return null.

Returns:

this thread's session, or null, if there is none