org.apache.tools.ant.taskdefs

Class Manifest.Attribute

java.lang.Object

org.apache.tools.ant.taskdefs.Manifest.Attribute

Enclosing class:

Manifest

public static class Manifest.Attribute
extends Object

An attribute for the manifest. Those attributes that are not nested into a section will be added to the "Main" section.

Constructor Summary

Constructors

Constructor and Description
Attribute() Construct an empty attribute
Attribute(String line) Construct an attribute by parsing a line from the Manifest
Attribute(String name, String value) Construct a manifest by specifying its name and value

Method Summary

Modifier and Type	Method and Description
void	addContinuation(String line) Add a continuation line from the Manifest file.
void	addValue(String value) Add a new value to this attribute - making it multivalued.
boolean	equals(Object rhs) Indicates whether some other object is "equal to" this one.
String	getKey() Get the attribute's Key - its name in lower case.
String	getName() Get the Attribute's name
String	getValue() Get the Attribute's value.
Enumeration<String>	getValues() Get all the attribute's values.
int	hashCode() Returns a hash code value for the object.
void	parse(String line) Parse a line into name and value pairs
void	setName(String name) Set the Attribute's name; required
void	setValue(String value) Set the Attribute's value; required
void	write(PrintWriter writer) Write the attribute out to a print writer without flattening multi-values attributes (i.e.
void	write(PrintWriter writer, boolean flatten) Write the attribute out to a print writer.

Methods inherited from class java.lang.Object

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

Constructor Detail

Attribute

public Attribute()

Construct an empty attribute

Attribute

public Attribute(String line)
          throws ManifestException

Construct an attribute by parsing a line from the Manifest

Parameters:

line - the line containing the attribute name and value

Throws:

ManifestException - if the line is not valid

Attribute

public Attribute(String name,
                 String value)

Construct a manifest by specifying its name and value

Parameters:

name - the attribute's name

value - the Attribute's value

Method Detail

addContinuation

public void addContinuation(String line)

Add a continuation line from the Manifest file. When lines are too long in a manifest, they are continued on the next line by starting with a space. This method adds the continuation data to the attribute value by skipping the first character.

Parameters:

line - the continuation line.

addValue

public void addValue(String value)

Add a new value to this attribute - making it multivalued.

Parameters:

value - the attribute's additional value

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 key and values are the same.

See Also:

Object.equals(java.lang.Object)

getKey

public String getKey()

Get the attribute's Key - its name in lower case.

Returns:

the attribute's key.

getName

public String getName()

Get the Attribute's name

Returns:

the attribute's name.

getValue

public String getValue()

Get the Attribute's value.

Returns:

the attribute's value.

getValues

public Enumeration<String> getValues()

Get all the attribute's values.

Returns:

an enumeration of the attributes values

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 key and values.

See Also:

Object.hashCode()

parse

public void parse(String line)
           throws ManifestException

Parse a line into name and value pairs

Parameters:

line - the line to be parsed

Throws:

ManifestException - if the line does not contain a colon separating the name and value

setName

public void setName(String name)

Set the Attribute's name; required

Parameters:

name - the attribute's name

setValue

public void setValue(String value)

Set the Attribute's value; required

Parameters:

value - the attribute's value

write

public void write(PrintWriter writer)
           throws IOException

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

Parameters:

writer - the Writer to which the attribute is written

Throws:

IOException - if the attribute value cannot be written

write

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

Write the attribute out to a print writer.

Parameters:

writer - the Writer to which the attribute is written

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

Throws:

IOException - if the attribute value cannot be written

Since:

Ant 1.8.0