| <!-- |
| 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. |
| --> |
| <html> |
| |
| <head> |
| <meta http-equiv="Content-Language" content="en-us"> |
| <link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> |
| <title>DirSet Type</title> |
| </head> |
| |
| <body> |
| |
| <h2><a name="dirset">DirSet</a></h2> |
| <p>A DirSet is a group of directories. These directories can be found in a |
| directory tree starting in a base directory and are matched by |
| patterns taken from a number of <a href="patternset.html">PatternSets</a> |
| and <a href="selectors.html">Selectors</a>. |
| </p> |
| <p>PatternSets can be specified as nested |
| <code><patternset></code> elements. In addition, DirSet holds |
| an implicit PatternSet and supports the nested |
| <code><include></code>, <code><includesfile></code>, |
| <code><exclude></code> and <code><excludesfile></code> |
| elements of <code><patternset></code> directly, as well as |
| <code><patternset></code>'s attributes.</p> |
| <p>Selectors are available as nested elements within the DirSet. |
| If any of the selectors within the DirSet do not select the directory, it |
| is not considered part of the DirSet. This makes a DirSet |
| equivalent to an <code><and></code> selector container.</p> |
| <table border="1" cellpadding="2" cellspacing="0"> |
| <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">dir</td> |
| <td valign="top">The root of the directory tree of this DirSet.</td> |
| <td valign="top" align="center">Yes</td> |
| </tr> |
| <tr> |
| <td valign="top">includes</td> |
| <td valign="top">A comma- or space-separated list of patterns of directories that |
| must be included; all directories are included when omitted.</td> |
| <td valign="top" align="center">No</td> |
| </tr> |
| <tr> |
| <td valign="top">includesfile</td> |
| <td valign="top">The name of a file; each line of this file is |
| taken to be an include pattern.</td> |
| <td valign="top" align="center">No</td> |
| </tr> |
| <tr> |
| <td valign="top">excludes</td> |
| <td valign="top">A comma- or space-separated list of patterns of directories that |
| must be excluded; no directories are excluded when omitted.</td> |
| <td valign="top" align="center">No</td> |
| </tr> |
| <tr> |
| <td valign="top">excludesfile</td> |
| <td valign="top">The name of a file; each line of this file is |
| taken to be an exclude pattern.</td> |
| <td valign="top" align="center">No</td> |
| </tr> |
| <tr> |
| <td valign="top">casesensitive</td> |
| <td valign="top">Specifies whether case-sensitivity should be applied |
| (<code>true</code>|<code>yes</code>|<code>on</code> or |
| <code>false</code>|<code>no</code>|<code>off</code>).</td> |
| <td valign="top" align="center">No; defaults to true.</td> |
| </tr> |
| <tr> |
| <td valign="top">followsymlinks</td> |
| <td valign="top">Shall symbolic links be followed? Defaults to |
| true. See <a href="fileset.html#symlink">fileset's documentation</a>.</td> |
| <td valign="top" align="center">No</td> |
| </tr> |
| </table> |
| |
| <h4>Examples</h4> |
| <blockquote><pre> |
| <dirset dir="${build.dir}"> |
| <include name="apps/**/classes"/> |
| <exclude name="apps/**/*Test*"/> |
| </dirset> |
| </pre></blockquote> |
| <p>Groups all directories named <code>classes</code> found under the |
| <code>apps</code> subdirectory of <code>${build.dir}</code>, except those |
| that have the text <code>Test</code> in their name.</p> |
| <blockquote><pre> |
| <dirset dir="${build.dir}"> |
| <patternset id="non.test.classes"> |
| <include name="apps/**/classes"/> |
| <exclude name="apps/**/*Test*"/> |
| </patternset> |
| </dirset> |
| </pre></blockquote> |
| <p>Groups the same directories as the above example, but also establishes |
| a PatternSet that can be referenced in other |
| <code><dirset></code> elements, rooted at a different directory.</p> |
| <blockquote><pre> |
| <dirset dir="${debug_build.dir}"> |
| <patternset refid="non.test.classes"/> |
| </dirset> |
| </pre></blockquote> |
| <p>Groups all directories in directory <code>${debug_build.dir}</code>, |
| using the same patterns as the above example.</p> |
| |
| |
| |
| </body> |
| </html> |
| |
