Manifest
public class Manifest
extends Object
implements Cloneable
java.lang.Object | |
↳ | java.util.jar.Manifest |
The Manifest class is used to maintain Manifest entry names and their associated Attributes. There are main Manifest Attributes as well as per-entry Attributes. For information on the Manifest format, please see the Manifest format specification.
See also:
Summary
Public constructors | |
---|---|
Manifest() Constructs a new, empty Manifest. | |
Manifest(InputStream is) Constructs a new Manifest from the specified input stream. | |
Manifest(Manifest man) Constructs a new Manifest that is a copy of the specified Manifest. |
Public methods | |
---|---|
void | clear() Clears the main Attributes as well as the entries in this Manifest. |
Object | clone() Returns a shallow copy of this Manifest. |
boolean | equals(Object o) Returns true if the specified Object is also a Manifest and has the same main Attributes and entries. |
Attributes | getAttributes(String name) Returns the Attributes for the specified entry name. |
Map<String, Attributes> | getEntries() Returns a Map of the entries contained in this Manifest. |
Attributes | getMainAttributes() Returns the main Attributes for the Manifest. |
int | hashCode() Returns the hash code for this Manifest. |
void | read(InputStream is) Reads the Manifest from the specified InputStream. |
void | write(OutputStream out) Writes the Manifest to the specified OutputStream. |
Inherited methods | |
---|---|
Public constructors
Manifest
public Manifest (InputStream is)
Constructs a new Manifest from the specified input stream.
Parameters | |
---|---|
is | InputStream : the input stream containing manifest data |
Throws | |
---|---|
IOException | if an I/O error has occurred |
Manifest
public Manifest (Manifest man)
Constructs a new Manifest that is a copy of the specified Manifest.
Parameters | |
---|---|
man | Manifest : the Manifest to copy |
Public methods
clear
public void clear ()
Clears the main Attributes as well as the entries in this Manifest.
clone
public Object clone ()
Returns a shallow copy of this Manifest. The shallow copy is implemented as follows:
public Object clone() { return new Manifest(this); }
Returns | |
---|---|
Object | a shallow copy of this Manifest |
equals
public boolean equals (Object o)
Returns true if the specified Object is also a Manifest and has the same main Attributes and entries.
Parameters | |
---|---|
o | Object : the object to be compared |
Returns | |
---|---|
boolean | true if the specified Object is also a Manifest and has the same main Attributes and entries |
getAttributes
public Attributes getAttributes (String name)
Returns the Attributes for the specified entry name. This method is defined as:
return (Attributes)getEntries().get(name)
null
is a valid name
, when getAttributes(null)
is invoked on a Manifest
obtained from a jar file, null
will be returned. While jar files themselves do not allow null
-named attributes, it is possible to invoke getEntries()
on a Manifest
, and on that result, invoke put
with a null key and an arbitrary value. Subsequent invocations of getAttributes(null)
will return the just-put
value. Note that this method does not return the manifest's main attributes; see getMainAttributes()
.
Parameters | |
---|---|
name | String : entry name |
Returns | |
---|---|
Attributes | the Attributes for the specified entry name |
getEntries
public Map<String, Attributes> getEntries ()
Returns a Map of the entries contained in this Manifest. Each entry is represented by a String name (key) and associated Attributes (value). The Map permits the null
key, but no entry with a null key is created by read(InputStream)
, nor is such an entry written by using write(OutputStream)
.
Returns | |
---|---|
Map<String, Attributes> | a Map of the entries contained in this Manifest |
getMainAttributes
public Attributes getMainAttributes ()
Returns the main Attributes for the Manifest.
Returns | |
---|---|
Attributes | the main Attributes for the Manifest |
hashCode
public int hashCode ()
Returns the hash code for this Manifest.
Returns | |
---|---|
int | a hash code value for this object. |
read
public void read (InputStream is)
Reads the Manifest from the specified InputStream. The entry names and attributes read will be merged in with the current manifest entries.
Parameters | |
---|---|
is | InputStream : the input stream |
Throws | |
---|---|
IOException | if an I/O error has occurred |
write
public void write (OutputStream out)
Writes the Manifest to the specified OutputStream. Attributes.Name.MANIFEST_VERSION must be set in MainAttributes prior to invoking this method.
Parameters | |
---|---|
out | OutputStream : the output stream |
Throws | |
---|---|
IOException | if an I/O error has occurred |
See also: