Package org.apache.ivy.core.retrieve
Class RetrieveOptions
java.lang.Object
org.apache.ivy.core.LogOptions
org.apache.ivy.core.retrieve.RetrieveOptions
A set of options used during retrieve related tasks
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionThe filter to apply before retrieving artifacts.private String[]
The names of configurations to retrieve.private String
The pattern to which artifacts should be retrieved.private String
The pattern to which ivy files should be retrieved.private boolean
True if symbolic links should be created instead of plain copy.private boolean
Deprecated.private FileNameMapper
private String
static final String
static final String
static final String
static final String
private String
The id used to store the resolve information.private boolean
True if a synchronisation of the destination directory should be done, false if a simple copy is enough.private boolean
True if the original files should be used instead of their cache copy.Fields inherited from class org.apache.ivy.core.LogOptions
LOG_DEFAULT, LOG_DOWNLOAD_ONLY, LOG_QUIET
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionString[]
getConfs()
boolean
boolean
Deprecated.Starting 2.5, creating symlinks in mass is no longer supported and this method will always return falseboolean
isSync()
boolean
setArtifactFilter
(Filter<Artifact> artifactFilter) setDestArtifactPattern
(String destArtifactPattern) setDestIvyPattern
(String destIvyPattern) setMakeSymlinks
(boolean makeSymlinks) setMakeSymlinksInMass
(boolean makeSymlinksInMass) Deprecated.Starting 2.5, creating symlinks in mass is no longer supported and this method plays no role in creation of symlinks.setMapper
(FileNameMapper mapper) setOverwriteMode
(String overwriteMode) setResolveId
(String resolveId) setSync
(boolean sync) setUseOrigin
(boolean useOrigin) Methods inherited from class org.apache.ivy.core.LogOptions
getLog, setLog
-
Field Details
-
OVERWRITEMODE_NEVER
- See Also:
-
OVERWRITEMODE_ALWAYS
- See Also:
-
OVERWRITEMODE_NEWER
- See Also:
-
OVERWRITEMODE_DIFFERENT
- See Also:
-
confs
The names of configurations to retrieve. If the array consists only of '*', then all configurations of the module will be retrieved. -
destIvyPattern
The pattern to which ivy files should be retrieved. If destIvyPattern is null no ivy files will be copied. -
destArtifactPattern
The pattern to which artifacts should be retrieved. -
artifactFilter
The filter to apply before retrieving artifacts. -
sync
private boolean syncTrue if a synchronisation of the destination directory should be done, false if a simple copy is enough. Synchronisation means that after the retrieve only files which have been retrieved will be present in the destination directory, which means that some files may be deleted. -
overwriteMode
-
useOrigin
private boolean useOriginTrue if the original files should be used instead of their cache copy. -
makeSymlinks
private boolean makeSymlinksTrue if symbolic links should be created instead of plain copy. Works only on OS supporting symbolic links. -
makeSymlinksInMass
Deprecated. -
resolveId
The id used to store the resolve information. -
mapper
-
-
Constructor Details
-
RetrieveOptions
public RetrieveOptions() -
RetrieveOptions
-
-
Method Details
-
getDestArtifactPattern
-
setDestArtifactPattern
-
getArtifactFilter
-
setArtifactFilter
-
getConfs
-
setConfs
-
getOverwriteMode
-
setOverwriteMode
-
getDestIvyPattern
-
setDestIvyPattern
-
isMakeSymlinks
public boolean isMakeSymlinks() -
isMakeSymlinksInMass
Deprecated.Starting 2.5, creating symlinks in mass is no longer supported and this method will always return false- Returns:
- false
-
setMakeSymlinks
-
setMakeSymlinksInMass
Deprecated.Starting 2.5, creating symlinks in mass is no longer supported and this method plays no role in creation of symlinks. UsesetMakeSymlinks(boolean)
instead- Parameters:
makeSymlinksInMass
- ditto- Returns:
- RetrieveOptions
-
isSync
public boolean isSync() -
setSync
-
isUseOrigin
public boolean isUseOrigin() -
setUseOrigin
-
getResolveId
-
setResolveId
-
getMapper
-
setMapper
-