org.apache.tools.ant.taskdefs

Class ManifestTask

public class ManifestTask extends Task

Creates a manifest file for inclusion in a JAR, Ant task wrapper around {@link Manifest Manifest}. This task can be used to write a Manifest file, optionally replacing or updating an existing file.

Since: Ant 1.5

UNKNOWN: category="java"

Nested Class Summary
static classManifestTask.Mode
Helper class for Manifest's mode attribute.
Constructor Summary
ManifestTask()
Default constructor
Method Summary
voidaddConfiguredAttribute(Manifest.Attribute attribute)
Add an attribute to the manifest - it is added to the main section.
voidaddConfiguredSection(Manifest.Section section)
Add a section to the manifest
voidexecute()
Create or update the Manifest when used as a task.
voidsetEncoding(String encoding)
The encoding to use for reading in an existing manifest file
voidsetFile(File f)
The name of the manifest file to create/update.
voidsetMode(ManifestTask.Mode m)
Update policy: either "update" or "replace"; default is "replace".

Constructor Detail

ManifestTask

public ManifestTask()
Default constructor

Method Detail

addConfiguredAttribute

public void addConfiguredAttribute(Manifest.Attribute attribute)
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)
Add a section to the manifest

Parameters: section the manifest section to be added

Throws: ManifestException if the section is not valid.

execute

public void execute()
Create or update the Manifest when used as a task.

Throws: BuildException if the manifest cannot be written.

setEncoding

public void setEncoding(String encoding)
The encoding to use for reading in an existing manifest file

Parameters: encoding the manifest file encoding.

setFile

public void setFile(File f)
The name of the manifest file to create/update. Required if used as a task.

Parameters: f the Manifest file to be written

setMode

public void setMode(ManifestTask.Mode m)
Update policy: either "update" or "replace"; default is "replace".

Parameters: m the mode value - update or replace.