source: release-kits/lirk3/resources/gs3-release-maker/ant/docs/manual/api/org/apache/tools/ant/taskdefs/optional/Cab.html@ 14982

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

initial import of LiRK3
File size: 34.3 KB
Line 
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2<!--NewPage-->
3<HTML>
4<HEAD>
5<!-- Generated by javadoc (build 1.4.2_13) on Mon Oct 01 14:33:23 NZST 2007 -->
6<TITLE>
7Cab (Apache Ant API)
8</TITLE>
9
10<META NAME="keywords" CONTENT="org.apache.tools.ant.taskdefs.optional.Cab class">
11
12<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../../stylesheet.css" TITLE="Style">
13
14<SCRIPT type="text/javascript">
15function windowTitle()
16{
17 parent.document.title="Cab (Apache Ant API)";
18}
19</SCRIPT>
20
21</HEAD>
22
23<BODY BGCOLOR="white" onload="windowTitle();">
24
25
26<!-- ========= START OF TOP NAVBAR ======= -->
27<A NAME="navbar_top"><!-- --></A>
28<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
29<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
30<TR>
31<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
32<A NAME="navbar_top_firstrow"><!-- --></A>
33<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
34 <TR ALIGN="center" VALIGN="top">
35 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
36 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
37 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
38 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
39 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
40 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
41 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
42 </TR>
43</TABLE>
44</TD>
45<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
46</EM>
47</TD>
48</TR>
49
50<TR>
51<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
52&nbsp;<A HREF="../../../../../../org/apache/tools/ant/taskdefs/optional/ANTLR.html" title="class in org.apache.tools.ant.taskdefs.optional"><B>PREV CLASS</B></A>&nbsp;
53&nbsp;<A HREF="../../../../../../org/apache/tools/ant/taskdefs/optional/EchoProperties.html" title="class in org.apache.tools.ant.taskdefs.optional"><B>NEXT CLASS</B></A></FONT></TD>
54<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
55 <A HREF="../../../../../../index.html" target="_top"><B>FRAMES</B></A> &nbsp;
56&nbsp;<A HREF="Cab.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
57&nbsp;<SCRIPT type="text/javascript">
58 <!--
59 if(window==top) {
60 document.writeln('<A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
61 }
62 //-->
63</SCRIPT>
64<NOSCRIPT>
65 <A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>
66</NOSCRIPT>
67
68</FONT></TD>
69</TR>
70<TR>
71<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
72 SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
73<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
74DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
75</TR>
76</TABLE>
77<A NAME="skip-navbar_top"></A>
78<!-- ========= END OF TOP NAVBAR ========= -->
79
80<HR>
81<!-- ======== START OF CLASS DATA ======== -->
82<H2>
83<FONT SIZE="-1">
84org.apache.tools.ant.taskdefs.optional</FONT>
85<BR>
86Class Cab</H2>
87<PRE>
88java.lang.Object
89 <IMG SRC="../../../../../../resources/inherit.gif" ALT="extended by"><A HREF="../../../../../../org/apache/tools/ant/ProjectComponent.html" title="class in org.apache.tools.ant">org.apache.tools.ant.ProjectComponent</A>
90 <IMG SRC="../../../../../../resources/inherit.gif" ALT="extended by"><A HREF="../../../../../../org/apache/tools/ant/Task.html" title="class in org.apache.tools.ant">org.apache.tools.ant.Task</A>
91 <IMG SRC="../../../../../../resources/inherit.gif" ALT="extended by"><A HREF="../../../../../../org/apache/tools/ant/taskdefs/MatchingTask.html" title="class in org.apache.tools.ant.taskdefs">org.apache.tools.ant.taskdefs.MatchingTask</A>
92 <IMG SRC="../../../../../../resources/inherit.gif" ALT="extended by"><B>org.apache.tools.ant.taskdefs.optional.Cab</B>
93</PRE>
94<DL>
95<DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../../../org/apache/tools/ant/types/selectors/SelectorContainer.html" title="interface in org.apache.tools.ant.types.selectors">SelectorContainer</A></DD>
96</DL>
97<HR>
98<DL>
99<DT>public class <B>Cab</B><DT>extends <A HREF="../../../../../../org/apache/tools/ant/taskdefs/MatchingTask.html" title="class in org.apache.tools.ant.taskdefs">MatchingTask</A></DL>
100
101<P>
102Create a CAB archive.
103<P>
104
105<P>
106<HR>
107
108<P>
109<!-- ======== NESTED CLASS SUMMARY ======== -->
110
111
112<!-- =========== FIELD SUMMARY =========== -->
113
114<A NAME="field_summary"><!-- --></A>
115<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
116<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
117<TD COLSPAN=2><FONT SIZE="+2">
118<B>Field Summary</B></FONT></TD>
119</TR>
120<TR BGCOLOR="white" CLASS="TableRowColor">
121<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
122<CODE>protected &nbsp;java.lang.String</CODE></FONT></TD>
123<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/taskdefs/optional/Cab.html#archiveType">archiveType</A></B></CODE>
124
125<BR>
126&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
127</TR>
128</TABLE>
129&nbsp;<A NAME="fields_inherited_from_class_org.apache.tools.ant.taskdefs.MatchingTask"><!-- --></A>
130<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
131<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
132<TD><B>Fields inherited from class org.apache.tools.ant.taskdefs.<A HREF="../../../../../../org/apache/tools/ant/taskdefs/MatchingTask.html" title="class in org.apache.tools.ant.taskdefs">MatchingTask</A></B></TD>
133</TR>
134<TR BGCOLOR="white" CLASS="TableRowColor">
135<TD><CODE><A HREF="../../../../../../org/apache/tools/ant/taskdefs/MatchingTask.html#fileset">fileset</A></CODE></TD>
136</TR>
137</TABLE>
138&nbsp;<A NAME="fields_inherited_from_class_org.apache.tools.ant.Task"><!-- --></A>
139<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
140<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
141<TD><B>Fields inherited from class org.apache.tools.ant.<A HREF="../../../../../../org/apache/tools/ant/Task.html" title="class in org.apache.tools.ant">Task</A></B></TD>
142</TR>
143<TR BGCOLOR="white" CLASS="TableRowColor">
144<TD><CODE><A HREF="../../../../../../org/apache/tools/ant/Task.html#description">description</A>, <A HREF="../../../../../../org/apache/tools/ant/Task.html#location">location</A>, <A HREF="../../../../../../org/apache/tools/ant/Task.html#target">target</A>, <A HREF="../../../../../../org/apache/tools/ant/Task.html#taskName">taskName</A>, <A HREF="../../../../../../org/apache/tools/ant/Task.html#taskType">taskType</A>, <A HREF="../../../../../../org/apache/tools/ant/Task.html#wrapper">wrapper</A></CODE></TD>
145</TR>
146</TABLE>
147&nbsp;<A NAME="fields_inherited_from_class_org.apache.tools.ant.ProjectComponent"><!-- --></A>
148<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
149<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
150<TD><B>Fields inherited from class org.apache.tools.ant.<A HREF="../../../../../../org/apache/tools/ant/ProjectComponent.html" title="class in org.apache.tools.ant">ProjectComponent</A></B></TD>
151</TR>
152<TR BGCOLOR="white" CLASS="TableRowColor">
153<TD><CODE><A HREF="../../../../../../org/apache/tools/ant/ProjectComponent.html#project">project</A></CODE></TD>
154</TR>
155</TABLE>
156&nbsp;
157<!-- ======== CONSTRUCTOR SUMMARY ======== -->
158
159<A NAME="constructor_summary"><!-- --></A>
160<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
161<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
162<TD COLSPAN=2><FONT SIZE="+2">
163<B>Constructor Summary</B></FONT></TD>
164</TR>
165<TR BGCOLOR="white" CLASS="TableRowColor">
166<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/taskdefs/optional/Cab.html#Cab()">Cab</A></B>()</CODE>
167
168<BR>
169&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
170</TR>
171</TABLE>
172&nbsp;
173<!-- ========== METHOD SUMMARY =========== -->
174
175<A NAME="method_summary"><!-- --></A>
176<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
177<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
178<TD COLSPAN=2><FONT SIZE="+2">
179<B>Method Summary</B></FONT></TD>
180</TR>
181<TR BGCOLOR="white" CLASS="TableRowColor">
182<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
183<CODE>&nbsp;void</CODE></FONT></TD>
184<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/taskdefs/optional/Cab.html#addFileset(org.apache.tools.ant.types.FileSet)">addFileset</A></B>(<A HREF="../../../../../../org/apache/tools/ant/types/FileSet.html" title="class in org.apache.tools.ant.types">FileSet</A>&nbsp;set)</CODE>
185
186<BR>
187&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Adds a set of files to archive.</TD>
188</TR>
189<TR BGCOLOR="white" CLASS="TableRowColor">
190<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
191<CODE>protected &nbsp;void</CODE></FONT></TD>
192<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/taskdefs/optional/Cab.html#appendFiles(java.util.Vector, org.apache.tools.ant.DirectoryScanner)">appendFiles</A></B>(java.util.Vector&nbsp;files,
193 <A HREF="../../../../../../org/apache/tools/ant/DirectoryScanner.html" title="class in org.apache.tools.ant">DirectoryScanner</A>&nbsp;ds)</CODE>
194
195<BR>
196&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Append all files found by a directory scanner to a vector.</TD>
197</TR>
198<TR BGCOLOR="white" CLASS="TableRowColor">
199<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
200<CODE>protected &nbsp;void</CODE></FONT></TD>
201<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/taskdefs/optional/Cab.html#checkConfiguration()">checkConfiguration</A></B>()</CODE>
202
203<BR>
204&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
205</TR>
206<TR BGCOLOR="white" CLASS="TableRowColor">
207<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
208<CODE>protected &nbsp;<A HREF="../../../../../../org/apache/tools/ant/taskdefs/ExecTask.html" title="class in org.apache.tools.ant.taskdefs">ExecTask</A></CODE></FONT></TD>
209<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/taskdefs/optional/Cab.html#createExec()">createExec</A></B>()</CODE>
210
211<BR>
212&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Create a new exec delegate.</TD>
213</TR>
214<TR BGCOLOR="white" CLASS="TableRowColor">
215<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
216<CODE>protected &nbsp;java.io.File</CODE></FONT></TD>
217<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/taskdefs/optional/Cab.html#createListFile(java.util.Vector)">createListFile</A></B>(java.util.Vector&nbsp;files)</CODE>
218
219<BR>
220&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates a list file.</TD>
221</TR>
222<TR BGCOLOR="white" CLASS="TableRowColor">
223<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
224<CODE>&nbsp;void</CODE></FONT></TD>
225<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/taskdefs/optional/Cab.html#execute()">execute</A></B>()</CODE>
226
227<BR>
228&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Called by the project to let the task do its work.</TD>
229</TR>
230<TR BGCOLOR="white" CLASS="TableRowColor">
231<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
232<CODE>protected &nbsp;java.util.Vector</CODE></FONT></TD>
233<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/taskdefs/optional/Cab.html#getFileList()">getFileList</A></B>()</CODE>
234
235<BR>
236&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the complete list of files to be included in the cab.</TD>
237</TR>
238<TR BGCOLOR="white" CLASS="TableRowColor">
239<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
240<CODE>protected &nbsp;boolean</CODE></FONT></TD>
241<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/taskdefs/optional/Cab.html#isUpToDate(java.util.Vector)">isUpToDate</A></B>(java.util.Vector&nbsp;files)</CODE>
242
243<BR>
244&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Check to see if the target is up to date with respect to input files.</TD>
245</TR>
246<TR BGCOLOR="white" CLASS="TableRowColor">
247<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
248<CODE>&nbsp;void</CODE></FONT></TD>
249<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/taskdefs/optional/Cab.html#setBasedir(java.io.File)">setBasedir</A></B>(java.io.File&nbsp;baseDir)</CODE>
250
251<BR>
252&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Base directory to look in for files to CAB.</TD>
253</TR>
254<TR BGCOLOR="white" CLASS="TableRowColor">
255<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
256<CODE>&nbsp;void</CODE></FONT></TD>
257<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/taskdefs/optional/Cab.html#setCabfile(java.io.File)">setCabfile</A></B>(java.io.File&nbsp;cabFile)</CODE>
258
259<BR>
260&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The name/location of where to create the .cab file.</TD>
261</TR>
262<TR BGCOLOR="white" CLASS="TableRowColor">
263<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
264<CODE>&nbsp;void</CODE></FONT></TD>
265<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/taskdefs/optional/Cab.html#setCompress(boolean)">setCompress</A></B>(boolean&nbsp;compress)</CODE>
266
267<BR>
268&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;If true, compress the files otherwise only store them.</TD>
269</TR>
270<TR BGCOLOR="white" CLASS="TableRowColor">
271<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
272<CODE>&nbsp;void</CODE></FONT></TD>
273<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/taskdefs/optional/Cab.html#setOptions(java.lang.String)">setOptions</A></B>(java.lang.String&nbsp;options)</CODE>
274
275<BR>
276&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets additional cabarc options that are not supported directly.</TD>
277</TR>
278<TR BGCOLOR="white" CLASS="TableRowColor">
279<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
280<CODE>&nbsp;void</CODE></FONT></TD>
281<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/taskdefs/optional/Cab.html#setVerbose(boolean)">setVerbose</A></B>(boolean&nbsp;verbose)</CODE>
282
283<BR>
284&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;If true, display cabarc output.</TD>
285</TR>
286</TABLE>
287&nbsp;<A NAME="methods_inherited_from_class_org.apache.tools.ant.taskdefs.MatchingTask"><!-- --></A>
288<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
289<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
290<TD><B>Methods inherited from class org.apache.tools.ant.taskdefs.<A HREF="../../../../../../org/apache/tools/ant/taskdefs/MatchingTask.html" title="class in org.apache.tools.ant.taskdefs">MatchingTask</A></B></TD>
291</TR>
292<TR BGCOLOR="white" CLASS="TableRowColor">
293<TD><CODE><A HREF="../../../../../../org/apache/tools/ant/taskdefs/MatchingTask.html#add(org.apache.tools.ant.types.selectors.FileSelector)">add</A>, <A HREF="../../../../../../org/apache/tools/ant/taskdefs/MatchingTask.html#addAnd(org.apache.tools.ant.types.selectors.AndSelector)">addAnd</A>, <A HREF="../../../../../../org/apache/tools/ant/taskdefs/MatchingTask.html#addContains(org.apache.tools.ant.types.selectors.ContainsSelector)">addContains</A>, <A HREF="../../../../../../org/apache/tools/ant/taskdefs/MatchingTask.html#addContainsRegexp(org.apache.tools.ant.types.selectors.ContainsRegexpSelector)">addContainsRegexp</A>, <A HREF="../../../../../../org/apache/tools/ant/taskdefs/MatchingTask.html#addCustom(org.apache.tools.ant.types.selectors.ExtendSelector)">addCustom</A>, <A HREF="../../../../../../org/apache/tools/ant/taskdefs/MatchingTask.html#addDate(org.apache.tools.ant.types.selectors.DateSelector)">addDate</A>, <A HREF="../../../../../../org/apache/tools/ant/taskdefs/MatchingTask.html#addDepend(org.apache.tools.ant.types.selectors.DependSelector)">addDepend</A>, <A HREF="../../../../../../org/apache/tools/ant/taskdefs/MatchingTask.html#addDepth(org.apache.tools.ant.types.selectors.DepthSelector)">addDepth</A>, <A HREF="../../../../../../org/apache/tools/ant/taskdefs/MatchingTask.html#addDifferent(org.apache.tools.ant.types.selectors.DifferentSelector)">addDifferent</A>, <A HREF="../../../../../../org/apache/tools/ant/taskdefs/MatchingTask.html#addFilename(org.apache.tools.ant.types.selectors.FilenameSelector)">addFilename</A>, <A HREF="../../../../../../org/apache/tools/ant/taskdefs/MatchingTask.html#addMajority(org.apache.tools.ant.types.selectors.MajoritySelector)">addMajority</A>, <A HREF="../../../../../../org/apache/tools/ant/taskdefs/MatchingTask.html#addModified(org.apache.tools.ant.types.selectors.modifiedselector.ModifiedSelector)">addModified</A>, <A HREF="../../../../../../org/apache/tools/ant/taskdefs/MatchingTask.html#addNone(org.apache.tools.ant.types.selectors.NoneSelector)">addNone</A>, <A HREF="../../../../../../org/apache/tools/ant/taskdefs/MatchingTask.html#addNot(org.apache.tools.ant.types.selectors.NotSelector)">addNot</A>, <A HREF="../../../../../../org/apache/tools/ant/taskdefs/MatchingTask.html#addOr(org.apache.tools.ant.types.selectors.OrSelector)">addOr</A>, <A HREF="../../../../../../org/apache/tools/ant/taskdefs/MatchingTask.html#addPresent(org.apache.tools.ant.types.selectors.PresentSelector)">addPresent</A>, <A HREF="../../../../../../org/apache/tools/ant/taskdefs/MatchingTask.html#addSelector(org.apache.tools.ant.types.selectors.SelectSelector)">addSelector</A>, <A HREF="../../../../../../org/apache/tools/ant/taskdefs/MatchingTask.html#addSize(org.apache.tools.ant.types.selectors.SizeSelector)">addSize</A>, <A HREF="../../../../../../org/apache/tools/ant/taskdefs/MatchingTask.html#addType(org.apache.tools.ant.types.selectors.TypeSelector)">addType</A>, <A HREF="../../../../../../org/apache/tools/ant/taskdefs/MatchingTask.html#appendSelector(org.apache.tools.ant.types.selectors.FileSelector)">appendSelector</A>, <A HREF="../../../../../../org/apache/tools/ant/taskdefs/MatchingTask.html#createExclude()">createExclude</A>, <A HREF="../../../../../../org/apache/tools/ant/taskdefs/MatchingTask.html#createExcludesFile()">createExcludesFile</A>, <A HREF="../../../../../../org/apache/tools/ant/taskdefs/MatchingTask.html#createInclude()">createInclude</A>, <A HREF="../../../../../../org/apache/tools/ant/taskdefs/MatchingTask.html#createIncludesFile()">createIncludesFile</A>, <A HREF="../../../../../../org/apache/tools/ant/taskdefs/MatchingTask.html#createPatternSet()">createPatternSet</A>, <A HREF="../../../../../../org/apache/tools/ant/taskdefs/MatchingTask.html#getDirectoryScanner(java.io.File)">getDirectoryScanner</A>, <A HREF="../../../../../../org/apache/tools/ant/taskdefs/MatchingTask.html#getImplicitFileSet()">getImplicitFileSet</A>, <A HREF="../../../../../../org/apache/tools/ant/taskdefs/MatchingTask.html#getSelectors(org.apache.tools.ant.Project)">getSelectors</A>, <A HREF="../../../../../../org/apache/tools/ant/taskdefs/MatchingTask.html#hasSelectors()">hasSelectors</A>, <A HREF="../../../../../../org/apache/tools/ant/taskdefs/MatchingTask.html#selectorCount()">selectorCount</A>, <A HREF="../../../../../../org/apache/tools/ant/taskdefs/MatchingTask.html#selectorElements()">selectorElements</A>, <A HREF="../../../../../../org/apache/tools/ant/taskdefs/MatchingTask.html#setCaseSensitive(boolean)">setCaseSensitive</A>, <A HREF="../../../../../../org/apache/tools/ant/taskdefs/MatchingTask.html#setDefaultexcludes(boolean)">setDefaultexcludes</A>, <A HREF="../../../../../../org/apache/tools/ant/taskdefs/MatchingTask.html#setExcludes(java.lang.String)">setExcludes</A>, <A HREF="../../../../../../org/apache/tools/ant/taskdefs/MatchingTask.html#setExcludesfile(java.io.File)">setExcludesfile</A>, <A HREF="../../../../../../org/apache/tools/ant/taskdefs/MatchingTask.html#setFollowSymlinks(boolean)">setFollowSymlinks</A>, <A HREF="../../../../../../org/apache/tools/ant/taskdefs/MatchingTask.html#setIncludes(java.lang.String)">setIncludes</A>, <A HREF="../../../../../../org/apache/tools/ant/taskdefs/MatchingTask.html#setIncludesfile(java.io.File)">setIncludesfile</A>, <A HREF="../../../../../../org/apache/tools/ant/taskdefs/MatchingTask.html#setProject(org.apache.tools.ant.Project)">setProject</A>, <A HREF="../../../../../../org/apache/tools/ant/taskdefs/MatchingTask.html#XsetIgnore(java.lang.String)">XsetIgnore</A>, <A HREF="../../../../../../org/apache/tools/ant/taskdefs/MatchingTask.html#XsetItems(java.lang.String)">XsetItems</A></CODE></TD>
294</TR>
295</TABLE>
296&nbsp;<A NAME="methods_inherited_from_class_org.apache.tools.ant.Task"><!-- --></A>
297<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
298<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
299<TD><B>Methods inherited from class org.apache.tools.ant.<A HREF="../../../../../../org/apache/tools/ant/Task.html" title="class in org.apache.tools.ant">Task</A></B></TD>
300</TR>
301<TR BGCOLOR="white" CLASS="TableRowColor">
302<TD><CODE><A HREF="../../../../../../org/apache/tools/ant/Task.html#getDescription()">getDescription</A>, <A HREF="../../../../../../org/apache/tools/ant/Task.html#getLocation()">getLocation</A>, <A HREF="../../../../../../org/apache/tools/ant/Task.html#getOwningTarget()">getOwningTarget</A>, <A HREF="../../../../../../org/apache/tools/ant/Task.html#getRuntimeConfigurableWrapper()">getRuntimeConfigurableWrapper</A>, <A HREF="../../../../../../org/apache/tools/ant/Task.html#getTaskName()">getTaskName</A>, <A HREF="../../../../../../org/apache/tools/ant/Task.html#getTaskType()">getTaskType</A>, <A HREF="../../../../../../org/apache/tools/ant/Task.html#getWrapper()">getWrapper</A>, <A HREF="../../../../../../org/apache/tools/ant/Task.html#handleErrorFlush(java.lang.String)">handleErrorFlush</A>, <A HREF="../../../../../../org/apache/tools/ant/Task.html#handleErrorOutput(java.lang.String)">handleErrorOutput</A>, <A HREF="../../../../../../org/apache/tools/ant/Task.html#handleFlush(java.lang.String)">handleFlush</A>, <A HREF="../../../../../../org/apache/tools/ant/Task.html#handleInput(byte[], int, int)">handleInput</A>, <A HREF="../../../../../../org/apache/tools/ant/Task.html#handleOutput(java.lang.String)">handleOutput</A>, <A HREF="../../../../../../org/apache/tools/ant/Task.html#init()">init</A>, <A HREF="../../../../../../org/apache/tools/ant/Task.html#isInvalid()">isInvalid</A>, <A HREF="../../../../../../org/apache/tools/ant/Task.html#log(java.lang.String)">log</A>, <A HREF="../../../../../../org/apache/tools/ant/Task.html#log(java.lang.String, int)">log</A>, <A HREF="../../../../../../org/apache/tools/ant/Task.html#maybeConfigure()">maybeConfigure</A>, <A HREF="../../../../../../org/apache/tools/ant/Task.html#perform()">perform</A>, <A HREF="../../../../../../org/apache/tools/ant/Task.html#reconfigure()">reconfigure</A>, <A HREF="../../../../../../org/apache/tools/ant/Task.html#setDescription(java.lang.String)">setDescription</A>, <A HREF="../../../../../../org/apache/tools/ant/Task.html#setLocation(org.apache.tools.ant.Location)">setLocation</A>, <A HREF="../../../../../../org/apache/tools/ant/Task.html#setOwningTarget(org.apache.tools.ant.Target)">setOwningTarget</A>, <A HREF="../../../../../../org/apache/tools/ant/Task.html#setRuntimeConfigurableWrapper(org.apache.tools.ant.RuntimeConfigurable)">setRuntimeConfigurableWrapper</A>, <A HREF="../../../../../../org/apache/tools/ant/Task.html#setTaskName(java.lang.String)">setTaskName</A>, <A HREF="../../../../../../org/apache/tools/ant/Task.html#setTaskType(java.lang.String)">setTaskType</A></CODE></TD>
303</TR>
304</TABLE>
305&nbsp;<A NAME="methods_inherited_from_class_org.apache.tools.ant.ProjectComponent"><!-- --></A>
306<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
307<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
308<TD><B>Methods inherited from class org.apache.tools.ant.<A HREF="../../../../../../org/apache/tools/ant/ProjectComponent.html" title="class in org.apache.tools.ant">ProjectComponent</A></B></TD>
309</TR>
310<TR BGCOLOR="white" CLASS="TableRowColor">
311<TD><CODE><A HREF="../../../../../../org/apache/tools/ant/ProjectComponent.html#getProject()">getProject</A></CODE></TD>
312</TR>
313</TABLE>
314&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
315<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
316<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
317<TD><B>Methods inherited from class java.lang.Object</B></TD>
318</TR>
319<TR BGCOLOR="white" CLASS="TableRowColor">
320<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
321</TR>
322</TABLE>
323&nbsp;
324<P>
325
326<!-- ============ FIELD DETAIL =========== -->
327
328<A NAME="field_detail"><!-- --></A>
329<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
330<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
331<TD COLSPAN=1><FONT SIZE="+2">
332<B>Field Detail</B></FONT></TD>
333</TR>
334</TABLE>
335
336<A NAME="archiveType"><!-- --></A><H3>
337archiveType</H3>
338<PRE>
339protected java.lang.String <B>archiveType</B></PRE>
340<DL>
341<DL>
342</DL>
343</DL>
344
345<!-- ========= CONSTRUCTOR DETAIL ======== -->
346
347<A NAME="constructor_detail"><!-- --></A>
348<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
349<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
350<TD COLSPAN=1><FONT SIZE="+2">
351<B>Constructor Detail</B></FONT></TD>
352</TR>
353</TABLE>
354
355<A NAME="Cab()"><!-- --></A><H3>
356Cab</H3>
357<PRE>
358public <B>Cab</B>()</PRE>
359<DL>
360</DL>
361
362<!-- ============ METHOD DETAIL ========== -->
363
364<A NAME="method_detail"><!-- --></A>
365<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
366<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
367<TD COLSPAN=1><FONT SIZE="+2">
368<B>Method Detail</B></FONT></TD>
369</TR>
370</TABLE>
371
372<A NAME="setCabfile(java.io.File)"><!-- --></A><H3>
373setCabfile</H3>
374<PRE>
375public void <B>setCabfile</B>(java.io.File&nbsp;cabFile)</PRE>
376<DL>
377<DD>The name/location of where to create the .cab file.
378<P>
379<DD><DL>
380</DL>
381</DD>
382</DL>
383<HR>
384
385<A NAME="setBasedir(java.io.File)"><!-- --></A><H3>
386setBasedir</H3>
387<PRE>
388public void <B>setBasedir</B>(java.io.File&nbsp;baseDir)</PRE>
389<DL>
390<DD>Base directory to look in for files to CAB.
391<P>
392<DD><DL>
393</DL>
394</DD>
395</DL>
396<HR>
397
398<A NAME="setCompress(boolean)"><!-- --></A><H3>
399setCompress</H3>
400<PRE>
401public void <B>setCompress</B>(boolean&nbsp;compress)</PRE>
402<DL>
403<DD>If true, compress the files otherwise only store them.
404<P>
405<DD><DL>
406</DL>
407</DD>
408</DL>
409<HR>
410
411<A NAME="setVerbose(boolean)"><!-- --></A><H3>
412setVerbose</H3>
413<PRE>
414public void <B>setVerbose</B>(boolean&nbsp;verbose)</PRE>
415<DL>
416<DD>If true, display cabarc output.
417<P>
418<DD><DL>
419</DL>
420</DD>
421</DL>
422<HR>
423
424<A NAME="setOptions(java.lang.String)"><!-- --></A><H3>
425setOptions</H3>
426<PRE>
427public void <B>setOptions</B>(java.lang.String&nbsp;options)</PRE>
428<DL>
429<DD>Sets additional cabarc options that are not supported directly.
430<P>
431<DD><DL>
432</DL>
433</DD>
434</DL>
435<HR>
436
437<A NAME="addFileset(org.apache.tools.ant.types.FileSet)"><!-- --></A><H3>
438addFileset</H3>
439<PRE>
440public void <B>addFileset</B>(<A HREF="../../../../../../org/apache/tools/ant/types/FileSet.html" title="class in org.apache.tools.ant.types">FileSet</A>&nbsp;set)</PRE>
441<DL>
442<DD>Adds a set of files to archive.
443<P>
444<DD><DL>
445</DL>
446</DD>
447</DL>
448<HR>
449
450<A NAME="checkConfiguration()"><!-- --></A><H3>
451checkConfiguration</H3>
452<PRE>
453protected void <B>checkConfiguration</B>()
454 throws <A HREF="../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></PRE>
455<DL>
456<DD><DL>
457
458<DT><B>Throws:</B>
459<DD><CODE><A HREF="../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></CODE></DL>
460</DD>
461</DL>
462<HR>
463
464<A NAME="createExec()"><!-- --></A><H3>
465createExec</H3>
466<PRE>
467protected <A HREF="../../../../../../org/apache/tools/ant/taskdefs/ExecTask.html" title="class in org.apache.tools.ant.taskdefs">ExecTask</A> <B>createExec</B>()
468 throws <A HREF="../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></PRE>
469<DL>
470<DD>Create a new exec delegate. The delegate task is populated so that
471 it appears in the logs to be the same task as this one.
472<P>
473<DD><DL>
474
475<DT><B>Throws:</B>
476<DD><CODE><A HREF="../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></CODE></DL>
477</DD>
478</DL>
479<HR>
480
481<A NAME="isUpToDate(java.util.Vector)"><!-- --></A><H3>
482isUpToDate</H3>
483<PRE>
484protected boolean <B>isUpToDate</B>(java.util.Vector&nbsp;files)</PRE>
485<DL>
486<DD>Check to see if the target is up to date with respect to input files.
487<P>
488<DD><DL>
489
490<DT><B>Returns:</B><DD>true if the cab file is newer than its dependents.</DL>
491</DD>
492</DL>
493<HR>
494
495<A NAME="createListFile(java.util.Vector)"><!-- --></A><H3>
496createListFile</H3>
497<PRE>
498protected java.io.File <B>createListFile</B>(java.util.Vector&nbsp;files)
499 throws java.io.IOException</PRE>
500<DL>
501<DD>Creates a list file. This temporary file contains a list of all files
502 to be included in the cab, one file per line.
503
504 <p>This method expects to only be called on Windows and thus
505 quotes the file names.</p>
506<P>
507<DD><DL>
508
509<DT><B>Throws:</B>
510<DD><CODE>java.io.IOException</CODE></DL>
511</DD>
512</DL>
513<HR>
514
515<A NAME="appendFiles(java.util.Vector, org.apache.tools.ant.DirectoryScanner)"><!-- --></A><H3>
516appendFiles</H3>
517<PRE>
518protected void <B>appendFiles</B>(java.util.Vector&nbsp;files,
519 <A HREF="../../../../../../org/apache/tools/ant/DirectoryScanner.html" title="class in org.apache.tools.ant">DirectoryScanner</A>&nbsp;ds)</PRE>
520<DL>
521<DD>Append all files found by a directory scanner to a vector.
522<P>
523<DD><DL>
524</DL>
525</DD>
526</DL>
527<HR>
528
529<A NAME="getFileList()"><!-- --></A><H3>
530getFileList</H3>
531<PRE>
532protected java.util.Vector <B>getFileList</B>()
533 throws <A HREF="../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></PRE>
534<DL>
535<DD>Get the complete list of files to be included in the cab. Filenames
536 are gathered from filesets if any have been added, otherwise from the
537 traditional include parameters.
538<P>
539<DD><DL>
540
541<DT><B>Throws:</B>
542<DD><CODE><A HREF="../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></CODE></DL>
543</DD>
544</DL>
545<HR>
546
547<A NAME="execute()"><!-- --></A><H3>
548execute</H3>
549<PRE>
550public void <B>execute</B>()
551 throws <A HREF="../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></PRE>
552<DL>
553<DD><B>Description copied from class: <CODE><A HREF="../../../../../../org/apache/tools/ant/Task.html" title="class in org.apache.tools.ant">Task</A></CODE></B></DD>
554<DD>Called by the project to let the task do its work. This method may be
555 called more than once, if the task is invoked more than once.
556 For example,
557 if target1 and target2 both depend on target3, then running
558 "ant target1 target2" will run all tasks in target3 twice.
559<P>
560<DD><DL>
561<DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../../org/apache/tools/ant/Task.html#execute()">execute</A></CODE> in class <CODE><A HREF="../../../../../../org/apache/tools/ant/Task.html" title="class in org.apache.tools.ant">Task</A></CODE></DL>
562</DD>
563<DD><DL>
564
565<DT><B>Throws:</B>
566<DD><CODE><A HREF="../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></CODE> - if something goes wrong with the build</DL>
567</DD>
568</DL>
569<!-- ========= END OF CLASS DATA ========= -->
570<HR>
571
572
573<!-- ======= START OF BOTTOM NAVBAR ====== -->
574<A NAME="navbar_bottom"><!-- --></A>
575<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
576<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
577<TR>
578<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
579<A NAME="navbar_bottom_firstrow"><!-- --></A>
580<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
581 <TR ALIGN="center" VALIGN="top">
582 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
583 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
584 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
585 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
586 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
587 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
588 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
589 </TR>
590</TABLE>
591</TD>
592<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
593</EM>
594</TD>
595</TR>
596
597<TR>
598<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
599&nbsp;<A HREF="../../../../../../org/apache/tools/ant/taskdefs/optional/ANTLR.html" title="class in org.apache.tools.ant.taskdefs.optional"><B>PREV CLASS</B></A>&nbsp;
600&nbsp;<A HREF="../../../../../../org/apache/tools/ant/taskdefs/optional/EchoProperties.html" title="class in org.apache.tools.ant.taskdefs.optional"><B>NEXT CLASS</B></A></FONT></TD>
601<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
602 <A HREF="../../../../../../index.html" target="_top"><B>FRAMES</B></A> &nbsp;
603&nbsp;<A HREF="Cab.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
604&nbsp;<SCRIPT type="text/javascript">
605 <!--
606 if(window==top) {
607 document.writeln('<A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
608 }
609 //-->
610</SCRIPT>
611<NOSCRIPT>
612 <A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>
613</NOSCRIPT>
614
615</FONT></TD>
616</TR>
617<TR>
618<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
619 SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
620<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
621DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
622</TR>
623</TABLE>
624<A NAME="skip-navbar_bottom"></A>
625<!-- ======== END OF BOTTOM NAVBAR ======= -->
626
627<HR>
628Copyright © 2000-2007 Apache Software Foundation. All Rights Reserved.
629</BODY>
630</HTML>
Note: See TracBrowser for help on using the repository browser.