| 1 | <!--
|
|---|
| 2 | Licensed to the Apache Software Foundation (ASF) under one or more
|
|---|
| 3 | contributor license agreements. See the NOTICE file distributed with
|
|---|
| 4 | this work for additional information regarding copyright ownership.
|
|---|
| 5 | The ASF licenses this file to You under the Apache License, Version 2.0
|
|---|
| 6 | (the "License"); you may not use this file except in compliance with
|
|---|
| 7 | the License. You may obtain a copy of the License at
|
|---|
| 8 |
|
|---|
| 9 | http://www.apache.org/licenses/LICENSE-2.0
|
|---|
| 10 |
|
|---|
| 11 | Unless required by applicable law or agreed to in writing, software
|
|---|
| 12 | distributed under the License is distributed on an "AS IS" BASIS,
|
|---|
| 13 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|---|
| 14 | See the License for the specific language governing permissions and
|
|---|
| 15 | limitations under the License.
|
|---|
| 16 | -->
|
|---|
| 17 | <html>
|
|---|
| 18 |
|
|---|
| 19 | <head>
|
|---|
| 20 | <meta http-equiv="Content-Language" content="en-us">
|
|---|
| 21 | <link rel="stylesheet" type="text/css" href="../stylesheets/style.css">
|
|---|
| 22 | <title>PropertySet Type</title>
|
|---|
| 23 | </head>
|
|---|
| 24 |
|
|---|
| 25 | <body>
|
|---|
| 26 |
|
|---|
| 27 | <h2><a name="propertyset">PropertySet</a></h2>
|
|---|
| 28 | <p><em>Since Ant 1.6</em></p>
|
|---|
| 29 |
|
|---|
| 30 | <p>Groups a set of properties to be used by reference in a task that
|
|---|
| 31 | supports this.</p>
|
|---|
| 32 |
|
|---|
| 33 | <table border="1" cellpadding="2" cellspacing="0">
|
|---|
| 34 | <tr>
|
|---|
| 35 | <td valign="top"><b>Attribute</b></td>
|
|---|
| 36 | <td valign="top"><b>Description</b></td>
|
|---|
| 37 | <td align="center" valign="top"><b>Required</b></td>
|
|---|
| 38 | </tr>
|
|---|
| 39 | <tr>
|
|---|
| 40 | <td valign="top">dynamic</td>
|
|---|
| 41 | <td valign="top">Whether to reevaluate the set everytime the set
|
|---|
| 42 | is used. Default is "<code>true</code>".</td>
|
|---|
| 43 | <td valign="top" align="center">No</td>
|
|---|
| 44 | </tr>
|
|---|
| 45 | <tr>
|
|---|
| 46 | <td valign="top">negate</td>
|
|---|
| 47 | <td valign="top">Whether to negate results. If
|
|---|
| 48 | "<code>true</code>", all properties <i>not</i>
|
|---|
| 49 | selected by nested elements will be returned. Default is
|
|---|
| 50 | "<code>false</code>". <em>Since Ant 1.6.2</em>
|
|---|
| 51 | </td>
|
|---|
| 52 | <td valign="top" align="center">No</td>
|
|---|
| 53 | </tr>
|
|---|
| 54 | </table>
|
|---|
| 55 | <h3>Parameters specified as nested elements</h3>
|
|---|
| 56 |
|
|---|
| 57 | <h4>propertyref</h4>
|
|---|
| 58 |
|
|---|
| 59 | <p>Selects properties from the current project to be included in the
|
|---|
| 60 | set.</p>
|
|---|
| 61 |
|
|---|
| 62 | <table border="1" cellpadding="2" cellspacing="0">
|
|---|
| 63 | <tr>
|
|---|
| 64 | <td valign="top"><b>Attribute</b></td>
|
|---|
| 65 | <td valign="top"><b>Description</b></td>
|
|---|
| 66 | <td align="center" valign="top"><b>Required</b></td>
|
|---|
| 67 | </tr>
|
|---|
| 68 | <tr>
|
|---|
| 69 | <td valign="top">name</td>
|
|---|
| 70 | <td valign="top">Select the property with the given name.</td>
|
|---|
| 71 | <td align="center" valign="top" rowspan="4">Exactly one of these.</td>
|
|---|
| 72 | </tr>
|
|---|
| 73 | <tr>
|
|---|
| 74 | <td valign="top">prefix</td>
|
|---|
| 75 | <td valign="top">Select the properties whose name starts with the
|
|---|
| 76 | given string.</td>
|
|---|
| 77 | </tr>
|
|---|
| 78 | <tr>
|
|---|
| 79 | <td valign="top">regex</td>
|
|---|
| 80 | <td valign="top">Select the properties that match the given
|
|---|
| 81 | regular expression. Similar to <a
|
|---|
| 82 | href="mapper.html#regexp-mapper">regexp type mappers</a>, this
|
|---|
| 83 | requires a supported regular expression library.</td>
|
|---|
| 84 | </tr>
|
|---|
| 85 | <tr>
|
|---|
| 86 | <td valign="top">builtin</td>
|
|---|
| 87 | <td valign="top">Selects a builtin set of properties. Valid
|
|---|
| 88 | values for this attribute are <code>all</code> for all Ant
|
|---|
| 89 | properties, <code>system</code> for the system properties and
|
|---|
| 90 | <code>commandline</code> for all properties specified on the
|
|---|
| 91 | command line when invoking Ant (plus a number of special
|
|---|
| 92 | internal Ant properties).</td>
|
|---|
| 93 | </tr>
|
|---|
| 94 | </table>
|
|---|
| 95 |
|
|---|
| 96 | <h4>propertyset</h4>
|
|---|
| 97 |
|
|---|
| 98 | <p>A <code>propertyset</code> can be used as the set union of more
|
|---|
| 99 | <code>propertyset</code>s.</p>
|
|---|
| 100 |
|
|---|
| 101 | <p>For example:</p>
|
|---|
| 102 |
|
|---|
| 103 | <blockquote><pre>
|
|---|
| 104 | <propertyset id="properties-starting-with-foo">
|
|---|
| 105 | <propertyref prefix="foo"/>
|
|---|
| 106 | </propertyset>
|
|---|
| 107 | <propertyset id="properties-starting-with-bar">
|
|---|
| 108 | <propertyref prefix="bar"/>
|
|---|
| 109 | </propertyset>
|
|---|
| 110 | <propertyset id="my-set">
|
|---|
| 111 | <propertyset refid="properties-starting-with-foo"/>
|
|---|
| 112 | <propertyset refid="properties-starting-with-bar"/>
|
|---|
| 113 | </propertyset>
|
|---|
| 114 | </pre></blockquote>
|
|---|
| 115 |
|
|---|
| 116 | <p>collects all properties whose name starts with either
|
|---|
| 117 | "foo" or "bar" in the set named
|
|---|
| 118 | "my-set".</p>
|
|---|
| 119 |
|
|---|
| 120 | <h4>mapper</h4>
|
|---|
| 121 |
|
|---|
| 122 | <p>A <a href="mapper.html">mapper</a> - at maximum one mapper can be
|
|---|
| 123 | specified. The mapper is used to change the names of the property
|
|---|
| 124 | keys, for example:
|
|---|
| 125 |
|
|---|
| 126 | <blockquote><pre>
|
|---|
| 127 | <propertyset id="properties-starting-with-foo">
|
|---|
| 128 | <propertyref prefix="foo"/>
|
|---|
| 129 | <mapper type="glob" from="foo*" to="bar*"/>
|
|---|
| 130 | </propertyset>
|
|---|
| 131 | </pre></blockquote>
|
|---|
| 132 |
|
|---|
| 133 | <p>collects all properties whose name starts with "foo", but
|
|---|
| 134 | changes the names to start with "bar" instead.</p>
|
|---|
| 135 |
|
|---|
| 136 | <p>If supplied, the nested mapper will be applied
|
|---|
| 137 | subsequent to any negation of matched properties.</p>
|
|---|
| 138 |
|
|---|
| 139 |
|
|---|
| 140 |
|
|---|
| 141 | </body>
|
|---|
| 142 | </html>
|
|---|
| 143 |
|
|---|
