Improved build.xml
[vimdoclet.git] / sample / java.util.jar.JarFile.txt
blob215946028c2313383e65f43962abc0070969d1d9
1 *java.util.jar.JarFile* *JarFile* The JarFile class is used to read the contents
3 public class JarFile
4   extends    |java.util.zip.ZipFile|
6 |java.util.jar.JarFile_Description|
7 |java.util.jar.JarFile_Fields|
8 |java.util.jar.JarFile_Constructors|
9 |java.util.jar.JarFile_Methods|
11 ================================================================================
13 *java.util.jar.JarFile_Fields*
14 |java.lang.String_java.util.jar.JarFile.MANIFEST_NAME|
16 *java.util.jar.JarFile_Constructors*
17 |java.util.jar.JarFile(File)|Creates a new JarFile to read from the specified  
18 |java.util.jar.JarFile(File,boolean)|Creates a new JarFile to read from the spe
19 |java.util.jar.JarFile(File,boolean,int)|Creates a new JarFile to read from the
20 |java.util.jar.JarFile(String)|Creates a new JarFile to read from the specified
21 |java.util.jar.JarFile(String,boolean)|Creates a new JarFile to read from the s
23 *java.util.jar.JarFile_Methods*
24 |java.util.jar.JarFile.entries()|Returns an enumeration of the zip file entries
25 |java.util.jar.JarFile.getEntry(String)|Returns the ZipEntry for the given entr
26 |java.util.jar.JarFile.getInputStream(ZipEntry)|Returns an input stream for rea
27 |java.util.jar.JarFile.getJarEntry(String)|Returns the JarEntry for the given e
28 |java.util.jar.JarFile.getManifest()|Returns the jar file manifest, or null if 
30 *java.util.jar.JarFile_Description*
32 The JarFile class is used to read the contents of a jar file from any file that 
33 can be opened with java.io.RandomAccessFile. It extends the class 
34 java.util.zip.ZipFile with support for reading an optional Manifest entry. The 
35 Manifest can be used to specify meta-information about the jar file and its 
36 entries. 
38 Unless otherwise noted, passing a null argument to a constructor or method in 
39 this class will cause a (|java.lang.NullPointerException|) to be thrown. 
42 *java.lang.String_java.util.jar.JarFile.MANIFEST_NAME*
44 The JarFile class is used to read the contents of a jar file from any file that 
45 can be opened with java.io.RandomAccessFile. It extends the class 
46 java.util.zip.ZipFile with support for reading an optional Manifest entry. The 
47 Manifest can be used to specify meta-information about the jar file and its 
48 entries. 
50 Unless otherwise noted, passing a null argument to a constructor or method in 
51 this class will cause a (|java.lang.NullPointerException|) to be thrown. 
55 *java.util.jar.JarFile(File)*
57 public JarFile(java.io.File file)
58   throws |java.io.IOException|
59          
60 Creates a new JarFile to read from the specified File object. The JarFile will 
61 be verified if it is signed. 
63     file - the jar file to be opened for reading 
65 *java.util.jar.JarFile(File,boolean)*
67 public JarFile(
68   java.io.File file,
69   boolean verify)
70   throws |java.io.IOException|
71          
72 Creates a new JarFile to read from the specified File object. 
74     file - the jar file to be opened for reading 
75     verify - whether or not to verify the jar file if it is signed. 
77 *java.util.jar.JarFile(File,boolean,int)*
79 public JarFile(
80   java.io.File file,
81   boolean verify,
82   int mode)
83   throws |java.io.IOException|
84          
85 Creates a new JarFile to read from the specified File object in the specified 
86 mode. The mode argument must be either OPEN_READ or OPEN_READ | OPEN_DELETE. 
88     file - the jar file to be opened for reading 
89     verify - whether or not to verify the jar file if it is signed. 
90     mode - the mode in which the file is to be opened 
92 *java.util.jar.JarFile(String)*
94 public JarFile(java.lang.String name)
95   throws |java.io.IOException|
96          
97 Creates a new JarFile to read from the specified file name. The JarFile will be 
98 verified if it is signed. 
100     name - the name of the jar file to be opened for reading 
102 *java.util.jar.JarFile(String,boolean)*
104 public JarFile(
105   java.lang.String name,
106   boolean verify)
107   throws |java.io.IOException|
108          
109 Creates a new JarFile to read from the specified file name. 
111     name - the name of the jar file to be opened for reading 
112     verify - whether or not to verify the jar file if it is signed. 
114 *java.util.jar.JarFile.entries()*
116 public |java.util.Enumeration| entries()
118 Returns an enumeration of the zip file entries. 
121 *java.util.jar.JarFile.getEntry(String)*
123 public |java.util.zip.ZipEntry| getEntry(java.lang.String name)
125 Returns the ZipEntry for the given entry name or null if not found. 
127     name - the jar file entry name 
129     Returns: the ZipEntry for the given entry name or null if not found 
130 *java.util.jar.JarFile.getInputStream(ZipEntry)*
132 public synchronized |java.io.InputStream| getInputStream(java.util.zip.ZipEntry ze)
133   throws |java.io.IOException|
134          
135 Returns an input stream for reading the contents of the specified zip file 
136 entry. 
138     ze - the zip file entry 
140     Returns: an input stream for reading the contents of the specified zip file entry 
141 *java.util.jar.JarFile.getJarEntry(String)*
143 public |java.util.jar.JarEntry| getJarEntry(java.lang.String name)
145 Returns the JarEntry for the given entry name or null if not found. 
147     name - the jar file entry name 
149     Returns: the JarEntry for the given entry name or null if not found. 
150 *java.util.jar.JarFile.getManifest()*
152 public |java.util.jar.Manifest| getManifest()
153   throws |java.io.IOException|
154          
155 Returns the jar file manifest, or null if none. 
158     Returns: the jar file manifest, or null if none