Package au.com.forward.threads

See the ThreadReturn class for a description of this package.

See:
Description

Interface Summary

ThreadListener

A listener for thread termination events.

Class Summary

StackTrace	The static toString(Throwable t) method of this class is used to retrieve the contents of an exception's stack trace as a String.
ThreadEvent	This class encapsulates a Thread termination event.
ThreadReturn	This is the main class of this package and contains the static methods for handling threads.
TimeOut	This class sets a timeout time which can by used by mulitple join() statements to specify the total time required for a number of threads to complete.

Exception Summary

ThreadException	An exception of this class, or its sub-class ThreadInterruptedException, is thrown by the ThreadReturn.join() methods when the thread being joined saves a Throwable.
ThreadInterruptedException	An exception of this class is thrown by the ThreadReturn.join() methods when the thread being joined throws an InterruptedException or a ClosedByInterruptException.
TimedOutException	An exception of this class is thrown by the ThreadReturn.join() methods when the join() times out before the thread being joined dies.

Package au.com.forward.threads Description

See the ThreadReturn class for a description of this package.

The ThreadReturn class contains a number of static methods that allow you to

• return a result from a thread, ThreadReturn.save(Object) and ThreadReturn.join()
• catch exceptions thrown by a thread and re-throw them in the 'calling' thread, ThreadReturn.save(Object) and ThreadReturn.join()
• stop a thread by calling its interrupt() method, ThreadReturn.ifInterruptedStop()
• add ThreadListeners threads to be called when the thread has died, ThreadReturn.addListener(Thread, ThreadListener)

Licence Agreement

ThreadReturn package Copyright (c) 2003 Forward Computing and Control Pty. Ltd.
NSW. Australia,  www.forward.com.au
All rights reserved.

Redistribution of the source of this package, with or without
modification, is NOT permitted.

Redistribution of the compiled java .class files of this package, with or without
modification, are permitted provided that the following conditions
are met:
1. Redistributions in compiled java .class form must reproduce the above
   copyright notice, this list of conditions and the following disclaimer
   in the documentation and/or other materials provided with the distribution.
2. If the software is modified, the compiled java .class distribution must
   include, in the documentation and/or other materials provided with the 
   distribution, a statement that the software has been modified and
   identify the person who was responsable for the modifications.  
3. The name of the author may not be used to endorse or promote products
   derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.