org.gridgain.grid.tools.ant.gar
Class GridGarAntTask

java.lang.Object
  org.apache.tools.ant.ProjectComponent
      org.apache.tools.ant.Task
          org.apache.tools.ant.taskdefs.MatchingTask
              org.apache.tools.ant.taskdefs.Zip
                  org.gridgain.grid.tools.ant.gar.GridGarAntTask

All Implemented Interfaces:

Cloneable, org.apache.tools.ant.types.selectors.SelectorContainer

public class GridGarAntTask
extends org.apache.tools.ant.taskdefs.Zip

Ant task for generating GAR file. This task extends standard zip Ant task and has two parameters:

• basedir - Base directory for GAR archive.
• descrdir - Directory where descriptor GridGarAntTask.DESC_NAME file is located. If not specified, it is assumed that GridGain descriptor will be searched in base directory (see GridGarAntTask.setBasedir(File)). Note further that GAR descriptor file is fully optional itself for GAR archive.

Wiki & Forum:

Wiki
Forum

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.tools.ant.taskdefs.Zip

org.apache.tools.ant.taskdefs.Zip.ArchiveState, org.apache.tools.ant.taskdefs.Zip.Duplicate, org.apache.tools.ant.taskdefs.Zip.UnicodeExtraField, org.apache.tools.ant.taskdefs.Zip.WhenEmpty

Field Summary

static String

DESC_NAME GAR descriptor name.

Fields inherited from class org.apache.tools.ant.taskdefs.Zip

addedDirs, archiveType, doubleFilePass, duplicate, emptyBehavior, entries, skipWriting, zipFile

Fields inherited from class org.apache.tools.ant.taskdefs.MatchingTask

fileset

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

GridGarAntTask()
Creates ant task with default values.

Method Summary

void	execute() Executes the Ant task.
protected void	initZipOutputStream(org.apache.tools.zip.ZipOutputStream zOut)
void	setBasedir(File baseDir) Sets base directory for the archive.
void	setDescrdir(File descrDir) Sets the directory where descriptor is located.

Methods inherited from class org.apache.tools.ant.taskdefs.Zip

add, addFileset, addParentDirs, addResources, addResources, addZipfileset, addZipGroupFileset, cleanUp, createEmptyZip, executeMain, finalizeZipOutputStream, getComment, getCreateUnicodeExtraFields, getCurrentExtraFields, getDestFile, getEncoding, getFallBackToUTF8, getLevel, getNonFileSetResourcesToAdd, getPreserve0Permissions, getResourcesToAdd, getResourcesToAdd, getUseLanguageEnodingFlag, grabNonFileSetResources, grabResources, hasUpdatedFile, isAddingNewFiles, isCompress, isEmpty, isFirstPass, isInUpdateMode, logWhenWriting, reset, selectDirectoryResources, selectFileResources, selectResources, setComment, setCompress, setCreateUnicodeExtraFields, setCurrentExtraFields, setDestFile, setDuplicate, setEncoding, setFallBackToUTF8, setFile, setFilesonly, setKeepCompression, setLevel, setPreserve0Permissions, setRoundUp, setUpdate, setUseLanguageEncodingFlag, setWhenempty, setZipfile, zipDir, zipDir, zipDir, zipFile, zipFile, zipFile

Methods inherited from class org.apache.tools.ant.taskdefs.MatchingTask

add, addAnd, addContains, addContainsRegexp, addCustom, addDate, addDepend, addDepth, addDifferent, addFilename, addMajority, addModified, addNone, addNot, addOr, addPresent, addSelector, addSize, addType, appendSelector, createExclude, createExcludesFile, createInclude, createIncludesFile, createPatternSet, getDirectoryScanner, getImplicitFileSet, getSelectors, hasSelectors, selectorCount, selectorElements, setCaseSensitive, setDefaultexcludes, setExcludes, setExcludesfile, setFollowSymlinks, setIncludes, setIncludesfile, setProject, XsetIgnore, XsetItems

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

bindToOwner, 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

Methods inherited from class java.lang.Object

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

Field Detail

DESC_NAME

public static final String DESC_NAME

GAR descriptor name. Its value is gridgain.xml.

See Also:

Constant Field Values

Constructor Detail

GridGarAntTask

public GridGarAntTask()

Creates ant task with default values.

Method Detail

setDescrdir

public void setDescrdir(File descrDir)

Sets the directory where descriptor is located. This parameter is optional and if not set Ant task will search for descriptor file in base directory. Note further that GAR descriptor file is fully optional itself for GAR archive.

Parameters:

descrDir - Descriptor directory.

setBasedir

public void setBasedir(File baseDir)

Sets base directory for the archive.

Overrides:

setBasedir in class org.apache.tools.ant.taskdefs.Zip

Parameters:

baseDir - Base archive directory to set.

execute

public void execute()

Executes the Ant task.

Overrides:

execute in class org.apache.tools.ant.taskdefs.Zip

initZipOutputStream

protected void initZipOutputStream(org.apache.tools.zip.ZipOutputStream zOut)
                            throws IOException

Overrides:

initZipOutputStream in class org.apache.tools.ant.taskdefs.Zip

Throws:

IOException