org.apache.maven.werkz.jelly
Class GoalTag

java.lang.Object
  org.apache.commons.jelly.TagSupport
      org.apache.maven.werkz.jelly.WerkzTagSupport
          org.apache.maven.werkz.jelly.GoalTag

All Implemented Interfaces:

Tag

Direct Known Subclasses:

MavenGoalTag, TargetTag

public class GoalTag

extends WerkzTagSupport

Implements a <target> tag which is similar to the Ant equivalent tag but is based on the Werkz goal engine.

Version:

$Revision: 1.3 $

Author:

James Strachan

Field Summary

Fields inherited from class org.apache.commons.jelly.TagSupport

body, context, hasTrimmed, parent, shouldTrim

Constructor Summary

GoalTag()

Method Summary

protected void	addPrereqs(Goal goal)
void	doTag(XMLOutput output) Evaluate the body to register all the various goals and pre/post conditions then run all the current targets
protected Action	getAction() Subclasses can override this template method to provide a custom Action implementation.
java.lang.String	getName()
java.lang.String	getPrereqs()
void	setDescription(java.lang.String description)
void	setName(java.lang.String name) Sets the name of the target
void	setPrereqs(java.lang.String prereqs)

Methods inherited from class org.apache.maven.werkz.jelly.WerkzTagSupport

getGoal, getProject

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

GoalTag

public GoalTag()

Method Detail

doTag

public void doTag(XMLOutput output)
           throws JellyTagException

Evaluate the body to register all the various goals and pre/post conditions then run all the current targets

Throws:

JellyTagException

getName

public java.lang.String getName()

Returns:

the name of the target

setName

public void setName(java.lang.String name)

Sets the name of the target

setPrereqs

public void setPrereqs(java.lang.String prereqs)

getPrereqs

public java.lang.String getPrereqs()

setDescription

public void setDescription(java.lang.String description)

addPrereqs

protected void addPrereqs(Goal goal)
                   throws CyclicGoalChainException

Throws:

CyclicGoalChainException

getAction

protected Action getAction()

Subclasses can override this template method to provide a custom Action implementation. This scenerio will most likely come into play when you have also created a custom Session implementation that can be used to provide parameters during the attainment of a Goal.