Class IvyTask

java.lang.Object

org.apache.tools.ant.ProjectComponent

org.apache.tools.ant.Task

org.apache.ivy.ant.IvyTask

All Implemented Interfaces:

Cloneable

Direct Known Subclasses:

ConvertManifestTask, IvyBuildList, IvyBuildNumber, IvyCheck, IvyCleanCache, IvyConvertPom, IvyDeliver, IvyFindRevision, IvyInfo, IvyInstall, IvyListModules, IvyMakePom, IvyPostResolveTask, IvyPublish, IvyReport, IvyRepositoryReport, IvyResolve, IvyVar

public abstract class IvyTask
extends org.apache.tools.ant.Task

Base class for all ivy ant tasks, deal particularly with ivy instance storage in ant project.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ANT_PROJECT_CONTEXT_KEY

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

Constructors

Constructor	Description
IvyTask()

Method Summary

Modifier and Type	Method	Description
protected void	cacheAttributeNotSupported()	Informs the user that the cache attribute is not supported any more.
abstract void	doExecute()	The real logic of task execution after project has been set in the context.
protected boolean	doValidate(IvySettings ivy)
final void	execute()	Ant task execute.
protected void	finalizeTask()	Called when task is about to finish Should clean up all state related information (stacks for example)
protected Ivy	getIvyInstance()
protected String	getProperty(String value, IvySettings ivy, String name)
protected String	getProperty(String value, IvySettings ivy, String name, String resolveId)
protected String	getProperty(IvySettings ivy, String name)
protected String	getProperty(IvySettings ivy, String name, String resolveId)
protected static Date	getPubDate(String date, Date def)
protected String[]	getResolvedConfigurations(String org, String module, boolean strict)
protected <T> T	getResolvedDescriptor(String resolveId)
protected <T> T	getResolvedDescriptor(String resolveId, boolean strict)
protected <T> T	getResolvedDescriptor(String org, String module)
protected <T> T	getResolvedDescriptor(String org, String module, boolean strict)
protected ResolveReport	getResolvedReport(String org, String module, String resolveId)
protected IvySettings	getSettings()
org.apache.tools.ant.types.Reference	getSettingsRef()
boolean	isValidate()
protected String	mergeConfs(String[] conf)
protected void	prepareTask()	Called when task starts its execution.
protected void	setResolved(ResolveReport report, boolean keep)
protected void	setResolved(ResolveReport report, String resolveId, boolean keep)
void	setSettingsRef(org.apache.tools.ant.types.Reference ref)
void	setValidate(boolean validate)
protected String[]	splitConfs(String conf)
String	toString()

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

Methods inherited from class Object

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

Field Details

ANT_PROJECT_CONTEXT_KEY

public static final String ANT_PROJECT_CONTEXT_KEY

See Also:

• Constant Field Values

Constructor Details

IvyTask

public IvyTask()

Method Details

doValidate

protected boolean doValidate(IvySettings ivy)

isValidate

public boolean isValidate()

setValidate

public void setValidate(boolean validate)

setSettingsRef

public void setSettingsRef(org.apache.tools.ant.types.Reference ref)

getSettingsRef

public org.apache.tools.ant.types.Reference getSettingsRef()

getSettings

protected IvySettings getSettings()

getIvyInstance

protected Ivy getIvyInstance()

setResolved

protected void setResolved(ResolveReport report,
 boolean keep)

setResolved

protected void setResolved(ResolveReport report,
 String resolveId,
 boolean keep)

getResolvedConfigurations

protected String[] getResolvedConfigurations(String org,
 String module,
 boolean strict)

getResolvedDescriptor

protected <T> T getResolvedDescriptor(String resolveId)

getResolvedDescriptor

protected <T> T getResolvedDescriptor(String resolveId,
 boolean strict)

getResolvedDescriptor

protected <T> T getResolvedDescriptor(String org,
 String module)

getResolvedDescriptor

protected <T> T getResolvedDescriptor(String org,
 String module,
 boolean strict)

getResolvedReport

protected ResolveReport getResolvedReport(String org,
 String module,
 String resolveId)

splitConfs

protected String[] splitConfs(String conf)

mergeConfs

protected String mergeConfs(String[] conf)

getPubDate

protected static Date getPubDate(String date,
 Date def)

getProperty

protected String getProperty(String value,
 IvySettings ivy,
 String name)

getProperty

protected String getProperty(String value,
 IvySettings ivy,
 String name,
 String resolveId)

getProperty

protected String getProperty(IvySettings ivy,
 String name,
 String resolveId)

getProperty

protected String getProperty(IvySettings ivy,
 String name)

prepareTask

protected void prepareTask()

Called when task starts its execution.

finalizeTask

protected void finalizeTask()

Called when task is about to finish Should clean up all state related information (stacks for example)

execute

public final void execute()
                   throws org.apache.tools.ant.BuildException

Ant task execute. Calls prepareTask, doExecute, finalizeTask

Overrides:

execute in class org.apache.tools.ant.Task

Throws:

org.apache.tools.ant.BuildException

doExecute

public abstract void doExecute()
                        throws org.apache.tools.ant.BuildException

The real logic of task execution after project has been set in the context. MUST be implemented by subclasses

Throws:

org.apache.tools.ant.BuildException - if something goes wrong

toString

public String toString()

Overrides:

toString in class Object

cacheAttributeNotSupported

protected void cacheAttributeNotSupported()

Informs the user that the cache attribute is not supported any more.