source: release-kits/lirk3/bin/ant-installer/web/manual/manual/CoreTasks/makeurl.html@ 14982

Last change on this file since 14982 was 14982, checked in by oranfry, 16 years ago

initial import of LiRK3

File size: 3.8 KB
Line 
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
18<html>
19<head>
20 <meta http-equiv="Content-Language" content="en-us">
21 <title>Makeurl Task</title>
22<link rel="stylesheet" type="text/css" href="../stylesheets/style.css">
23</head>
24
25<body>
26
27<h2><a name="makeurl">Makeurl</a></h2>
28<h3>Description</h3>
29
30<p>This task takes one or more filenames and turns them into URLs, which it then assigns to a property.
31Useful when setting up RMI or JNLP codebases, for example.
32Nested filesets are supported; if present, these are turned into the URLs with the supplied separator between them (default: space).
33<p/>
34<p>Examples:</p>
35<pre>
36&lt;makeurl file="${user.home}/.m2/repository" property="m2.repository.url"/&gt;
37</pre>
38Sets the property <code>m2.repository.url</code> to the file: URL of the local Maven2 repository.
39<pre>
40&lt;makeurl property="codebase"&gt;&lt;fileset dir="lib includes="*.jar"/&gt;&lt;/makeurl&gt;
41</pre>
42Set the property <code>codebase</code> to the three URLs of the files provided as nested elements.
43 </blockquote>
44
45
46 <!-- Ignore -->
47
48
49
50 <!-- Start Attributes -->
51<a name="attributes"></a>
52 <h3>Parameters</h3>
53 <table border="1" cellpadding="2" cellspacing="0">
54 <tr>
55 <td>
56 <b>Attribute</b>
57 </td>
58 <td>
59 <b>Description</b>
60 </td>
61 <td>
62 <b>Type</b>
63 </td>
64 <td>
65 <b>Requirement</b>
66 </td>
67 </tr>
68 <!-- Attribute Group -->
69
70 <!-- Attribute Group -->
71 <!-- Attribute -->
72 <tr>
73 <td>
74 file
75 </td>
76 <td>
77 name of a file to be converted into a URL
78 </td>
79 <td>
80 File
81 </td>
82 <td>
83 optional, if a nested fileset or path is supplied
84 </td>
85 </tr>
86 <!-- Attribute -->
87 <tr>
88 <td>
89 property
90 </td>
91 <td>
92 name of a property to set to the URL
93 </td>
94 <td>
95 String
96 </td>
97 <td>
98 required
99 </td>
100 </tr>
101 <!-- Attribute -->
102 <tr>
103 <td>
104 separator
105 </td>
106 <td>
107 separator for the multi-URL option
108 </td>
109 <td>
110 String
111 </td>
112 <td>
113 optional
114 </td>
115 </tr>
116 <!-- Attribute -->
117 <tr>
118 <td>
119 validate
120 </td>
121 <td>
122 validate that every named file exists
123 </td>
124 <td>
125 boolean
126 </td>
127 <td>
128 optional; default: true
129 </td>
130 </tr>
131
132
133 </table>
134 <!-- End Attributes -->
135
136 <!-- Start Elements -->
137 <a name="elements"></a>
138 <h3>Parameters as nested elements</h3>
139 <!-- Start Element -->
140 <h4>fileset</h4> (org.apache.tools.ant.types.FileSet)
141
142 <p>A fileset of JAR files to include in the URL list, each separated by the separator.</p>
143
144 <h4>path</h4> (org.apache.tools.ant.types.Path)
145
146 <p>Add a path to the URL. All elements in the path will be converted to individual URL entries.</p>
147
148 <!-- End Element -->
149
150
151</body>
152</html>
Note: See TracBrowser for help on using the repository browser.