Maven 1.x - Tag Documentation

Tag Documentation

The following document contains a summary of all theJellytag libraries.

Tag Libraries

Library	Description
jelly:jeez	This tag library groups together the ant and werkz tag libraries into one namespace.This allows Maven scripts to set this as the default namespace to avoid folks having to usenamespace prefixes for common stuff.
jelly:maven	Various jelly tags provided by Maven to allow easier access its facilities.
jelly:tags	Shared code across the jelly taglibs provided by Maven.
jelly:werkz	Extensions to Werkz .

jelly:jeez

This tag library groups together the ant and werkz tag libraries into one namespace.This allows Maven scripts to set this as the default namespace to avoid folks having to usenamespace prefixes for common stuff.

Tag Name	Description
tagDef	This tag defines a dynamic tag in Jelly script. When the tag is invokedany attributes will be passed in as variables and the definition of thetag can use <define:invokeBody&gtto invoke its body. This tag is similar to the <define:tag>tag in the definetag library.
target	Wraps a Werkz `<goal>` to appear as anant `<target>` .

jelly:maven

Various jelly tags provided by Maven to allow easier access its facilities.

Tag Name	Description
addPath	This class takes a given path using an `id` and appends anotherpath (using `refid` ) to it.
concat	Concat a set of files together into a single file.
copyResources	A tag to copy resources to a given directory
get	A tag to retrieve values from plugins
input	Concat a set of files together into a single file.
installPlugin	A Maven Jelly tag that will install a given plugin JAR using the plugin manager.
makeAbsolutePath	Jelly tag to convert a relative path into an absolute path by prepending the basedir if itis relative.
makeRelativePath	Jelly tag to convert an absolute path into a relative path by removing the basedir.
maven	A way of running maven as a Jelly tag get rid of 'throws Exception'
paramCheck	A tag to check parameters are being passed correctly
pluginVar	A tag to retrieve values from plugins replaced by the GetTag tag
pom	MavenSession Jelly tag that creates a POM instance.By default, the inheritance in the POM isn't used.You must use the attribute useInheritance to activate it.
property	A Maven Jelly tag that attempts to retrieve a property from the MavenJellyContextcontext and uses the provided default value in the event there is no valid valueretrieved using the key name provided. You may also optionally provide the nameyou would like to give the resultant property in the MavenJellyContext.
reactor	Reactor tag that processes a set of project descriptors taking intoconsideration the inter-project dependencies. Used for building a set of projects in the correct order to satisfy anydependencies among the projects being processed. We use the basedir for the glob, but we need to set the descriptor. better use of inheritance from MavenTag
rootRelativePath	Converts an absolute path into a path relative to a root dir. Forexample, if the root dir is "c:/apps/myproject" and the absolutepath is "c:/apps/myproject/path/subproject2" then the computedrelative path is "../..".
set	A tag to set plugin values
snapshotSignature	Create snapshot signature for non-release JARs and distributions.
uninstallPlugin	A Maven Jelly tag that will uninstall a given plugin JAR using the plugin manager.
userCheck	A tag to check if a user name is set.

jelly:tags

Shared code across the jelly taglibs provided by Maven.

Tag Name	Description

jelly:werkz

Extensions to Werkz .

Tag Name	Description
mavenAttainGoal	Replacement for werkz's `AttainGoalTag` which will lazy initialise goals.
mavenGoal	Replacement for werkz's `GoalTag` which does not allow a goalto be redefined once defined.For Jelly scripts that are run which contain this tag it is assumed thatthey are being run in the order whereby the first definition wins.

Tags

[tag libraries] [tags]

jeez:tagDef

This tag defines a dynamic tag in Jelly script. When the tag is invokedany attributes will be passed in as variables and the definition of thetag can use <define:invokeBody&gtto invoke its body.

This tag is similar to the <define:tag>tag in the definetag library.

Attribute Name	Type	Description
escapeText	boolean
name	java.lang.String
trim	boolean

jeez:target

Wraps a Werkz <goal> to appear as anant <target> .

Attribute Name	Type	Description
depends	java.lang.String
description	java.lang.String
escapeText	boolean
name	java.lang.String	Sets the name of the target
prereqs	java.lang.String
trim	boolean

maven:addPath

This class takes a given path using an id and appends anotherpath (using refid ) to it.

Attribute Name	Type	Description
escapeText	boolean
id	java.lang.String	Setter for the id property
refid	java.lang.String	Setter for the refid property
trim	boolean

maven:concat

Concat a set of files together into a single file.

Attribute Name	Type	Description
basedir	java.io.File	Setter for the basedir property You only need to specify the project descriptor.
descriptor	java.io.File	Setter for the descriptor property
escapeText	boolean
goals	java.lang.String	Setter for the goals property
ignoreFailures	boolean	Set the ignore failures flag.
outputFile	java.io.File	Set output file.
trim	boolean

maven:copyResources

A tag to copy resources to a given directory

Attribute Name	Type	Description
escapeText	boolean
resources	java.util.List
todir	java.lang.String
trim	boolean

maven:get

A tag to retrieve values from plugins

Attribute Name	Type	Description
escapeText	boolean
plugin	java.lang.String
property	java.lang.String
trim	boolean
var	java.lang.String

maven:input

Concat a set of files together into a single file.

Attribute Name	Type	Description
basedir	java.io.File	Setter for the basedir property You only need to specify the project descriptor.
descriptor	java.io.File	Setter for the descriptor property
escapeText	boolean
file	java.io.File	Set output file.
goals	java.lang.String	Setter for the goals property
ignoreFailures	boolean	Set the ignore failures flag.
trim	boolean

maven:installPlugin

A Maven Jelly tag that will install a given plugin JAR using the plugin manager.

Attribute Name	Type	Description
cache	boolean
escapeText	boolean
file	java.io.File
trim	boolean

maven:makeAbsolutePath

Jelly tag to convert a relative path into an absolute path by prepending the basedir if itis relative.

Attribute Name	Type	Description
basedir	java.io.File	Set the base directory.
escapeText	boolean
path	java.lang.String	Set the path.
trim	boolean
var	java.lang.String	Set the result variable.

maven:makeRelativePath

Jelly tag to convert an absolute path into a relative path by removing the basedir.

Attribute Name	Type	Description
basedir	java.io.File	Set the base directory.
escapeText	boolean
path	java.lang.String	Set the path. This has to be absolute under basedir.
separator	java.lang.String	Set the path separator to use.
trim	boolean
var	java.lang.String	Set the result variable. Returns path if path is not absolute under basedir.

maven:maven

A way of running maven as a Jelly tag get rid of 'throws Exception'

Attribute Name	Type	Description
basedir	java.io.File	Setter for the basedir property You only need to specify the project descriptor.
descriptor	java.io.File	Setter for the descriptor property
escapeText	boolean
goals	java.lang.String	Setter for the goals property
ignoreFailures	boolean	Set the ignore failures flag.
trim	boolean

maven:paramCheck

A tag to check parameters are being passed correctly

Attribute Name	Type	Description
escapeText	boolean
fail	boolean
message	java.lang.String
trim	boolean
value	java.lang.String

maven:pluginVar

A tag to retrieve values from plugins replaced by the GetTag tag

Attribute Name	Type	Description
escapeText	boolean
plugin	java.lang.String	replaced by the GetTag tag
property	java.lang.String	replaced by the GetTag tag
trim	boolean
var	java.lang.String	replaced by the GetTag tag

maven:pom

MavenSession Jelly tag that creates a POM instance.By default, the inheritance in the POM isn't used.You must use the attribute useInheritance to activate it.

Attribute Name	Type	Description
escapeText	boolean
projectDescriptor	java.io.File	Set MavenSession project descriptor.
trim	boolean
useInheritance	boolean	Define if the pom must use the inheritance. Setted to false by default to keep a backward compatibility.
var	java.lang.String	Set var name for the POM.

maven:property

A Maven Jelly tag that attempts to retrieve a property from the MavenJellyContextcontext and uses the provided default value in the event there is no valid valueretrieved using the key name provided. You may also optionally provide the nameyou would like to give the resultant property in the MavenJellyContext.

Attribute Name	Type	Description
defaultValue	java.lang.String
escapeText	boolean
name	java.lang.String
trim	boolean
var	java.lang.String

maven:reactor

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

Used for building a set of projects in the correct order to satisfy anydependencies among the projects being processed. We use the basedir for the glob, but we need to set the descriptor. better use of inheritance from MavenTag

Attribute Name	Type	Description
banner	java.lang.String	Set the banner to be displayed for each project whileit is being processed.
basedir	java.io.File	Setter for the basedir propertyXXX if the method it overrides is deprecated, is this also deprecated?
basedir	java.io.File	Setter for the basedir property You only need to specify the project descriptor.
collectOnly	boolean	Set the collectOnly attribute. This controls whether reactorwill actually execute any goals on the projects, or simplycollect the sorted set of projects included in this reactorinvocation.
collectionVar	java.lang.String	Set the collectionVar attribute. This controls the contextvariable which will contain the sorted set of projects includedin this reactor invocation.
descriptor	java.io.File	Setter for the descriptor property
escapeText	boolean
excludes	java.lang.String	Set the excludes used to find projects.
glob	java.lang.String	Set the glob used to find projects. Use includes/excludes instead.
goals	java.lang.String	Setter for the goals property
ignoreFailures	boolean	Set the ignore failures flag.
includes	java.lang.String	Set the includes used to find projects.
postProcessing	boolean	Set the postProcessing attribute.
projectList	java.util.List	Set the project list.
sort	boolean
trim	boolean

maven:rootRelativePath

Converts an absolute path into a path relative to a root dir. Forexample, if the root dir is "c:/apps/myproject" and the absolutepath is "c:/apps/myproject/path/subproject2" then the computedrelative path is "../..".

Attribute Name	Type	Description
escapeText	boolean
path	java.lang.String	Set the path.
rootdir	java.io.File	Set the root directory.
trim	boolean
var	java.lang.String	Set the result variable.

maven:set

A tag to set plugin values

Attribute Name	Type	Description
escapeText	boolean
plugin	java.lang.String
property	java.lang.String
trim	boolean
value	java.lang.Object

maven:snapshotSignature

Create snapshot signature for non-release JARs and distributions.

Attribute Name	Type	Description
escapeText	boolean
project	org.apache.maven.project.Project	Set the maven project object.
trim	boolean

maven:uninstallPlugin

A Maven Jelly tag that will uninstall a given plugin JAR using the plugin manager.

Attribute Name	Type	Description
artifactId	java.lang.String
escapeText	boolean
trim	boolean

maven:userCheck

A tag to check if a user name is set.

Attribute Name	Type	Description
escapeText	boolean
trim	boolean
user	java.lang.String

werkz:mavenAttainGoal

Replacement for werkz's AttainGoalTag which will lazy initialise goals.

Attribute Name	Type	Description
escapeText	boolean
name	java.lang.String
trim	boolean

werkz:mavenGoal

Replacement for werkz's GoalTag which does not allow a goalto be redefined once defined.For Jelly scripts that are run which contain this tag it is assumed thatthey are being run in the order whereby the first definition wins.

Attribute Name	Type	Description
description	java.lang.String
escapeText	boolean
name	java.lang.String	Sets the name of the target
prereqs	java.lang.String
trim	boolean

About Maven 1.x

User's Guide

Resources

Project Documentation

Legend