2006-09-11 04:19:00 +00:00
|
|
|
<!--
|
|
|
|
|
Licensed to the Apache Software Foundation (ASF) under one or more
|
|
|
|
|
contributor license agreements. See the NOTICE file distributed with
|
|
|
|
|
this work for additional information regarding copyright ownership.
|
|
|
|
|
The ASF licenses this file to You under the Apache License, Version 2.0
|
|
|
|
|
(the "License"); you may not use this file except in compliance with
|
|
|
|
|
the License. You may obtain a copy of the License at
|
|
|
|
|
|
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
|
|
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
|
|
|
distributed under the License is distributed on an "AS IS" BASIS,
|
|
|
|
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
|
|
|
See the License for the specific language governing permissions and
|
|
|
|
|
limitations under the License.
|
|
|
|
|
-->
|
2003-08-13 08:35:50 +00:00
|
|
|
<html>
|
|
|
|
|
<head>
|
2018-02-08 16:59:52 +01:00
|
|
|
<meta http-equiv="Content-Language" content="en-us">
|
2005-04-29 18:58:16 +00:00
|
|
|
<link rel="stylesheet" type="text/css" href="../stylesheets/style.css">
|
2003-09-23 11:35:53 +00:00
|
|
|
<title>Custom Components</title>
|
2003-08-13 08:35:50 +00:00
|
|
|
</head>
|
|
|
|
|
<body>
|
|
|
|
|
<h2>Custom Components</h2>
|
|
|
|
|
<h3>Overview</h3>
|
|
|
|
|
<p>
|
|
|
|
|
Custom components are conditions, selectors, filters and other
|
2010-11-11 17:04:16 +00:00
|
|
|
objects that are defined outside Apache Ant core.
|
2003-08-13 08:35:50 +00:00
|
|
|
</p>
|
|
|
|
|
<p>
|
|
|
|
|
In Ant 1.6 custom conditions, selectors and filters has
|
|
|
|
|
been overhauled.
|
|
|
|
|
</p>
|
|
|
|
|
<p>
|
|
|
|
|
It is now possible to define custom conditions, selectors and filters
|
|
|
|
|
that behave like Ant Core components.
|
|
|
|
|
This is achieved by allowing datatypes defined in build scripts
|
|
|
|
|
to be used as custom components if the class of the datatype
|
|
|
|
|
is compatible, or has been adapted by an adapter class.
|
|
|
|
|
</p>
|
|
|
|
|
<p>
|
|
|
|
|
The old methods of defining custom components are still supported.
|
|
|
|
|
</p>
|
|
|
|
|
<h3>Definition and use</h3>
|
|
|
|
|
<p>
|
|
|
|
|
A custom component is a normal Java class that implements a particular
|
|
|
|
|
interface or extends a particular class, or has been adapted to the
|
|
|
|
|
interface or class.
|
|
|
|
|
</p>
|
|
|
|
|
<p>
|
|
|
|
|
It is exactly like writing a
|
|
|
|
|
<a href="../develop.html#writingowntask">custom task</a>.
|
|
|
|
|
One defines attributes and nested elements by writing <i>setter</i>
|
|
|
|
|
methods and <i>add</i> methods.
|
|
|
|
|
</p>
|
|
|
|
|
<p>
|
|
|
|
|
After the class has been written, it is added to the ant system
|
|
|
|
|
by using <code><typedef></code>.
|
|
|
|
|
</p>
|
2018-02-08 16:59:52 +01:00
|
|
|
<h3 id="customconditions">Custom Conditions</h3>
|
2003-08-13 08:35:50 +00:00
|
|
|
<p>
|
|
|
|
|
Custom conditions are datatypes that implement
|
|
|
|
|
<code>org.apache.tools.ant.taskdefs.condition.Condition</code>.
|
|
|
|
|
For example a custom condition that returns true if a
|
|
|
|
|
string is all upper case could be written as:
|
|
|
|
|
</p>
|
2018-02-09 06:54:03 +01:00
|
|
|
<pre>
|
2003-08-13 08:35:50 +00:00
|
|
|
package com.mydomain;
|
|
|
|
|
|
|
|
|
|
import org.apache.tools.ant.BuildException;
|
|
|
|
|
import org.apache.tools.ant.taskdefs.condition.Condition;
|
|
|
|
|
|
2003-10-15 13:20:29 +00:00
|
|
|
public class AllUpperCaseCondition implements Condition {
|
2003-08-13 08:35:50 +00:00
|
|
|
private String value;
|
|
|
|
|
|
2003-09-23 22:12:36 +00:00
|
|
|
// The setter for the "value" attribute
|
2003-08-13 08:35:50 +00:00
|
|
|
public void setValue(String value) {
|
|
|
|
|
this.value = value;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// This method evaluates the condition
|
|
|
|
|
public boolean eval() {
|
|
|
|
|
if (value == null) {
|
2003-09-23 22:12:36 +00:00
|
|
|
throw new BuildException("value attribute is not set");
|
2003-08-13 08:35:50 +00:00
|
|
|
}
|
|
|
|
|
return value.toUpperCase().equals(value);
|
2003-09-23 11:35:53 +00:00
|
|
|
}
|
2003-08-13 08:35:50 +00:00
|
|
|
}
|
2018-02-09 06:54:03 +01:00
|
|
|
</pre>
|
2003-08-13 08:35:50 +00:00
|
|
|
<p>
|
2003-08-13 09:05:22 +00:00
|
|
|
Adding the condition to the system is achieved as follows:
|
2003-08-13 08:35:50 +00:00
|
|
|
</p>
|
2018-02-09 06:54:03 +01:00
|
|
|
<pre>
|
2003-08-13 08:35:50 +00:00
|
|
|
<typedef
|
2003-09-23 22:12:36 +00:00
|
|
|
name="alluppercase"
|
|
|
|
|
classname="com.mydomain.AllUpperCaseCondition"
|
|
|
|
|
classpath="${mydomain.classes}"/>
|
2018-02-09 06:54:03 +01:00
|
|
|
</pre>
|
2003-08-13 08:35:50 +00:00
|
|
|
<p>
|
|
|
|
|
This condition can now be used wherever a Core Ant condition
|
|
|
|
|
is used.
|
|
|
|
|
</p>
|
2018-02-09 06:54:03 +01:00
|
|
|
<pre>
|
2003-09-23 22:12:36 +00:00
|
|
|
<condition property="allupper">
|
|
|
|
|
<alluppercase value="THIS IS ALL UPPER CASE"/>
|
2003-08-13 08:35:50 +00:00
|
|
|
</condition>
|
2018-02-09 06:54:03 +01:00
|
|
|
</pre>
|
2018-02-08 16:59:52 +01:00
|
|
|
<h3 id="customselectors">Custom Selectors</h3>
|
2003-08-13 08:35:50 +00:00
|
|
|
<p>
|
|
|
|
|
Custom selectors are datatypes that implement
|
|
|
|
|
<code>org.apache.tools.ant.types.selectors.FileSelector</code>.
|
2003-08-13 09:05:22 +00:00
|
|
|
</p>
|
|
|
|
|
<p>There is only one method required.
|
|
|
|
|
<code>public boolean isSelected(File basedir, String filename,
|
|
|
|
|
File file)</code>.
|
|
|
|
|
It returns true
|
|
|
|
|
or false depending on whether the given file should be
|
|
|
|
|
selected or not.
|
|
|
|
|
</p>
|
2003-08-13 08:35:50 +00:00
|
|
|
<p>
|
|
|
|
|
An example of a custom selection that selects filenames ending
|
2003-09-23 22:12:36 +00:00
|
|
|
in ".java" would be:
|
2003-08-13 08:35:50 +00:00
|
|
|
</p>
|
2018-02-09 06:54:03 +01:00
|
|
|
<pre>
|
2003-08-13 08:35:50 +00:00
|
|
|
package com.mydomain;
|
2003-08-13 09:05:22 +00:00
|
|
|
import java.io.File;
|
2003-08-13 08:35:50 +00:00
|
|
|
import org.apache.tools.ant.types.selectors.FileSelector;
|
2003-08-13 09:05:22 +00:00
|
|
|
public class JavaSelector implements FileSelector {
|
2003-08-13 08:35:50 +00:00
|
|
|
public boolean isSelected(File b, String filename, File f) {
|
2003-09-23 22:12:36 +00:00
|
|
|
return filename.toLowerCase().endsWith(".java");
|
2003-08-13 08:35:50 +00:00
|
|
|
}
|
|
|
|
|
}
|
2018-02-09 06:54:03 +01:00
|
|
|
</pre>
|
2003-08-13 08:35:50 +00:00
|
|
|
<p>
|
|
|
|
|
Adding the selector to the system is achieved as follows:
|
|
|
|
|
</p>
|
2018-02-09 06:54:03 +01:00
|
|
|
<pre>
|
2003-08-13 08:35:50 +00:00
|
|
|
<typedef
|
2003-09-23 22:12:36 +00:00
|
|
|
name="javaselector"
|
|
|
|
|
classname="com.mydomain.JavaSelector"
|
|
|
|
|
classpath="${mydomain.classes}"/>
|
2018-02-09 06:54:03 +01:00
|
|
|
</pre>
|
|
|
|
|
<p>
|
2003-08-13 08:35:50 +00:00
|
|
|
This selector can now be used wherever a Core Ant selector
|
2003-08-13 09:05:22 +00:00
|
|
|
is used, for example:
|
2003-08-13 08:35:50 +00:00
|
|
|
</p>
|
2018-02-09 06:54:03 +01:00
|
|
|
<pre>
|
2003-09-23 22:12:36 +00:00
|
|
|
<copy todir="to">
|
|
|
|
|
<fileset dir="src">
|
2003-08-13 09:05:22 +00:00
|
|
|
<javaselector/>
|
|
|
|
|
</fileset>
|
|
|
|
|
</copy>
|
2018-02-09 06:54:03 +01:00
|
|
|
</pre>
|
|
|
|
|
<p>
|
2003-08-13 08:35:50 +00:00
|
|
|
One may use
|
|
|
|
|
<code>org.apache.tools.ant.types.selectors.BaseSelector</code>,
|
|
|
|
|
a convenience class that provides reasonable default
|
|
|
|
|
behaviour.
|
|
|
|
|
It has some predefined behaviours you can take advantage
|
|
|
|
|
of. Any time you encounter a problem when setting attributes or
|
|
|
|
|
adding tags, you can call setError(String errmsg) and the class
|
|
|
|
|
will know that there is a problem. Then, at the top of your
|
|
|
|
|
<code>isSelected()</code> method call <code>validate()</code> and
|
|
|
|
|
a BuildException will be thrown with the contents of your error
|
|
|
|
|
message. The <code>validate()</code> method also gives you a
|
|
|
|
|
last chance to check your settings for consistency because it
|
|
|
|
|
calls <code>verifySettings()</code>. Override this method and
|
|
|
|
|
call <code>setError()</code> within it if you detect any
|
2003-09-23 11:35:53 +00:00
|
|
|
problems in how your selector is set up.
|
2003-08-13 08:35:50 +00:00
|
|
|
</p>
|
|
|
|
|
<p>
|
|
|
|
|
To write custom selector containers one should extend
|
|
|
|
|
<code>org.apache.tools.ant.types.selectors.BaseSelectorContainer</code>.
|
|
|
|
|
Implement the
|
|
|
|
|
<code>public boolean isSelected(File baseDir, String filename, File file)</code>
|
|
|
|
|
method to do the right thing. Chances are you'll want to iterate
|
|
|
|
|
over the selectors under you, so use
|
|
|
|
|
<code>selectorElements()</code> to get an iterator that will do
|
|
|
|
|
that.
|
|
|
|
|
</p>
|
|
|
|
|
<p>
|
|
|
|
|
For example to create a selector container that will select files
|
|
|
|
|
if a certain number of contained selectors select, one could write
|
|
|
|
|
a selector as follows:
|
|
|
|
|
</p>
|
2018-02-09 06:54:03 +01:00
|
|
|
<pre>
|
2003-08-13 08:35:50 +00:00
|
|
|
public class MatchNumberSelectors extends BaseSelectorContainer {
|
|
|
|
|
private int number = -1;
|
|
|
|
|
public void setNumber(int number) {
|
|
|
|
|
this.number = number;
|
|
|
|
|
}
|
|
|
|
|
public void verifySettings() {
|
|
|
|
|
if (number < 0) {
|
2003-09-23 22:12:36 +00:00
|
|
|
throw new BuildException("Number attribute should be set");
|
2003-08-13 08:35:50 +00:00
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
public boolean isSelected(File baseDir, String filename, File file) {
|
|
|
|
|
validate();
|
|
|
|
|
int numberSelected = 0;
|
|
|
|
|
for (Enumeration e = selectorElements(); e.hasNextElement();) {
|
|
|
|
|
FileSelector s = (FileSelector) e.nextElement();
|
|
|
|
|
if (s.isSelected(baseDir, filename, file)) {
|
|
|
|
|
numberSelected++;
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
return numberSelected == number;
|
|
|
|
|
}
|
|
|
|
|
}
|
2018-02-09 06:54:03 +01:00
|
|
|
</pre>
|
2003-08-13 08:35:50 +00:00
|
|
|
<p>
|
|
|
|
|
To define and use this selector one could do:
|
|
|
|
|
</p>
|
2018-02-09 06:54:03 +01:00
|
|
|
<pre>
|
2003-09-23 22:12:36 +00:00
|
|
|
<typedef name="numberselected"
|
|
|
|
|
classname="com.mydomain.MatchNumberSelectors"/>
|
2003-08-13 08:35:50 +00:00
|
|
|
...
|
2003-09-23 22:12:36 +00:00
|
|
|
<fileset dir="${src.path}">
|
|
|
|
|
<numberselected number="2">
|
|
|
|
|
<contains text="script" casesensitive="no"/>
|
|
|
|
|
<size value="4" units="Ki" when="more"/>
|
2003-08-13 08:35:50 +00:00
|
|
|
<javaselector/>
|
|
|
|
|
</numberselected>
|
|
|
|
|
</fileset>
|
2018-02-09 06:54:03 +01:00
|
|
|
</pre>
|
2003-08-13 08:35:50 +00:00
|
|
|
<p>
|
|
|
|
|
<i>The custom selector</i>
|
|
|
|
|
</p>
|
|
|
|
|
<p>
|
|
|
|
|
The custom selector was the pre ant 1.6 way of defining custom selectors.
|
2003-09-23 11:35:53 +00:00
|
|
|
This method is still supported for backward compatibility.
|
2003-08-13 08:35:50 +00:00
|
|
|
</p>
|
|
|
|
|
<p>You can write your own selectors and use them within the selector
|
2004-11-19 09:07:12 +00:00
|
|
|
containers by specifying them within the <code><custom></code> tag.</p>
|
2003-08-13 08:35:50 +00:00
|
|
|
|
2018-02-09 06:54:03 +01:00
|
|
|
<p>To create a new Custom Selector, you have to create a class that
|
2003-08-13 08:35:50 +00:00
|
|
|
implements
|
|
|
|
|
<code>org.apache.tools.ant.types.selectors.ExtendFileSelector</code>.
|
|
|
|
|
The easiest way to do that is through the convenience base class
|
|
|
|
|
<code>org.apache.tools.ant.types.selectors.BaseExtendSelector</code>,
|
|
|
|
|
which provides all of the methods for supporting
|
|
|
|
|
<code><param></code> tags. First, override the
|
|
|
|
|
<code>isSelected()</code> method, and optionally the
|
|
|
|
|
<code>verifySettings()</code> method. If your custom
|
|
|
|
|
selector requires parameters to be set, you can also override
|
|
|
|
|
the <code>setParameters()</code> method and interpret the
|
|
|
|
|
parameters that are passed in any way you like. Several of the
|
|
|
|
|
core selectors demonstrate how to do that because they can
|
|
|
|
|
also be used as custom selectors.</p>
|
|
|
|
|
|
|
|
|
|
<p>Once that is written, you include it in your build file by using
|
|
|
|
|
the <code><custom></code> tag.
|
|
|
|
|
</p>
|
|
|
|
|
|
2018-02-08 16:59:52 +01:00
|
|
|
<table>
|
2003-08-13 08:35:50 +00:00
|
|
|
<tr>
|
|
|
|
|
<td valign="top"><b>Attribute</b></td>
|
|
|
|
|
<td valign="top"><b>Description</b></td>
|
|
|
|
|
<td align="center" valign="top"><b>Required</b></td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td valign="top">classname</td>
|
|
|
|
|
<td valign="top">The name of your class that implements
|
|
|
|
|
<code>org.apache.tools.ant.types.selectors.FileSelector</code>.
|
|
|
|
|
</td>
|
|
|
|
|
<td valign="top" align="center">Yes</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td valign="top">classpath</td>
|
|
|
|
|
<td valign="top">The classpath to use in order to load the
|
|
|
|
|
custom selector class. If neither this classpath nor the
|
|
|
|
|
classpathref are specified, the class will be
|
|
|
|
|
loaded from the classpath that Ant uses.
|
|
|
|
|
</td>
|
|
|
|
|
<td valign="top" align="center">No</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td valign="top">classpathref</td>
|
|
|
|
|
<td valign="top">A reference to a classpath previously
|
|
|
|
|
defined. If neither this reference nor the
|
|
|
|
|
classpath above are specified, the class will be
|
|
|
|
|
loaded from the classpath that Ant uses.
|
|
|
|
|
</td>
|
|
|
|
|
<td valign="top" align="center">No</td>
|
|
|
|
|
</tr>
|
|
|
|
|
</table>
|
|
|
|
|
|
|
|
|
|
<p>Here is how you use <code><custom></code> to
|
|
|
|
|
use your class as a selector:
|
|
|
|
|
</p>
|
2018-02-09 06:54:03 +01:00
|
|
|
<pre>
|
2003-09-23 22:12:36 +00:00
|
|
|
<fileset dir="${mydir}" includes="**/*">
|
|
|
|
|
<custom classname="com.mydomain.MySelector">
|
|
|
|
|
<param name="myattribute" value="myvalue"/>
|
2003-08-13 08:35:50 +00:00
|
|
|
</custom>
|
|
|
|
|
</fileset>
|
2018-02-09 06:54:03 +01:00
|
|
|
</pre>
|
2003-08-13 08:35:50 +00:00
|
|
|
<p>The core selectors that can also be used as custom selectors
|
|
|
|
|
are</p>
|
|
|
|
|
|
|
|
|
|
<ul>
|
|
|
|
|
<li><a href="selectors.html#containsselect">Contains Selector</a> with
|
|
|
|
|
classname <code>org.apache.tools.ant.types.selectors.ContainsSelector</code>
|
|
|
|
|
</li>
|
|
|
|
|
<li><a href="selectors.html#dateselect">Date Selector</a> with
|
|
|
|
|
classname <code>org.apache.tools.ant.types.selectors.DateSelector</code>
|
|
|
|
|
</li>
|
|
|
|
|
<li><a href="selectors.html#depthselect">Depth Selector</a> with
|
|
|
|
|
classname <code>org.apache.tools.ant.types.selectors.DepthSelector</code>
|
|
|
|
|
</li>
|
|
|
|
|
<li><a href="selectors.html#filenameselect">Filename Selector</a> with
|
|
|
|
|
classname <code>org.apache.tools.ant.types.selectors.FilenameSelector</code>
|
|
|
|
|
</li>
|
|
|
|
|
<li><a href="selectors.html#sizeselect">Size Selector</a> with
|
|
|
|
|
classname <code>org.apache.tools.ant.types.selectors.SizeSelector</code>
|
|
|
|
|
</li>
|
|
|
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
<p>Here is the example from the Depth Selector section rewritten
|
|
|
|
|
to use the selector through <code><custom></code>.</p>
|
2018-02-09 06:54:03 +01:00
|
|
|
<pre>
|
2003-09-23 22:12:36 +00:00
|
|
|
<fileset dir="${doc.path}" includes="**/*">
|
|
|
|
|
<custom classname="org.apache.tools.ant.types.selectors.DepthSelector">
|
|
|
|
|
<param name="max" value="1"/>
|
2003-08-13 08:35:50 +00:00
|
|
|
</custom>
|
|
|
|
|
</fileset>
|
2018-02-09 06:54:03 +01:00
|
|
|
</pre>
|
2003-08-13 08:35:50 +00:00
|
|
|
<p>Selects all files in the base directory and one directory below
|
|
|
|
|
that.</p>
|
|
|
|
|
|
2018-02-08 16:59:52 +01:00
|
|
|
<h3 id="filterreaders">Custom Filter Readers</h3>
|
2003-08-13 08:35:50 +00:00
|
|
|
<p>
|
|
|
|
|
Custom filter readers selectors are datatypes that implement
|
|
|
|
|
<code>org.apache.tools.ant.types.filters.ChainableReader</code>.
|
|
|
|
|
</p>
|
|
|
|
|
<p>There is only one method required.
|
|
|
|
|
<code>Reader chain(Reader reader)</code>.
|
|
|
|
|
This returns a reader that filters input from the specified
|
|
|
|
|
reader.
|
|
|
|
|
</p>
|
|
|
|
|
<p>
|
|
|
|
|
For example a filterreader that removes every second character
|
|
|
|
|
could be:
|
|
|
|
|
</p>
|
2018-02-09 06:54:03 +01:00
|
|
|
<pre>
|
2003-08-13 08:35:50 +00:00
|
|
|
public class RemoveOddCharacters implements ChainableReader {
|
|
|
|
|
public Reader chain(Reader reader) {
|
|
|
|
|
return new BaseFilterReader(reader) {
|
|
|
|
|
int count = 0;
|
|
|
|
|
public int read() throws IOException {
|
|
|
|
|
while (true) {
|
|
|
|
|
int c = in.read();
|
|
|
|
|
if (c == -1) {
|
|
|
|
|
return c;
|
|
|
|
|
}
|
|
|
|
|
count++;
|
|
|
|
|
if ((count % 2) == 1) {
|
|
|
|
|
return c;
|
2003-09-23 11:35:53 +00:00
|
|
|
}
|
2003-08-13 08:35:50 +00:00
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
}
|
2018-02-09 06:54:03 +01:00
|
|
|
</pre>
|
2003-08-13 08:35:50 +00:00
|
|
|
<p>
|
|
|
|
|
For line oriented filters it may be easier to extend
|
|
|
|
|
<code>ChainableFilterReader</code> an inner class of
|
|
|
|
|
<code>org.apache.tools.ant.filters.TokenFilter</code>.
|
|
|
|
|
</p>
|
|
|
|
|
<p>
|
|
|
|
|
For example a filter that appends the line number could be
|
|
|
|
|
</p>
|
2018-02-09 06:54:03 +01:00
|
|
|
<pre>
|
2003-08-13 08:35:50 +00:00
|
|
|
public class AddLineNumber extends ChainableReaderFilter {
|
|
|
|
|
private void lineNumber = 0;
|
|
|
|
|
public String filter(String string) {
|
|
|
|
|
lineNumber++;
|
2003-09-23 22:12:36 +00:00
|
|
|
return "" + lineNumber + "\t" + string;
|
2003-08-13 08:35:50 +00:00
|
|
|
}
|
|
|
|
|
}
|
2018-02-09 06:54:03 +01:00
|
|
|
</pre>
|
2003-09-23 11:35:53 +00:00
|
|
|
|
2003-08-13 08:35:50 +00:00
|
|
|
</body>
|
|
|
|
|
</html>
|
