org.ow2.util.ant.archive
Class AbsArchive

java.lang.Object
  org.apache.tools.ant.ProjectComponent
      org.apache.tools.ant.Task
          org.ow2.util.ant.archive.AbsArchive

All Implemented Interfaces:

Cloneable

Direct Known Subclasses:

Client, Ear, Ejb, War

public class AbsArchive
extends org.apache.tools.ant.Task

Common task that creates archives.

Author:

Florent Benoit

Field Summary

Fields inherited from class org.apache.tools.ant.Task

target, taskName, taskType, wrapper

Fields inherited from class org.apache.tools.ant.ProjectComponent

description, location, project

Constructor Summary

AbsArchive()
Default constructor.

Method Summary

void	addFileSet(org.apache.tools.ant.types.ZipFileSet zipFileSet) Add the given fileset to the list of existing fileset.
File	getDest() Gets the path to the archive that will be built.
List<org.apache.tools.ant.types.FileSet>	getFileSetList() Gets the list of fileset to include in the archive.
File	getManifest() Gets the reference to the manifest.
String	getName() Gets the relative Name of the archive (when embedded).
boolean	isExploded() Gets the state : exploded mode or not ?
void	setDD(File dd) Sets the reference to the deployment descriptor.
void	setDest(File dest) Sets the path to the archive that will be built.
void	setExploded(boolean exploded) Sets the exploded mode to true or false.
void	setManifest(File manifest) Sets the reference to the manifest.
void	setName(String name) Sets the relative Name of the archive (when embedded).
void	setSpecificDD(File dd) Sets the reference to the specific deployment descriptor.
protected void	updateArchiveInfo(ArchiveInfo archiveInfo) Update the given archive info object with some attributes.

Methods inherited from class org.apache.tools.ant.Task

bindToOwner, execute, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType

Methods inherited from class org.apache.tools.ant.ProjectComponent

clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbsArchive

public AbsArchive()

Default constructor.

Method Detail

addFileSet

public void addFileSet(org.apache.tools.ant.types.ZipFileSet zipFileSet)

Add the given fileset to the list of existing fileset.

Parameters:

zipFileSet - the fileset to add.

getFileSetList

public List<org.apache.tools.ant.types.FileSet> getFileSetList()

Gets the list of fileset to include in the archive.

Returns:

the list of fileset to include in the archive.

setExploded

public void setExploded(boolean exploded)

Sets the exploded mode to true or false.

Parameters:

exploded - boolean true/false

isExploded

public boolean isExploded()

Gets the state : exploded mode or not ?

Returns:

the state : exploded mode or not ?

setDD

public void setDD(File dd)

Sets the reference to the deployment descriptor.

Parameters:

dd - the given deployment descriptor.

setSpecificDD

public void setSpecificDD(File dd)

Sets the reference to the specific deployment descriptor.

Parameters:

dd - the given specific deployment descriptor.

setDest

public void setDest(File dest)

Sets the path to the archive that will be built.

Parameters:

dest - the reference to resulting archive path.

getDest

public File getDest()

Gets the path to the archive that will be built.

Returns:

the reference to resulting archive path.

setName

public void setName(String name)

Sets the relative Name of the archive (when embedded).

Parameters:

name - the relative Name of the archive.

getName

public String getName()

Gets the relative Name of the archive (when embedded).

Returns:

the relative Name of the archive.

getManifest

public File getManifest()

Gets the reference to the manifest.

Returns:

the reference to the manifest.

setManifest

public void setManifest(File manifest)

Sets the reference to the manifest.

Parameters:

manifest - the reference to the manifest.

updateArchiveInfo

protected void updateArchiveInfo(ArchiveInfo archiveInfo)

Update the given archive info object with some attributes.

Parameters:

archiveInfo - the object to update