org.apache.commons.jelly.tags.threads
Class UseMutexTag

java.lang.Object
  extended byorg.apache.commons.jelly.TagSupport
      extended byorg.apache.commons.jelly.tags.threads.UseMutexTag
All Implemented Interfaces:
org.apache.commons.jelly.Tag
Direct Known Subclasses:
NotifyTag, SynchronizeTag, WaitTag

public abstract class UseMutexTag
extends org.apache.commons.jelly.TagSupport

Base class for tags that will "use" mutexes.

Author:
Jason Horman

Field Summary
 
Fields inherited from class org.apache.commons.jelly.TagSupport
body, context, hasTrimmed, parent, shouldTrim
 
Constructor Summary
UseMutexTag()
           
 
Method Summary
 void doTag(org.apache.commons.jelly.XMLOutput output)
          Calls useMutex after checking to make sure that setMutex was called
 java.lang.Object getMutex()
          Get the mutex
 void setMutex(java.lang.Object mutex)
          Set the mutex.
protected abstract  void useMutex(java.lang.Object mutex, org.apache.commons.jelly.XMLOutput output)
          Implement this method to do something with the mutex
 
Methods inherited from class org.apache.commons.jelly.TagSupport
findAncestorWithClass, findAncestorWithClass, findAncestorWithClass, findAncestorWithClass, findAncestorWithClass, findAncestorWithClass, getBody, getBodyText, getBodyText, getContext, getParent, invokeBody, isEscapeText, isTrim, setBody, setContext, setEscapeText, setParent, setTrim, trimBody
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

UseMutexTag

public UseMutexTag()
Method Detail

doTag

public void doTag(org.apache.commons.jelly.XMLOutput output)
           throws org.apache.commons.jelly.JellyTagException
Calls useMutex after checking to make sure that setMutex was called

Throws:
org.apache.commons.jelly.JellyTagException

useMutex

protected abstract void useMutex(java.lang.Object mutex,
                                 org.apache.commons.jelly.XMLOutput output)
                          throws org.apache.commons.jelly.JellyTagException
Implement this method to do something with the mutex

Throws:
org.apache.commons.jelly.JellyTagException

getMutex

public java.lang.Object getMutex()
Get the mutex


setMutex

public void setMutex(java.lang.Object mutex)
Set the mutex. Any object can be used as a mutex.



Copyright © 2002-2006 Apache Software Foundation. All Rights Reserved.