Threads Tag Library - Tag Documentation

Tag Documentation

The following document contains a summary of all theJellytag libraries.

Tag Libraries

Library	Description
jelly:threads	A library for processing Jelly scripts using multiple threads.

jelly:threads

A library for processing Jelly scripts using multiple threads.

Tag Name	Description
group	Represents a group of threads. This is not the same as Java's thread groups.All of the threads in a thread group are started at the same time, not as theyare defined. Use this in conjunction with other tags like join to manipulatea group of threads.
interrupt	Interrupts a thread or thread group.
join	A thread join waits until a thread or threadGroup is complete.
mutex	Creates a mutex object and stores it in a variable
notify	This calls mutex.notify() or mutex.notifyAll() on the mutex passedin via the "mutex" attribute.
sleep	Puts the current thread to sleep for some amount of time.
synchronize	Synchronize a block inside of a thread using the passed in mutex. Themutex object passed in does not have to have been created using themutex tag, it can be any object at all.
thread	A tag that spawns the contained script in a separate thread. A threadcan wait on another thread or another thread group to finish before starting.
wait	This calls mutex.wait() on the mutex passed in via the "mutex" attribute.
waitFor	This tag creates a dependency on another thread. If onlyWait is seta org.apache.commons.jelly.tags.threads.TimeoutExceptioncan be thrown. If status is set a org.apache.commons.jelly.tags.threads.RequirementExceptioncan be thrown.

Represents a group of threads. This is not the same as Java's thread groups.All of the threads in a thread group are started at the same time, not as theyare defined. Use this in conjunction with other tags like join to manipulatea group of threads.

Attribute Name	Type	Description
escapeText	boolean
trim	boolean
var	java.lang.String	Set the variable name to store the thread group in

threads:interrupt

Interrupts a thread or thread group.

Attribute Name	Type	Description
escapeText	boolean
searchForParentThread	boolean	If true the tag will search for a parent thread tag to "use" ifno thread was set via setThread . This is true by default.
thread	java.lang.Thread	Set the thread to use in some way.
threadGroup	java.util.List	Set the thread group to "use".
trim	boolean

threads:join

A thread join waits until a thread or threadGroup is complete.

Attribute Name	Type	Description
escapeText	boolean
searchForParentThread	boolean	If true the tag will search for a parent thread tag to "use" ifno thread was set via setThread . This is true by default.
thread	java.lang.Thread	Set the thread to use in some way.
threadGroup	java.util.List	Set the thread group to "use".
timeout	long	How long should the join wait. If <= 0 the join waits until thethread is dead.
trim	boolean

threads:mutex

Creates a mutex object and stores it in a variable

Attribute Name	Type	Description
escapeText	boolean
trim	boolean
var	java.lang.String	Sets the variable name to export

threads:notify

This calls mutex.notify() or mutex.notifyAll() on the mutex passedin via the "mutex" attribute.

Attribute Name	Type	Description
escapeText	boolean
mutex	java.lang.Object	Set the mutex. Any object can be used as a mutex.
notifyAll	boolean	If set to true the notify will notify all waiting threads
trim	boolean

threads:sleep

Puts the current thread to sleep for some amount of time.

Attribute Name	Type	Description
escapeText	boolean
for	long	How long to put the thread to sleep for
trim	boolean

threads:synchronize

Synchronize a block inside of a thread using the passed in mutex. Themutex object passed in does not have to have been created using themutex tag, it can be any object at all.

Attribute Name	Type	Description
escapeText	boolean
mutex	java.lang.Object	Set the mutex. Any object can be used as a mutex.
trim	boolean

threads:thread

A tag that spawns the contained script in a separate thread. A threadcan wait on another thread or another thread group to finish before starting.

Attribute Name	Type	Description
daemon	boolean	Sets the thread to be a daemon thread if true
escapeText	boolean
file	java.lang.String	Set the file which is generated from the output
name	java.lang.String	Sets the name of the thread.
newContext	boolean	Should a new context be created for this thread?
priority	int	Set the threads priority. Defaults to Thread.NORM_PRIORITY
trim	boolean
var	java.lang.String	Sets the variable name to export, optional
xmlOutput	org.apache.commons.jelly.XMLOutput	Sets the destination of output

threads:wait

This calls mutex.wait() on the mutex passed in via the "mutex" attribute.

Attribute Name	Type	Description
escapeText	boolean
mutex	java.lang.Object	Set the mutex. Any object can be used as a mutex.
timeout	long	Set how long the wait should last. If <= 0 the wait will lastuntil a notify occurs.
trim	boolean

threads:waitFor

This tag creates a dependency on another thread. If onlyWait is seta org.apache.commons.jelly.tags.threads.TimeoutExceptioncan be thrown. If status is set a org.apache.commons.jelly.tags.threads.RequirementExceptioncan be thrown.

Attribute Name	Type	Description
escapeText	boolean
group	java.util.List	Set the group of threads to wait on
onlyWait	long	Set how long to wait for the thread to finish. If waiting for a groupthis will be the time to wait for each thread in the group to finish.
status	java.lang.String	Wait for a specific status. "SUCCESS", "FAILURE", "TIMED_OUT", or "AVOIDED". Ifwaiting on a thread group each thread in the group will have to have this statusset.
thread	org.apache.commons.jelly.tags.threads.JellyThread	Which thread will this tag check the status of
trim	boolean