org.apache.maven.jelly.tags.maven

Class ReactorTag

java.lang.Object

org.apache.commons.jelly.TagSupport

org.apache.maven.jelly.tags.BaseTagSupport

org.apache.maven.jelly.tags.maven.MavenTag

org.apache.maven.jelly.tags.maven.ReactorTag

All Implemented Interfaces:

org.apache.commons.jelly.Tag

public class ReactorTag
extends MavenTag

Reactor tag that processes a set of project descriptors taking into consideration the inter-project dependencies.

Used for building a set of projects in the correct order to satisfy any dependencies among the projects being processed.

Version:

$Id: ReactorTag.java 517014 2007-03-11 21:15:50Z ltheussl $

Author:

bob mcwhirter, Jason van Zyl, Emmanuel Venisse

To Do:

We use the basedir for the glob, but we need to set the descriptor., better use of inheritance from MavenTag

Field Summary

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

body, context, hasTrimmed, parent, shouldTrim

Constructor Summary

Constructors

Constructor and Description
ReactorTag()

Method Summary

Methods

Modifier and Type	Method and Description
void	afterLaunchGoals(Project project) This method is running after launching project goals.
void	afterProject(Project project) This method is running after launching a project.
void	beforeLaunchGoals(Project project) This method is running before launching project goals.
void	beforeProject(Project project) This method is running before launching a project.
void	doTag(org.apache.commons.jelly.XMLOutput output) Execute the body of the reactor tag.
java.lang.String	getBanner() Get the banner to be displayed for project while it is being processed.
java.io.File	getBasedir() Getter for the basedir property
java.lang.String	getExcludes() Get the excludes used to find projects.
java.lang.String	getGlob() Get the glob used to find projects.
java.lang.String	getIncludes() Get the includes used to find projects.
boolean	getPostProcessing() Get the postProcessing attribute.
java.util.List	getProjectList() Get the project list.
void	onDependencyResolutionException(java.lang.Exception e) This method is running when an exception occurs in dependency resolution.
void	onException(Project project, java.lang.Exception e) This method is running when an exception occurs whatever the ignoreFailures value.
void	setBanner(java.lang.String banner) Set the banner to be displayed for each project while it is being processed.
void	setBasedir(java.io.File basedir) Setter for the basedir property XXX if the method it overrides is deprecated, is this also deprecated?
void	setCollectionVar(java.lang.String collectionVar) Set the collectionVar attribute.
void	setCollectOnly(boolean collectOnly) Set the collectOnly attribute.
void	setExcludes(java.lang.String excludes) Set the excludes used to find projects.
void	setGlob(java.lang.String glob) Deprecated. Use includes/excludes instead.
void	setIncludes(java.lang.String includes) Set the includes used to find projects.
void	setPostProcessing(boolean postProcessing) Set the postProcessing attribute.
void	setProjectList(java.util.List projectList) Set the project list.
void	setSort(boolean sort)

Methods inherited from class org.apache.maven.jelly.tags.maven.MavenTag

getDescriptor, getGoals, isIgnoreFailures, setDescriptor, setGoals, setIgnoreFailures

Methods inherited from class org.apache.maven.jelly.tags.BaseTagSupport

checkAttribute, getMavenContext

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

ReactorTag

public ReactorTag()

Method Detail

setProjectList

public void setProjectList(java.util.List projectList)

Set the project list.

Parameters:

projectList - the project list

getProjectList

public java.util.List getProjectList()

Get the project list.

Returns:

the project list

setBasedir

public void setBasedir(java.io.File basedir)

Setter for the basedir property XXX if the method it overrides is deprecated, is this also deprecated?

Overrides:

setBasedir in class MavenTag

Parameters:

basedir - the base directory for execution of the project

getBasedir

public java.io.File getBasedir()

Getter for the basedir property

Returns:

the base directory for execution of the project

setSort

public void setSort(boolean sort)

setCollectOnly

public void setCollectOnly(boolean collectOnly)

Set the collectOnly attribute. This controls whether reactor will actually execute any goals on the projects, or simply collect the sorted set of projects included in this reactor invocation.

Parameters:

collectOnly - if true, don't execute project goals; simply gather the sorted project collection and store. Otherwise, operate as before (execute either specified goals or default goal for each project).

setCollectionVar

public void setCollectionVar(java.lang.String collectionVar)

Set the collectionVar attribute. This controls the context variable which will contain the sorted set of projects included in this reactor invocation.

Parameters:

collectionVar - The context variable for the project collection discovered here.

setPostProcessing

public void setPostProcessing(boolean postProcessing)

Set the postProcessing attribute.

Parameters:

postProcessing -

getPostProcessing

public boolean getPostProcessing()

Get the postProcessing attribute.

Returns:

The

setGlob

public void setGlob(java.lang.String glob)

Deprecated. Use includes/excludes instead.

Set the glob used to find projects.

Parameters:

glob - The glob used to find projects.

getGlob

public java.lang.String getGlob()

Get the glob used to find projects.

Returns:

String The glob.

setIncludes

public void setIncludes(java.lang.String includes)

Set the includes used to find projects.

Parameters:

includes - The includes used to find projects.

getIncludes

public java.lang.String getIncludes()

Get the includes used to find projects.

Returns:

String The includes.

setExcludes

public void setExcludes(java.lang.String excludes)

Set the excludes used to find projects.

Parameters:

excludes - The excludes used to find projects.

getExcludes

public java.lang.String getExcludes()

Get the excludes used to find projects.

Returns:

String The excludes.

setBanner

public void setBanner(java.lang.String banner)

Set the banner to be displayed for each project while it is being processed.

Parameters:

banner - The banner to use for each processed project.

getBanner

public java.lang.String getBanner()

Get the banner to be displayed for project while it is being processed.

Returns:

String The banner.

doTag

public void doTag(org.apache.commons.jelly.XMLOutput output)
           throws org.apache.commons.jelly.MissingAttributeException,
                  org.apache.commons.jelly.JellyTagException

Execute the body of the reactor tag.

Specified by:

doTag in interface org.apache.commons.jelly.Tag

Overrides:

doTag in class MavenTag

Parameters:

output - The output sink.

Throws:

org.apache.commons.jelly.JellyTagException - If an error occurs while processing the tag.

org.apache.commons.jelly.MissingAttributeException

beforeProject

public void beforeProject(Project project)

This method is running before launching a project.

Parameters:

project - the currentProject

beforeLaunchGoals

public void beforeLaunchGoals(Project project)

This method is running before launching project goals.

Parameters:

project - the currentProject

afterLaunchGoals

public void afterLaunchGoals(Project project)

This method is running after launching project goals.

Parameters:

project - the currentProject

afterProject

public void afterProject(Project project)

This method is running after launching a project.

Parameters:

project - the currentProject

onException

public void onException(Project project,
               java.lang.Exception e)

This method is running when an exception occurs whatever the ignoreFailures value.

Parameters:

project - the currentProject

e - the exception

onDependencyResolutionException

public void onDependencyResolutionException(java.lang.Exception e)

This method is running when an exception occurs in dependency resolution.

Parameters:

e - the exception