NAnt.CompressionTasks.xml 30 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>NAnt.CompressionTasks</name>
  5. </assembly>
  6. <members>
  7. <member name="T:NAnt.Compression.Tasks.GUnzip">
  8. <summary>
  9. Expands a file packed using GZip compression.
  10. </summary>
  11. <example>
  12. <para>Expands &quot;test.tar.gz&quot; to &quot;test2.tar&quot;.</para>
  13. <code>
  14. <![CDATA[
  15. <gunzip src="test.tar.gz" dest="test.tar" />
  16. ]]>
  17. </code>
  18. </example>
  19. </member>
  20. <member name="M:NAnt.Compression.Tasks.GUnzip.ExecuteTask">
  21. <summary>
  22. Extracts the file from the gzip archive.
  23. </summary>
  24. </member>
  25. <member name="P:NAnt.Compression.Tasks.GUnzip.SrcFile">
  26. <summary>
  27. The file to expand.
  28. </summary>
  29. </member>
  30. <member name="P:NAnt.Compression.Tasks.GUnzip.DestFile">
  31. <summary>
  32. The destination file.
  33. </summary>
  34. </member>
  35. <member name="T:NAnt.Compression.Tasks.TarTask">
  36. <summary>
  37. Creates a tar file from the specified filesets.
  38. </summary>
  39. <remarks>
  40. <para>Uses <see href="http://www.icsharpcode.net/OpenSource/SharpZipLib/">#ziplib</see> (SharpZipLib), an open source Tar/Zip/GZip library written entirely in C#.</para>
  41. </remarks>
  42. <example>
  43. <para>
  44. Tar all files in <c>${build.dir}</c> and <c>${doc.dir}</c> into a file
  45. called &quot;backup.tar.gz&quot;, and apply gzip compression to it.
  46. </para>
  47. <code>
  48. <![CDATA[
  49. <tar destfile="backup.tar.gz" compression="GZip">
  50. <fileset basedir="${bin.dir}" prefix="bin">
  51. <include name="**/*" />
  52. </fileset>
  53. <fileset basedir="${doc.dir}" prefix="doc">
  54. <include name="**/*" />
  55. </fileset>
  56. </tar>
  57. ]]>
  58. </code>
  59. </example>
  60. </member>
  61. <member name="M:NAnt.Compression.Tasks.TarTask.ExecuteTask">
  62. <summary>
  63. Creates the tar file.
  64. </summary>
  65. </member>
  66. <member name="P:NAnt.Compression.Tasks.TarTask.DestFile">
  67. <summary>
  68. The tar file to create.
  69. </summary>
  70. </member>
  71. <member name="P:NAnt.Compression.Tasks.TarTask.IncludeEmptyDirs">
  72. <summary>
  73. Include empty directories in the generated tar file. The default is
  74. <see langword="false" />.
  75. </summary>
  76. </member>
  77. <member name="P:NAnt.Compression.Tasks.TarTask.TarFileSets">
  78. <summary>
  79. The set of files to be included in the archive.
  80. </summary>
  81. </member>
  82. <member name="P:NAnt.Compression.Tasks.TarTask.CompressionMethod">
  83. <summary>
  84. The compression method. The default is <see cref="F:NAnt.Compression.Tasks.TarCompressionMethod.None"/>.
  85. </summary>
  86. </member>
  87. <member name="T:NAnt.Compression.Tasks.TarCompressionMethod">
  88. <summary>
  89. Specifies the compression methods supported by <see cref="T:NAnt.Compression.Tasks.TarTask"/>.
  90. </summary>
  91. </member>
  92. <member name="F:NAnt.Compression.Tasks.TarCompressionMethod.None">
  93. <summary>
  94. No compression.
  95. </summary>
  96. </member>
  97. <member name="F:NAnt.Compression.Tasks.TarCompressionMethod.GZip">
  98. <summary>
  99. GZIP compression.
  100. </summary>
  101. </member>
  102. <member name="F:NAnt.Compression.Tasks.TarCompressionMethod.BZip2">
  103. <summary>
  104. BZIP2 compression.
  105. </summary>
  106. </member>
  107. <member name="T:NAnt.Compression.Tasks.UnZipTask">
  108. <summary>
  109. Extracts files from a zip file.
  110. </summary>
  111. <remarks>
  112. <para>Uses <see href="http://www.icsharpcode.net/OpenSource/SharpZipLib/">#ziplib</see> (SharpZipLib), an open source Zip/GZip library written entirely in C#.</para>
  113. </remarks>
  114. <example>
  115. <para>Extracts all the file from the zip, preserving the directory structure.</para>
  116. <code>
  117. <![CDATA[
  118. <unzip zipfile="backup.zip"/>
  119. ]]>
  120. </code>
  121. </example>
  122. </member>
  123. <member name="M:NAnt.Compression.Tasks.UnZipTask.ExecuteTask">
  124. <summary>
  125. Extracts the files from the zip file.
  126. </summary>
  127. </member>
  128. <member name="M:NAnt.Compression.Tasks.UnZipTask.ExtractFile(System.IO.Stream,System.String,System.DateTime,System.Int64)">
  129. <summary>
  130. Extracts a file entry from the specified stream.
  131. </summary>
  132. <param name="inputStream">The <see cref="T:System.IO.Stream"/> containing the compressed entry.</param>
  133. <param name="entryName">The name of the entry including directory information.</param>
  134. <param name="entryDate">The date of the entry.</param>
  135. <param name="entrySize">The uncompressed size of the entry.</param>
  136. <exception cref="T:NAnt.Core.BuildException">
  137. <para>The destination directory for the entry could not be created.</para>
  138. <para>-or-</para>
  139. <para>The entry could not be extracted.</para>
  140. </exception>
  141. <remarks>
  142. We cannot rely on the fact that the directory entry of a given file
  143. is created before the file is extracted, so we should create the
  144. directory if it doesn't yet exist.
  145. </remarks>
  146. </member>
  147. <member name="M:NAnt.Compression.Tasks.UnZipTask.ExtractDirectory(System.IO.Stream,System.String,System.DateTime)">
  148. <summary>
  149. Extracts a directory entry from the specified stream.
  150. </summary>
  151. <param name="inputStream">The <see cref="T:System.IO.Stream"/> containing the directory entry.</param>
  152. <param name="entryName">The name of the directory entry.</param>
  153. <param name="entryDate">The date of the entry.</param>
  154. <exception cref="T:NAnt.Core.BuildException">
  155. <para>The destination directory for the entry could not be created.</para>
  156. </exception>
  157. </member>
  158. <member name="P:NAnt.Compression.Tasks.UnZipTask.ZipFile">
  159. <summary>
  160. The archive file to expand.
  161. </summary>
  162. </member>
  163. <member name="P:NAnt.Compression.Tasks.UnZipTask.ToDirectory">
  164. <summary>
  165. The directory where the expanded files should be stored. The
  166. default is the project base directory.
  167. </summary>
  168. </member>
  169. <member name="P:NAnt.Compression.Tasks.UnZipTask.Overwrite">
  170. <summary>
  171. Overwrite files, even if they are newer than the corresponding
  172. entries in the archive. The default is <see langword="true" />.
  173. </summary>
  174. </member>
  175. <member name="P:NAnt.Compression.Tasks.UnZipTask.Encoding">
  176. <summary>
  177. The character encoding that has been used for filenames inside the
  178. zip file. The default is the system's OEM code page.
  179. </summary>
  180. </member>
  181. <member name="T:NAnt.Compression.Tasks.ZipTask">
  182. <summary>
  183. Creates a zip file from the specified filesets.
  184. </summary>
  185. <remarks>
  186. <para>Uses <see href="http://www.icsharpcode.net/OpenSource/SharpZipLib/">#ziplib</see> (SharpZipLib), an open source Tar/Zip/GZip library written entirely in C#.</para>
  187. </remarks>
  188. <example>
  189. <para>
  190. Zip all files in <c>${build.dir}</c> and <c>${doc.dir}</c> into a file
  191. called &quot;backup.zip&quot;.
  192. </para>
  193. <code>
  194. <![CDATA[
  195. <zip zipfile="backup.zip">
  196. <fileset basedir="${bin.dir}" prefix="bin">
  197. <include name="**/*" />
  198. </fileset>
  199. <fileset basedir="${doc.dir}" prefix="doc">
  200. <include name="**/*" />
  201. </fileset>
  202. </zip>
  203. ]]>
  204. </code>
  205. </example>
  206. </member>
  207. <member name="M:NAnt.Compression.Tasks.ZipTask.ExecuteTask">
  208. <summary>
  209. Creates the zip file.
  210. </summary>
  211. </member>
  212. <member name="P:NAnt.Compression.Tasks.ZipTask.ZipFile">
  213. <summary>
  214. The zip file to create.
  215. </summary>
  216. </member>
  217. <member name="P:NAnt.Compression.Tasks.ZipTask.Comment">
  218. <summary>
  219. The comment for the file.
  220. </summary>
  221. </member>
  222. <member name="P:NAnt.Compression.Tasks.ZipTask.Stamp">
  223. <summary>
  224. Date/time stamp for the files in the format MM/DD/YYYY HH:MM:SS.
  225. </summary>
  226. </member>
  227. <member name="P:NAnt.Compression.Tasks.ZipTask.ZipLevel">
  228. <summary>
  229. Desired level of compression. Possible values are 0 (STORE only)
  230. to 9 (highest). The default is <c>6</c>.
  231. </summary>
  232. </member>
  233. <member name="P:NAnt.Compression.Tasks.ZipTask.IncludeEmptyDirs">
  234. <summary>
  235. Include empty directories in the generated zip file. The default is
  236. <see langword="false" />.
  237. </summary>
  238. </member>
  239. <member name="P:NAnt.Compression.Tasks.ZipTask.ZipFileSets">
  240. <summary>
  241. The set of files to be included in the archive.
  242. </summary>
  243. </member>
  244. <member name="P:NAnt.Compression.Tasks.ZipTask.DuplicateHandling">
  245. <summary>
  246. Specifies the behaviour when a duplicate file is found. The default
  247. is <see cref="F:NAnt.Compression.Types.DuplicateHandling.Add"/>.
  248. </summary>
  249. </member>
  250. <member name="P:NAnt.Compression.Tasks.ZipTask.Encoding">
  251. <summary>
  252. The character encoding to use for filenames and comment inside the
  253. zip file. The default is the system's OEM code page.
  254. </summary>
  255. </member>
  256. <member name="T:NAnt.Compression.Types.DuplicateHandling">
  257. <summary>
  258. Specifies how entries with the same name should be processed.
  259. </summary>
  260. </member>
  261. <member name="F:NAnt.Compression.Types.DuplicateHandling.Add">
  262. <summary>
  263. Overwrite existing entry with same name.
  264. </summary>
  265. </member>
  266. <member name="F:NAnt.Compression.Types.DuplicateHandling.Preserve">
  267. <summary>
  268. Preserve existing entry with the same name.
  269. </summary>
  270. </member>
  271. <member name="F:NAnt.Compression.Types.DuplicateHandling.Fail">
  272. <summary>
  273. Report failure when two entries have the same name.
  274. </summary>
  275. </member>
  276. <member name="T:NAnt.Compression.Types.TarFileSet">
  277. <summary>
  278. A <see cref="T:NAnt.Compression.Types.TarFileSet"/> is a <see cref="T:NAnt.Core.Types.FileSet"/> with extra
  279. attributes useful in the context of the <see cref="T:NAnt.Compression.Tasks.TarTask"/>.
  280. </summary>
  281. </member>
  282. <member name="P:NAnt.Compression.Types.TarFileSet.FileMode">
  283. <summary>
  284. A 3 digit octal string, specify the user, group and other modes
  285. in the standard Unix fashion. Only applies to plain files. The
  286. default is <c>644</c>.
  287. </summary>
  288. </member>
  289. <member name="P:NAnt.Compression.Types.TarFileSet.DirMode">
  290. <summary>
  291. A 3 digit octal string, specify the user, group and other modes
  292. in the standard Unix fashion. Only applies to directories. The
  293. default is <c>755</c>.
  294. </summary>
  295. </member>
  296. <member name="P:NAnt.Compression.Types.TarFileSet.UserName">
  297. <summary>
  298. The username for the tar entry.
  299. </summary>
  300. </member>
  301. <member name="P:NAnt.Compression.Types.TarFileSet.Uid">
  302. <summary>
  303. The user identifier (UID) for the tar entry.
  304. </summary>
  305. </member>
  306. <member name="P:NAnt.Compression.Types.TarFileSet.GroupName">
  307. <summary>
  308. The groupname for the tar entry.
  309. </summary>
  310. </member>
  311. <member name="P:NAnt.Compression.Types.TarFileSet.Gid">
  312. <summary>
  313. The group identifier (GID) for the tar entry.
  314. </summary>
  315. </member>
  316. <member name="P:NAnt.Compression.Types.TarFileSet.Prefix">
  317. <summary>
  318. The top level directory prefix. If set, all file and directory paths
  319. in the fileset will have this value prepended. Can either be a single
  320. directory name or a "/" separated path.
  321. </summary>
  322. </member>
  323. <member name="T:NAnt.Compression.Types.TarFileSetCollection">
  324. <summary>
  325. Contains a collection of <see cref="T:NAnt.Compression.Types.TarFileSet"/> elements.
  326. </summary>
  327. </member>
  328. <member name="M:NAnt.Compression.Types.TarFileSetCollection.#ctor">
  329. <summary>
  330. Initializes a new instance of the <see cref="T:NAnt.Compression.Types.TarFileSetCollection"/> class.
  331. </summary>
  332. </member>
  333. <member name="M:NAnt.Compression.Types.TarFileSetCollection.#ctor(NAnt.Compression.Types.TarFileSetCollection)">
  334. <summary>
  335. Initializes a new instance of the <see cref="T:NAnt.Compression.Types.TarFileSetCollection"/> class
  336. with the specified <see cref="T:NAnt.Compression.Types.TarFileSetCollection"/> instance.
  337. </summary>
  338. </member>
  339. <member name="M:NAnt.Compression.Types.TarFileSetCollection.#ctor(NAnt.Compression.Types.TarFileSet[])">
  340. <summary>
  341. Initializes a new instance of the <see cref="T:NAnt.Compression.Types.TarFileSetCollection"/> class
  342. with the specified array of <see cref="T:NAnt.Compression.Types.TarFileSet"/> instances.
  343. </summary>
  344. </member>
  345. <member name="M:NAnt.Compression.Types.TarFileSetCollection.Add(NAnt.Compression.Types.TarFileSet)">
  346. <summary>
  347. Adds a <see cref="T:NAnt.Compression.Types.TarFileSet"/> to the end of the collection.
  348. </summary>
  349. <param name="item">The <see cref="T:NAnt.Compression.Types.TarFileSet"/> to be added to the end of the collection.</param>
  350. <returns>The position into which the new element was inserted.</returns>
  351. </member>
  352. <member name="M:NAnt.Compression.Types.TarFileSetCollection.AddRange(NAnt.Compression.Types.TarFileSet[])">
  353. <summary>
  354. Adds the elements of a <see cref="T:NAnt.Compression.Types.TarFileSet"/> array to the end of the collection.
  355. </summary>
  356. <param name="items">The array of <see cref="T:NAnt.Compression.Types.TarFileSet"/> elements to be added to the end of the collection.</param>
  357. </member>
  358. <member name="M:NAnt.Compression.Types.TarFileSetCollection.AddRange(NAnt.Compression.Types.TarFileSetCollection)">
  359. <summary>
  360. Adds the elements of a <see cref="T:NAnt.Compression.Types.TarFileSetCollection"/> to the end of the collection.
  361. </summary>
  362. <param name="items">The <see cref="T:NAnt.Compression.Types.TarFileSetCollection"/> to be added to the end of the collection.</param>
  363. </member>
  364. <member name="M:NAnt.Compression.Types.TarFileSetCollection.Contains(NAnt.Compression.Types.TarFileSet)">
  365. <summary>
  366. Determines whether a <see cref="T:NAnt.Compression.Types.TarFileSet"/> is in the collection.
  367. </summary>
  368. <param name="item">The <see cref="T:NAnt.Compression.Types.TarFileSet"/> to locate in the collection.</param>
  369. <returns>
  370. <see langword="true"/> if <paramref name="item"/> is found in the
  371. collection; otherwise, <see langword="false"/>.
  372. </returns>
  373. </member>
  374. <member name="M:NAnt.Compression.Types.TarFileSetCollection.CopyTo(NAnt.Compression.Types.TarFileSet[],System.Int32)">
  375. <summary>
  376. Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array.
  377. </summary>
  378. <param name="array">The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing.</param>
  379. <param name="index">The zero-based index in <paramref name="array"/> at which copying begins.</param>
  380. </member>
  381. <member name="M:NAnt.Compression.Types.TarFileSetCollection.IndexOf(NAnt.Compression.Types.TarFileSet)">
  382. <summary>
  383. Retrieves the index of a specified <see cref="T:NAnt.Compression.Types.TarFileSet"/> object in the collection.
  384. </summary>
  385. <param name="item">The <see cref="T:NAnt.Compression.Types.TarFileSet"/> object for which the index is returned.</param>
  386. <returns>
  387. The index of the specified <see cref="T:NAnt.Compression.Types.TarFileSet"/>. If the <see cref="T:NAnt.Compression.Types.TarFileSet"/> is not currently a member of the collection, it returns -1.
  388. </returns>
  389. </member>
  390. <member name="M:NAnt.Compression.Types.TarFileSetCollection.Insert(System.Int32,NAnt.Compression.Types.TarFileSet)">
  391. <summary>
  392. Inserts a <see cref="T:NAnt.Compression.Types.TarFileSet"/> into the collection at the specified index.
  393. </summary>
  394. <param name="index">The zero-based index at which <paramref name="item"/> should be inserted.</param>
  395. <param name="item">The <see cref="T:NAnt.Compression.Types.TarFileSet"/> to insert.</param>
  396. </member>
  397. <member name="M:NAnt.Compression.Types.TarFileSetCollection.GetEnumerator">
  398. <summary>
  399. Returns an enumerator that can iterate through the collection.
  400. </summary>
  401. <returns>
  402. A <see cref="T:NAnt.Compression.Types.TarFileSetEnumerator"/> for the entire collection.
  403. </returns>
  404. </member>
  405. <member name="M:NAnt.Compression.Types.TarFileSetCollection.Remove(NAnt.Compression.Types.TarFileSet)">
  406. <summary>
  407. Removes a member from the collection.
  408. </summary>
  409. <param name="item">The <see cref="T:NAnt.Compression.Types.TarFileSet"/> to remove from the collection.</param>
  410. </member>
  411. <member name="P:NAnt.Compression.Types.TarFileSetCollection.Item(System.Int32)">
  412. <summary>
  413. Gets or sets the element at the specified index.
  414. </summary>
  415. <param name="index">The zero-based index of the element to get or set.</param>
  416. </member>
  417. <member name="P:NAnt.Compression.Types.TarFileSetCollection.FileCount">
  418. <summary>
  419. Get the total number of files that are represented by the
  420. filesets in this collection.
  421. </summary>
  422. </member>
  423. <member name="T:NAnt.Compression.Types.TarFileSetEnumerator">
  424. <summary>
  425. Enumerates the <see cref="T:NAnt.Compression.Types.TarFileSet"/> elements of a <see cref="T:NAnt.Compression.Types.TarFileSetCollection"/>.
  426. </summary>
  427. </member>
  428. <member name="M:NAnt.Compression.Types.TarFileSetEnumerator.#ctor(NAnt.Compression.Types.TarFileSetCollection)">
  429. <summary>
  430. Initializes a new instance of the <see cref="T:NAnt.Compression.Types.TarFileSetEnumerator"/> class
  431. with the specified <see cref="T:NAnt.Compression.Types.TarFileSetCollection"/>.
  432. </summary>
  433. <param name="TarFileSets">The collection that should be enumerated.</param>
  434. </member>
  435. <member name="M:NAnt.Compression.Types.TarFileSetEnumerator.MoveNext">
  436. <summary>
  437. Advances the enumerator to the next element of the collection.
  438. </summary>
  439. <returns>
  440. <see langword="true" /> if the enumerator was successfully advanced
  441. to the next element; <see langword="false" /> if the enumerator has
  442. passed the end of the collection.
  443. </returns>
  444. </member>
  445. <member name="M:NAnt.Compression.Types.TarFileSetEnumerator.Reset">
  446. <summary>
  447. Sets the enumerator to its initial position, which is before the
  448. first element in the collection.
  449. </summary>
  450. </member>
  451. <member name="P:NAnt.Compression.Types.TarFileSetEnumerator.Current">
  452. <summary>
  453. Gets the current element in the collection.
  454. </summary>
  455. <returns>
  456. The current element in the collection.
  457. </returns>
  458. </member>
  459. <member name="T:NAnt.Compression.Types.ZipFileSet">
  460. <summary>
  461. A <see cref="T:NAnt.Compression.Types.ZipFileSet"/> is a <see cref="T:NAnt.Core.Types.FileSet"/> with extra
  462. attributes useful in the context of the <see cref="T:NAnt.Compression.Tasks.ZipTask"/>.
  463. </summary>
  464. </member>
  465. <member name="P:NAnt.Compression.Types.ZipFileSet.Prefix">
  466. <summary>
  467. The top level directory prefix. If set, all file and directory paths
  468. in the fileset will have this value prepended. Can either be a single
  469. directory name or a "/" separated path.
  470. </summary>
  471. </member>
  472. <member name="T:NAnt.Compression.Types.ZipFileSetCollection">
  473. <summary>
  474. Contains a collection of <see cref="T:NAnt.Compression.Types.ZipFileSet"/> elements.
  475. </summary>
  476. </member>
  477. <member name="M:NAnt.Compression.Types.ZipFileSetCollection.#ctor">
  478. <summary>
  479. Initializes a new instance of the <see cref="T:NAnt.Compression.Types.ZipFileSetCollection"/> class.
  480. </summary>
  481. </member>
  482. <member name="M:NAnt.Compression.Types.ZipFileSetCollection.#ctor(NAnt.Compression.Types.ZipFileSetCollection)">
  483. <summary>
  484. Initializes a new instance of the <see cref="T:NAnt.Compression.Types.ZipFileSetCollection"/> class
  485. with the specified <see cref="T:NAnt.Compression.Types.ZipFileSetCollection"/> instance.
  486. </summary>
  487. </member>
  488. <member name="M:NAnt.Compression.Types.ZipFileSetCollection.#ctor(NAnt.Compression.Types.ZipFileSet[])">
  489. <summary>
  490. Initializes a new instance of the <see cref="T:NAnt.Compression.Types.ZipFileSetCollection"/> class
  491. with the specified array of <see cref="T:NAnt.Compression.Types.ZipFileSet"/> instances.
  492. </summary>
  493. </member>
  494. <member name="M:NAnt.Compression.Types.ZipFileSetCollection.Add(NAnt.Compression.Types.ZipFileSet)">
  495. <summary>
  496. Adds a <see cref="T:NAnt.Compression.Types.ZipFileSet"/> to the end of the collection.
  497. </summary>
  498. <param name="item">The <see cref="T:NAnt.Compression.Types.ZipFileSet"/> to be added to the end of the collection.</param>
  499. <returns>The position into which the new element was inserted.</returns>
  500. </member>
  501. <member name="M:NAnt.Compression.Types.ZipFileSetCollection.AddRange(NAnt.Compression.Types.ZipFileSet[])">
  502. <summary>
  503. Adds the elements of a <see cref="T:NAnt.Compression.Types.ZipFileSet"/> array to the end of the collection.
  504. </summary>
  505. <param name="items">The array of <see cref="T:NAnt.Compression.Types.ZipFileSet"/> elements to be added to the end of the collection.</param>
  506. </member>
  507. <member name="M:NAnt.Compression.Types.ZipFileSetCollection.AddRange(NAnt.Compression.Types.ZipFileSetCollection)">
  508. <summary>
  509. Adds the elements of a <see cref="T:NAnt.Compression.Types.ZipFileSetCollection"/> to the end of the collection.
  510. </summary>
  511. <param name="items">The <see cref="T:NAnt.Compression.Types.ZipFileSetCollection"/> to be added to the end of the collection.</param>
  512. </member>
  513. <member name="M:NAnt.Compression.Types.ZipFileSetCollection.Contains(NAnt.Compression.Types.ZipFileSet)">
  514. <summary>
  515. Determines whether a <see cref="T:NAnt.Compression.Types.ZipFileSet"/> is in the collection.
  516. </summary>
  517. <param name="item">The <see cref="T:NAnt.Compression.Types.ZipFileSet"/> to locate in the collection.</param>
  518. <returns>
  519. <see langword="true"/> if <paramref name="item"/> is found in the
  520. collection; otherwise, <see langword="false"/>.
  521. </returns>
  522. </member>
  523. <member name="M:NAnt.Compression.Types.ZipFileSetCollection.CopyTo(NAnt.Compression.Types.ZipFileSet[],System.Int32)">
  524. <summary>
  525. Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array.
  526. </summary>
  527. <param name="array">The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing.</param>
  528. <param name="index">The zero-based index in <paramref name="array"/> at which copying begins.</param>
  529. </member>
  530. <member name="M:NAnt.Compression.Types.ZipFileSetCollection.IndexOf(NAnt.Compression.Types.ZipFileSet)">
  531. <summary>
  532. Retrieves the index of a specified <see cref="T:NAnt.Compression.Types.ZipFileSet"/> object in the collection.
  533. </summary>
  534. <param name="item">The <see cref="T:NAnt.Compression.Types.ZipFileSet"/> object for which the index is returned.</param>
  535. <returns>
  536. The index of the specified <see cref="T:NAnt.Compression.Types.ZipFileSet"/>. If the <see cref="T:NAnt.Compression.Types.ZipFileSet"/> is not currently a member of the collection, it returns -1.
  537. </returns>
  538. </member>
  539. <member name="M:NAnt.Compression.Types.ZipFileSetCollection.Insert(System.Int32,NAnt.Compression.Types.ZipFileSet)">
  540. <summary>
  541. Inserts a <see cref="T:NAnt.Compression.Types.ZipFileSet"/> into the collection at the specified index.
  542. </summary>
  543. <param name="index">The zero-based index at which <paramref name="item"/> should be inserted.</param>
  544. <param name="item">The <see cref="T:NAnt.Compression.Types.ZipFileSet"/> to insert.</param>
  545. </member>
  546. <member name="M:NAnt.Compression.Types.ZipFileSetCollection.GetEnumerator">
  547. <summary>
  548. Returns an enumerator that can iterate through the collection.
  549. </summary>
  550. <returns>
  551. A <see cref="T:NAnt.Compression.Types.ZipFileSetEnumerator"/> for the entire collection.
  552. </returns>
  553. </member>
  554. <member name="M:NAnt.Compression.Types.ZipFileSetCollection.Remove(NAnt.Compression.Types.ZipFileSet)">
  555. <summary>
  556. Removes a member from the collection.
  557. </summary>
  558. <param name="item">The <see cref="T:NAnt.Compression.Types.ZipFileSet"/> to remove from the collection.</param>
  559. </member>
  560. <member name="P:NAnt.Compression.Types.ZipFileSetCollection.Item(System.Int32)">
  561. <summary>
  562. Gets or sets the element at the specified index.
  563. </summary>
  564. <param name="index">The zero-based index of the element to get or set.</param>
  565. </member>
  566. <member name="P:NAnt.Compression.Types.ZipFileSetCollection.FileCount">
  567. <summary>
  568. Get the total number of files that are represented by the
  569. filesets in this collection.
  570. </summary>
  571. </member>
  572. <member name="T:NAnt.Compression.Types.ZipFileSetEnumerator">
  573. <summary>
  574. Enumerates the <see cref="T:NAnt.Compression.Types.ZipFileSet"/> elements of a <see cref="T:NAnt.Compression.Types.ZipFileSetCollection"/>.
  575. </summary>
  576. </member>
  577. <member name="M:NAnt.Compression.Types.ZipFileSetEnumerator.#ctor(NAnt.Compression.Types.ZipFileSetCollection)">
  578. <summary>
  579. Initializes a new instance of the <see cref="T:NAnt.Compression.Types.ZipFileSetEnumerator"/> class
  580. with the specified <see cref="T:NAnt.Compression.Types.ZipFileSetCollection"/>.
  581. </summary>
  582. <param name="ZipFileSets">The collection that should be enumerated.</param>
  583. </member>
  584. <member name="M:NAnt.Compression.Types.ZipFileSetEnumerator.MoveNext">
  585. <summary>
  586. Advances the enumerator to the next element of the collection.
  587. </summary>
  588. <returns>
  589. <see langword="true" /> if the enumerator was successfully advanced
  590. to the next element; <see langword="false" /> if the enumerator has
  591. passed the end of the collection.
  592. </returns>
  593. </member>
  594. <member name="M:NAnt.Compression.Types.ZipFileSetEnumerator.Reset">
  595. <summary>
  596. Sets the enumerator to its initial position, which is before the
  597. first element in the collection.
  598. </summary>
  599. </member>
  600. <member name="P:NAnt.Compression.Types.ZipFileSetEnumerator.Current">
  601. <summary>
  602. Gets the current element in the collection.
  603. </summary>
  604. <returns>
  605. The current element in the collection.
  606. </returns>
  607. </member>
  608. </members>
  609. </doc>