Package org.apache.ivy.ant
Class IvyRetrieve
java.lang.Object
org.apache.tools.ant.ProjectComponent
org.apache.tools.ant.Task
org.apache.ivy.ant.IvyTask
org.apache.ivy.ant.IvyPostResolveTask
org.apache.ivy.ant.IvyRetrieve
- All Implemented Interfaces:
Cloneable
This task allow to retrieve dependencies from the cache to a local directory like a lib dir.
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate String
private org.apache.tools.ant.types.Mapper
private String
private static final Collection<String>
private String
private String
private String
private boolean
private boolean
private boolean
Fields inherited from class org.apache.ivy.ant.IvyTask
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 -
Method Summary
Modifier and TypeMethodDescriptionvoid
add
(org.apache.tools.ant.util.FileNameMapper fileNameMapper) Add a nested filenamemapper.void
addMapper
(org.apache.tools.ant.types.Mapper mapper) Add a mapper to convert the file names.void
The real logic of task execution after project has been set in the context.protected Collection<String>
private String
Returns the path of the file relative to the given base directory.getSetId()
boolean
isSync()
void
setIvypattern
(String ivypattern) void
setOverwriteMode
(String overwriteMode) void
void
setPattern
(String pattern) void
void
setSymlink
(boolean symlink) Option to create symlinks instead of copying.void
setSymlinkmass
(boolean symlinkmass) Deprecated.Starting 2.5, symlinking in mass isn't supportedvoid
setSync
(boolean sync) Methods inherited from class org.apache.ivy.ant.IvyPostResolveTask
createConflict, createDependency, createExclude, ensureResolved, getArtifactFilter, getBranch, getConf, getConfsToResolve, getConfsToResolve, getFile, getLog, getModule, getOrganisation, getResolvedModuleId, getResolvedMrid, getResolvedReport, getResolveId, getResolveMode, getRevision, getType, isChanging, isHaltonfailure, isInline, isKeep, isRefresh, isTransitive, isUseOrigin, prepareAndCheck, setBranch, setCache, setChanging, setConf, setFile, setHaltonfailure, setInline, setKeep, setLog, setModule, setOrganisation, setRefresh, setResolveId, setResolveMode, setRevision, setTransitive, setType, setupResolve, setUseOrigin
Methods inherited from class org.apache.ivy.ant.IvyTask
cacheAttributeNotSupported, doValidate, execute, finalizeTask, getIvyInstance, getProperty, getProperty, getProperty, getProperty, getPubDate, getResolvedConfigurations, getResolvedDescriptor, getResolvedDescriptor, getResolvedDescriptor, getResolvedDescriptor, getResolvedReport, getSettings, getSettingsRef, isValidate, mergeConfs, prepareTask, setResolved, setResolved, setSettingsRef, setValidate, splitConfs, 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
-
Field Details
-
OVERWRITEMODE_VALUES
-
pattern
-
ivypattern
-
sync
private boolean sync -
symlink
private boolean symlink -
symlinkmass
private boolean symlinkmass -
overwriteMode
-
pathId
-
setId
-
mapper
private org.apache.tools.ant.types.Mapper mapper
-
-
Constructor Details
-
IvyRetrieve
public IvyRetrieve()
-
-
Method Details
-
getPattern
-
setPattern
-
getPathId
-
setPathId
-
getSetId
-
setSetId
-
doExecute
public void doExecute() throws org.apache.tools.ant.BuildExceptionDescription copied from class:IvyTask
The real logic of task execution after project has been set in the context. MUST be implemented by subclasses -
getAllowedLogOptions
-
getIvypattern
-
setIvypattern
-
isSync
public boolean isSync() -
setSync
public void setSync(boolean sync) -
setSymlink
public void setSymlink(boolean symlink) Option to create symlinks instead of copying.- Parameters:
symlink
- boolean
-
setSymlinkmass
Deprecated.Starting 2.5, symlinking in mass isn't supportedOption to create symlinks in one mass action, instead of separately.- Parameters:
symlinkmass
- boolean
-
setOverwriteMode
-
getOverwriteMode
-
addMapper
public void addMapper(org.apache.tools.ant.types.Mapper mapper) Add a mapper to convert the file names.- Parameters:
mapper
- a Mapper value.
-
add
public void add(org.apache.tools.ant.util.FileNameMapper fileNameMapper) Add a nested filenamemapper.- Parameters:
fileNameMapper
- the mapper to add.
-
getPath
Returns the path of the file relative to the given base directory.- Parameters:
base
- the parent directory to which the file must be evaluated.file
- the file for which the path should be returned- Returns:
- the path of the file relative to the given base directory.
-