org.apache.commons.jelly
Interface Tag

All Known Subinterfaces:
DynaTag, NamespaceAwareTag
All Known Implementing Classes:
DynaTagSupport, TagSupport

public interface Tag

Tag represents a Jelly custom tag. A Tag is only ever used by a single thread so that Tag developers do not need to concern themselves with mutli-threading issues when writing a Tag. A Tag is created per custom tag in a script, per invocation. So there is no need to worry about pooling errors like those caused in JSP 1.x.(

Version:
$Revision: 155420 $
Author:
James Strachan

Method Summary
 void doTag(XMLOutput output)
          Evaluates this tag after all the tags properties have been initialized.
 Script getBody()
           
 JellyContext getContext()
          Gets the context in which the tag will be run
 Tag getParent()
           
 void invokeBody(XMLOutput output)
          A helper method to invoke this tags body
 void setBody(Script body)
          Sets the body of the tag
 void setContext(JellyContext context)
          Sets the context in which the tag will be run
 void setParent(Tag parent)
          Sets the parent of this tag
 

Method Detail

getParent

public Tag getParent()
Returns:
the parent of this tag

setParent

public void setParent(Tag parent)
Sets the parent of this tag


getBody

public Script getBody()
Returns:
the body of the tag

setBody

public void setBody(Script body)
Sets the body of the tag


getContext

public JellyContext getContext()
Gets the context in which the tag will be run


setContext

public void setContext(JellyContext context)
                throws JellyTagException
Sets the context in which the tag will be run

Throws:
JellyTagException

doTag

public void doTag(XMLOutput output)
           throws MissingAttributeException,
                  JellyTagException
Evaluates this tag after all the tags properties have been initialized.

Throws:
MissingAttributeException
JellyTagException

invokeBody

public void invokeBody(XMLOutput output)
                throws JellyTagException
A helper method to invoke this tags body

Throws:
JellyTagException


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