fixed some formatting typos
[vimdoclet.git] / sample / java.util.zip.ZipEntry.txt
blob445c6f5c3aae313782d38f6c9d3cc1e9a0fa5419
1 *java.util.zip.ZipEntry* *ZipEntry* This class is used to represent a ZIP file e
3 public class ZipEntry
4   extends    |java.lang.Object|
5   implements |java.util.zip.ZipConstants|
6              |java.lang.Cloneable|
8 |java.util.zip.ZipEntry_Description|
9 |java.util.zip.ZipEntry_Fields|
10 |java.util.zip.ZipEntry_Constructors|
11 |java.util.zip.ZipEntry_Methods|
13 ================================================================================
15 *java.util.zip.ZipEntry_Fields*
16 |int_java.util.zip.ZipEntry.DEFLATED|
17 |int_java.util.zip.ZipEntry.STORED|
19 *java.util.zip.ZipEntry_Constructors*
20 |java.util.zip.ZipEntry(String)|Creates a new zip entry with the specified name
21 |java.util.zip.ZipEntry(ZipEntry)|Creates a new zip entry with fields taken fro
23 *java.util.zip.ZipEntry_Methods*
24 |java.util.zip.ZipEntry.clone()|Returns a copy of this entry.
25 |java.util.zip.ZipEntry.getComment()|Returns the comment string for the entry, 
26 |java.util.zip.ZipEntry.getCompressedSize()|Returns the size of the compressed 
27 |java.util.zip.ZipEntry.getCrc()|Returns the CRC-32 checksum of the uncompresse
28 |java.util.zip.ZipEntry.getExtra()|Returns the extra field data for the entry, 
29 |java.util.zip.ZipEntry.getMethod()|Returns the compression method of the entry
30 |java.util.zip.ZipEntry.getName()|Returns the name of the entry.
31 |java.util.zip.ZipEntry.getSize()|Returns the uncompressed size of the entry da
32 |java.util.zip.ZipEntry.getTime()|Returns the modification time of the entry, o
33 |java.util.zip.ZipEntry.hashCode()|Returns the hash code value for this entry.
34 |java.util.zip.ZipEntry.isDirectory()|Returns true if this is a directory entry
35 |java.util.zip.ZipEntry.setComment(String)|Sets the optional comment string for
36 |java.util.zip.ZipEntry.setCompressedSize(long)|Sets the size of the compressed
37 |java.util.zip.ZipEntry.setCrc(long)|Sets the CRC-32 checksum of the uncompress
38 |java.util.zip.ZipEntry.setExtra(byte[])|Sets the optional extra field data for
39 |java.util.zip.ZipEntry.setMethod(int)|Sets the compression method for the entr
40 |java.util.zip.ZipEntry.setSize(long)|Sets the uncompressed size of the entry d
41 |java.util.zip.ZipEntry.setTime(long)|Sets the modification time of the entry.
42 |java.util.zip.ZipEntry.toString()|Returns a string representation of the ZIP e
44 *java.util.zip.ZipEntry_Description*
46 This class is used to represent a ZIP file entry. 
50 *int_java.util.zip.ZipEntry.DEFLATED*
52 Compression method for compressed (deflated) entries. 
55 *int_java.util.zip.ZipEntry.STORED*
57 Compression method for uncompressed entries. 
61 *java.util.zip.ZipEntry(String)*
63 public ZipEntry(java.lang.String name)
65 Creates a new zip entry with the specified name. 
67     name - the entry name 
69 *java.util.zip.ZipEntry(ZipEntry)*
71 public ZipEntry(java.util.zip.ZipEntry e)
73 Creates a new zip entry with fields taken from the specified zip entry. 
75     e - a zip Entry object 
77 *java.util.zip.ZipEntry.clone()*
79 public |java.lang.Object| clone()
81 Returns a copy of this entry. 
85 *java.util.zip.ZipEntry.getComment()*
87 public |java.lang.String| getComment()
89 Returns the comment string for the entry, or null if none. 
93     Returns: the comment string for the entry, or null if none 
95 *java.util.zip.ZipEntry.getCompressedSize()*
97 public long getCompressedSize()
99 Returns the size of the compressed entry data, or -1 if not known. In the case 
100 of a stored entry, the compressed size will be the same as the uncompressed 
101 size of the entry. 
105     Returns: the size of the compressed entry data, or -1 if not known 
107 *java.util.zip.ZipEntry.getCrc()*
109 public long getCrc()
111 Returns the CRC-32 checksum of the uncompressed entry data, or -1 if not known. 
115     Returns: the CRC-32 checksum of the uncompressed entry data, or -1 if not known 
117 *java.util.zip.ZipEntry.getExtra()*
119 public byte[] getExtra()
121 Returns the extra field data for the entry, or null if none. 
125     Returns: the extra field data for the entry, or null if none 
127 *java.util.zip.ZipEntry.getMethod()*
129 public int getMethod()
131 Returns the compression method of the entry, or -1 if not specified. 
135     Returns: the compression method of the entry, or -1 if not specified 
137 *java.util.zip.ZipEntry.getName()*
139 public |java.lang.String| getName()
141 Returns the name of the entry. 
145     Returns: the name of the entry 
147 *java.util.zip.ZipEntry.getSize()*
149 public long getSize()
151 Returns the uncompressed size of the entry data, or -1 if not known. 
155     Returns: the uncompressed size of the entry data, or -1 if not known 
157 *java.util.zip.ZipEntry.getTime()*
159 public long getTime()
161 Returns the modification time of the entry, or -1 if not specified. 
165     Returns: the modification time of the entry, or -1 if not specified 
167 *java.util.zip.ZipEntry.hashCode()*
169 public int hashCode()
171 Returns the hash code value for this entry. 
175 *java.util.zip.ZipEntry.isDirectory()*
177 public boolean isDirectory()
179 Returns true if this is a directory entry. A directory entry is defined to be 
180 one whose name ends with a '/'. 
184     Returns: true if this is a directory entry 
186 *java.util.zip.ZipEntry.setComment(String)*
188 public void setComment(java.lang.String comment)
190 Sets the optional comment string for the entry. 
193     comment - the comment string 
195 *java.util.zip.ZipEntry.setCompressedSize(long)*
197 public void setCompressedSize(long csize)
199 Sets the size of the compressed entry data. 
202     csize - the compressed size to set to 
204 *java.util.zip.ZipEntry.setCrc(long)*
206 public void setCrc(long crc)
208 Sets the CRC-32 checksum of the uncompressed entry data. 
211     crc - the CRC-32 value 
213 *java.util.zip.ZipEntry.setExtra(byte[])*
215 public void setExtra(byte[] extra)
217 Sets the optional extra field data for the entry. 
220     extra - the extra field data bytes 
222 *java.util.zip.ZipEntry.setMethod(int)*
224 public void setMethod(int method)
226 Sets the compression method for the entry. 
229     method - the compression method, either STORED or DEFLATED 
231 *java.util.zip.ZipEntry.setSize(long)*
233 public void setSize(long size)
235 Sets the uncompressed size of the entry data. 
238     size - the uncompressed size in bytes 
240 *java.util.zip.ZipEntry.setTime(long)*
242 public void setTime(long time)
244 Sets the modification time of the entry. 
247     time - the entry modification time in number of milliseconds since the epoch 
249 *java.util.zip.ZipEntry.toString()*
251 public |java.lang.String| toString()
253 Returns a string representation of the ZIP entry.