org.apache.tools.ant.taskdefs

Class Manifest

java.lang.Object

org.apache.tools.ant.taskdefs.Manifest

public class Manifest
extends Object

Holds the data of a jar manifest. Manifests are processed according to the Jar file specification.. Specifically, a manifest element consists of a set of attributes and sections. These sections in turn may contain attributes. Note in particular that this may result in manifest lines greater than 72 bytes being wrapped and continued on the next line. If an application can not handle the continuation mechanism, it is a defect in the application, not this task.

Since:

Ant 1.4

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Manifest.Attribute An attribute for the manifest.
static class	Manifest.Section A manifest section - you can nest attribute elements into sections.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ATTRIBUTE_CLASSPATH The Class-Path Header is special - it can be duplicated
static String	ATTRIBUTE_FROM The From Header is disallowed in a Manifest
static String	ATTRIBUTE_MANIFEST_VERSION The standard manifest version header
static String	ATTRIBUTE_NAME The Name Attribute is the first in a named section
static String	ATTRIBUTE_SIGNATURE_VERSION The standard Signature Version header
static String	DEFAULT_MANIFEST_VERSION Default Manifest version if one is not specified
static String	EOL The End-Of-Line marker in manifests
static String	ERROR_FROM_FORBIDDEN Error for attributes
static String	JAR_ENCODING Encoding to be used for JAR files.
static int	MAX_LINE_LENGTH The max length of a line in a Manifest
static int	MAX_SECTION_LENGTH Max length of a line section which is continued.

Constructor Summary

Constructors

Constructor and Description
Manifest() Construct an empty manifest
Manifest(Reader r) Read a manifest file from the given reader

Method Summary

Modifier and Type	Method and Description
void	addConfiguredAttribute(Manifest.Attribute attribute) Add an attribute to the manifest - it is added to the main section.
void	addConfiguredSection(Manifest.Section section) Add a section to the manifest
boolean	equals(Object rhs) Indicates whether some other object is "equal to" this one.
static Manifest	getDefaultManifest() Construct a manifest from Ant's default manifest file.
Manifest.Section	getMainSection() Get the main section of the manifest
String	getManifestVersion() Get the version of the manifest
Manifest.Section	getSection(String name) Get a particular section from the manifest
Enumeration<String>	getSectionNames() Get the section names in this manifest.
Enumeration<String>	getWarnings() Get the warnings for this manifest.
int	hashCode() Returns a hash code value for the object.
void	merge(Manifest other) Merge the contents of the given manifest into this manifest without merging Class-Path attributes.
void	merge(Manifest other, boolean overwriteMain) Merge the contents of the given manifest into this manifest without merging Class-Path attributes.
void	merge(Manifest other, boolean overwriteMain, boolean mergeClassPaths) Merge the contents of the given manifest into this manifest
String	toString() Convert the manifest to its string representation
void	write(PrintWriter writer) Write the manifest out to a print writer without flattening multi-values attributes (i.e.
void	write(PrintWriter writer, boolean flatten) Write the manifest out to a print writer.

Methods inherited from class java.lang.Object

clone, getClass, notify, notifyAll, wait, wait, wait

Field Detail

ATTRIBUTE_CLASSPATH

public static final String ATTRIBUTE_CLASSPATH

The Class-Path Header is special - it can be duplicated

See Also:

Constant Field Values

ATTRIBUTE_FROM

public static final String ATTRIBUTE_FROM

The From Header is disallowed in a Manifest

See Also:

Constant Field Values

ATTRIBUTE_MANIFEST_VERSION

public static final String ATTRIBUTE_MANIFEST_VERSION

The standard manifest version header

See Also:

Constant Field Values

ATTRIBUTE_NAME

public static final String ATTRIBUTE_NAME

The Name Attribute is the first in a named section

See Also:

Constant Field Values

ATTRIBUTE_SIGNATURE_VERSION

public static final String ATTRIBUTE_SIGNATURE_VERSION

The standard Signature Version header

See Also:

Constant Field Values

DEFAULT_MANIFEST_VERSION

public static final String DEFAULT_MANIFEST_VERSION

Default Manifest version if one is not specified

See Also:

Constant Field Values

EOL

public static final String EOL

The End-Of-Line marker in manifests

See Also:

Constant Field Values

ERROR_FROM_FORBIDDEN

public static final String ERROR_FROM_FORBIDDEN

Error for attributes

See Also:

Constant Field Values

JAR_ENCODING

public static final String JAR_ENCODING

Encoding to be used for JAR files.

See Also:

Constant Field Values

MAX_LINE_LENGTH

public static final int MAX_LINE_LENGTH

The max length of a line in a Manifest

See Also:

Constant Field Values

MAX_SECTION_LENGTH

public static final int MAX_SECTION_LENGTH

Max length of a line section which is continued. Need to allow for the CRLF.

See Also:

Constant Field Values

Constructor Detail

Manifest

public Manifest()

Construct an empty manifest

Manifest

public Manifest(Reader r)
         throws ManifestException,
                IOException

Read a manifest file from the given reader

Parameters:

r - is the reader from which the Manifest is read

Throws:

ManifestException - if the manifest is not valid according to the JAR spec

IOException - if the manifest cannot be read from the reader.

Method Detail

addConfiguredAttribute

public void addConfiguredAttribute(Manifest.Attribute attribute)
                            throws ManifestException

Add an attribute to the manifest - it is added to the main section.

Parameters:

attribute - the attribute to be added.

Throws:

ManifestException - if the attribute is not valid.

addConfiguredSection

public void addConfiguredSection(Manifest.Section section)
                          throws ManifestException

Add a section to the manifest

Parameters:

section - the manifest section to be added

Throws:

ManifestException - if the secti0on is not valid.

equals

public boolean equals(Object rhs)

Description copied from class: Object

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

• It is reflexive: for any non-null reference value x, x.equals(x) should return true.
• It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
• It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
• It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
• For any non-null reference value x, x.equals(null) should return false.

The equals method for class Object implements the most discriminating possible equivalence relation on objects; that is, for any non-null reference values x and y, this method returns true if and only if x and y refer to the same object (x == y has the value true).

Note that it is generally necessary to override the hashCode method whenever this method is overridden, so as to maintain the general contract for the hashCode method, which states that equal objects must have equal hash codes.

Overrides:

equals in class Object

Parameters:

rhs - the object to check for equality.

Returns:

true if the version, main and sections are the same.

See Also:

Object.equals(java.lang.Object)

getDefaultManifest

public static Manifest getDefaultManifest()
                                   throws BuildException

Construct a manifest from Ant's default manifest file.

Returns:

the default manifest.

Throws:

BuildException - if there is a problem loading the default manifest

getMainSection

public Manifest.Section getMainSection()

Get the main section of the manifest

Returns:

the main section of the manifest

getManifestVersion

public String getManifestVersion()

Get the version of the manifest

Returns:

the manifest's version string

getSection

public Manifest.Section getSection(String name)

Get a particular section from the manifest

Parameters:

name - the name of the section desired.

Returns:

the specified section or null if that section does not exist in the manifest

getSectionNames

public Enumeration<String> getSectionNames()

Get the section names in this manifest.

Returns:

an Enumeration of section names

getWarnings

public Enumeration<String> getWarnings()

Get the warnings for this manifest.

Returns:

an enumeration of warning strings

hashCode

public int hashCode()

Description copied from class: Object

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by HashMap.

The general contract of hashCode is:

• Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
• If two objects are equal according to the equals(Object) method, then calling the hashCode method on each of the two objects must produce the same integer result.
• It is not required that if two objects are unequal according to the Object.equals(java.lang.Object) method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

As much as is reasonably practical, the hashCode method defined by class Object does return distinct integers for distinct objects. (This is typically implemented by converting the internal address of the object into an integer, but this implementation technique is not required by the Java^TM programming language.)

Overrides:

hashCode in class Object

Returns:

a hashcode based on the version, main and sections.

See Also:

Object.hashCode()

merge

public void merge(Manifest other)
           throws ManifestException

Merge the contents of the given manifest into this manifest without merging Class-Path attributes.

Parameters:

other - the Manifest to be merged with this one.

Throws:

ManifestException - if there is a problem merging the manifest according to the Manifest spec.

merge

public void merge(Manifest other,
                  boolean overwriteMain)
           throws ManifestException

Merge the contents of the given manifest into this manifest without merging Class-Path attributes.

Parameters:

other - the Manifest to be merged with this one.

overwriteMain - whether to overwrite the main section of the current manifest

Throws:

ManifestException - if there is a problem merging the manifest according to the Manifest spec.

merge

public void merge(Manifest other,
                  boolean overwriteMain,
                  boolean mergeClassPaths)
           throws ManifestException

Merge the contents of the given manifest into this manifest

Parameters:

other - the Manifest to be merged with this one.

overwriteMain - whether to overwrite the main section of the current manifest

mergeClassPaths - whether Class-Path attributes should be merged.

Throws:

ManifestException - if there is a problem merging the manifest according to the Manifest spec.

Since:

Ant 1.8.0

toString

public String toString()

Convert the manifest to its string representation

Overrides:

toString in class Object

Returns:

a multiline string with the Manifest as it appears in a Manifest file.

write

public void write(PrintWriter writer)
           throws IOException

Write the manifest out to a print writer without flattening multi-values attributes (i.e. Class-Path).

Parameters:

writer - the Writer to which the manifest is written

Throws:

IOException - if the manifest cannot be written

write

public void write(PrintWriter writer,
                  boolean flatten)
           throws IOException

Write the manifest out to a print writer.

Parameters:

writer - the Writer to which the manifest is written

flatten - whether to collapse multi-valued attributes (i.e. potentially Class-Path) Class-Path into a single attribute.

Throws:

IOException - if the manifest cannot be written

Since:

Ant 1.8.0