org.apache.tools.ant.taskdefs

Class Manifest.Section

Enclosing Class:
Manifest

public static class Manifest.Section
extends java.lang.Object

A manifest section - you can nest attribute elements into sections. A section consists of a set of attribute values, separated from other sections by a blank line.

Method Summary

String
addAttributeAndCheck(Manifest.Attribute attribute)
Add an attribute to the section
void
addConfiguredAttribute(Manifest.Attribute attribute)
Add an attribute to the section.
Object
clone()
Clone this section
boolean
equals(Object rhs)
Manifest.Attribute
getAttribute(String attributeName)
Get a attribute of the section
Enumeration
getAttributeKeys()
Get the attribute keys.
String
getAttributeValue(String attributeName)
Get the value of the attribute with the name given.
String
getName()
Get the Section's name.
Enumeration
getWarnings()
Get the warnings for this section.
int
hashCode()
void
merge(Manifest.Section section)
Merge in another section
String
read(BufferedReader reader)
Read a section through a reader.
void
removeAttribute(String attributeName)
Remove tge given attribute from the section
void
setName(String name)
The name of the section; optional -default is the main section.
void
write(PrintWriter writer)
Write the section out to a print writer.

Method Details

addAttributeAndCheck

public String addAttributeAndCheck(Manifest.Attribute attribute)
            throws ManifestException
Add an attribute to the section
Parameters:
attribute - the attribute to be added.
Returns:
the value of the attribute if it is a name attribute - null other wise
Throws:
ManifestException - if the attribute already exists in this section.

addConfiguredAttribute

public void addConfiguredAttribute(Manifest.Attribute attribute)
            throws ManifestException
Add an attribute to the section.
Parameters:
attribute - the attribute to be added to the section
Throws:
ManifestException - if the attribute is not valid.

clone

public Object clone()
Clone this section
Returns:
the cloned Section
Since:
Ant 1.5.2

equals

public boolean equals(Object rhs)
See Also:
java.lang.Object.equals

getAttribute

public Manifest.Attribute getAttribute(String attributeName)
Get a attribute of the section
Parameters:
attributeName - the name of the attribute
Returns:
a Manifest.Attribute instance if the attribute is single-valued, otherwise a Vector of Manifest.Attribute instances.

getAttributeKeys

public Enumeration getAttributeKeys()
Get the attribute keys.
Returns:
an Enumeration of Strings, each string being the lower case key of an attribute of the section.

getAttributeValue

public String getAttributeValue(String attributeName)
Get the value of the attribute with the name given.
Parameters:
attributeName - the name of the attribute to be returned.
Returns:
the attribute's value or null if the attribute does not exist in the section

getName

public String getName()
Get the Section's name.
Returns:
the section's name.

getWarnings

public Enumeration getWarnings()
Get the warnings for this section.
Returns:
an Enumeration of warning strings.

hashCode

public int hashCode()
See Also:
java.lang.Object.hashCode

merge

public void merge(Manifest.Section section)
            throws ManifestException
Merge in another section
Parameters:
section - the section to be merged with this one.
Throws:
ManifestException - if the sections cannot be merged.

read

public String read(BufferedReader reader)
            throws ManifestException,
                   IOException
Read a section through a reader.
Parameters:
reader - the reader from which the section is read
Returns:
the name of the next section if it has been read as part of this section - This only happens if the Manifest is malformed.
Throws:
ManifestException - if the section is not valid according to the JAR spec

removeAttribute

public void removeAttribute(String attributeName)
Remove tge given attribute from the section
Parameters:
attributeName - the name of the attribute to be removed.

setName

public void setName(String name)
The name of the section; optional -default is the main section.
Parameters:
name - the section's name

write

public void write(PrintWriter writer)
            throws IOException
Write the section out to a print writer.
Parameters:
writer - the Writer to which the section is written

Copyright B) 2000-2006 Apache Software Foundation. All Rights Reserved.