org.objectweb.easybeans.ant.archive
Class AbsArchive

java.lang.Object
  extended by org.apache.tools.ant.ProjectComponent
      extended by org.apache.tools.ant.Task
          extended by org.objectweb.easybeans.ant.archive.AbsArchive
All Implemented Interfaces:
java.lang.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
private  java.io.File deploymentDescriptor
          Reference to the standard deployment descriptor.
private  java.io.File dest
          Full path to the archive.
private  boolean exploded
          Exploded mode or not ? (default = file).
private  java.util.List<org.apache.tools.ant.types.FileSet> fileSetList
          List of fileset used to add files.
private  java.lang.String name
          Relative Name of the archive (when embedded).
 
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.
 java.io.File getDest()
          Gets the path to the archive that will be built.
 java.util.List<org.apache.tools.ant.types.FileSet> getFileSetList()
          Gets the list of fileset to include in the archive.
 java.lang.String getName()
          Gets the relative Name of the archive (when embedded).
 boolean isExploded()
          Gets the state : exploded mode or not ?
 void setDD(java.io.File dd)
          Sets the reference to the deployment descriptor.
 void setDest(java.io.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 setName(java.lang.String name)
          Sets the relative Name of the archive (when embedded).
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
 

Field Detail

deploymentDescriptor

private java.io.File deploymentDescriptor
Reference to the standard deployment descriptor.


dest

private java.io.File dest
Full path to the archive.


name

private java.lang.String name
Relative Name of the archive (when embedded).


exploded

private boolean exploded
Exploded mode or not ? (default = file).


fileSetList

private java.util.List<org.apache.tools.ant.types.FileSet> fileSetList
List of fileset used to add files.

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 java.util.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(java.io.File dd)
Sets the reference to the deployment descriptor.

Parameters:
dd - the given deployment descriptor.

setDest

public void setDest(java.io.File dest)
Sets the path to the archive that will be built.

Parameters:
dest - the reference to resulting archive path.

getDest

public java.io.File getDest()
Gets the path to the archive that will be built.

Returns:
the reference to resulting archive path.

setName

public void setName(java.lang.String name)
Sets the relative Name of the archive (when embedded).

Parameters:
name - the relative Name of the archive.

getName

public java.lang.String getName()
Gets the relative Name of the archive (when embedded).

Returns:
the relative Name of the archive.

updateArchiveInfo

protected void updateArchiveInfo(ArchiveInfo archiveInfo)
Update the given archive info object with some attributes.

Parameters:
archiveInfo - the object to update