Apache
/
maven
mirror of https://github.com/apache/maven.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

o fleshing out the plugin configuration guide 

git-svn-id: https://svn.apache.org/repos/asf/maven/components/trunk@306886 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Jason van Zyl 2005-10-06 21:01:23 +00:00
parent 864809556a
commit a7d3f7adf0
1 changed files with 50 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

54
maven-site/src/site/apt/guides/mini/guide-configuring-plugins.apt
View File

@ -68,6 +68,56 @@ public class MyQueryMojo
<<<options>>> element maps to the <<<options>>> field. The mapping mechanism can deal with arrays by inspecting <<<options>>> element maps to the <<<options>>> field. The mapping mechanism can deal with arrays by inspecting
the type of the field and determining if a suitable mapping is possible. the type of the field and determining if a suitable mapping is possible.
* Mapping complex objects
Mapping complex types is also fairly straight forward in Maven so let's look at a simple example where we
are trying to map a configuration for Person object. The <<<configuration>>> element might look like the
following:
+----+
...
<configuration>
<person>
<firstName>Jason</firstName>
<lastName>van Zyl</lastName>
</person>
</configuration>
...
+----+
The rules for mapping complex objects are as follows:
* There must be a private field that corresponds to name of the element being mapped. So in our case the
<<<person>>> element must map to a <<<person>>> field.
* The object instantiated must be in the same package as the Mojo itself. So if your mojo is in
<<<com.mycompany.mojo.query>>> then the mapping mechanism will look in that package for an
object named <<<Person>>>. As you can see the mechanism will capitalize the first letter of
the element name and use that to search for the object to instantiate.
* If you wish to have the object to be instantiated live in a different package or have a more
complicated name then you must specify this using an <<<implementation>>> attribute like the
following:
[]
+----+
...
<configuration>
<person implementation="com.mycompany.mojo.query.SuperPerson">
<firstName>Jason</firstName>
<lastName>van Zyl</lastName>
</person>
</configuration>
...
+----+
* Mapping to collections * Mapping to collections
The configuration mapping mechanism can easily deal with most collections so let's go through a few examples The configuration mapping mechanism can easily deal with most collections so let's go through a few examples
@ -75,14 +125,10 @@ public class MyQueryMojo
** Mapping lists ** Mapping lists
** Mapping maps ** Mapping maps
** Mapping properties ** Mapping properties
* Mapping complex objects
* Using setters * Using setters
You are not restricted to using private field mapping which is good if you are trying to make you Mojos resuable You are not restricted to using private field mapping which is good if you are trying to make you Mojos resuable