Package org.apache.ivy.core.retrieve

Class RetrieveOptions

  • public class RetrieveOptions
extends LogOptions
    A set of options used during retrieve related tasks
    See Also:
    RetrieveEngine

    • Field Detail

      • OVERWRITEMODE_NEVER

        public static final java.lang.String OVERWRITEMODE_NEVER
        See Also:
        Constant Field Values

      • OVERWRITEMODE_ALWAYS

        public static final java.lang.String OVERWRITEMODE_ALWAYS
        See Also:
        Constant Field Values

      • OVERWRITEMODE_NEWER

        public static final java.lang.String OVERWRITEMODE_NEWER
        See Also:
        Constant Field Values

      • OVERWRITEMODE_DIFFERENT

        public static final java.lang.String OVERWRITEMODE_DIFFERENT
        See Also:
        Constant Field Values

      • confs

        private java.lang.String[] confs
        The names of configurations to retrieve. If the array consists only of '*', then all configurations of the module will be retrieved.

      • destIvyPattern

        private java.lang.String destIvyPattern
        The pattern to which ivy files should be retrieved. If destIvyPattern is null no ivy files will be copied.

      • destArtifactPattern

        private java.lang.String destArtifactPattern
        The pattern to which artifacts should be retrieved.

      • artifactFilter

        private Filter<Artifact> artifactFilter
        The filter to apply before retrieving artifacts.

      • sync

        private boolean sync
        True 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

        private java.lang.String overwriteMode

      • useOrigin

        private boolean useOrigin
        True if the original files should be used instead of their cache copy.

      • makeSymlinks

        private boolean makeSymlinks
        True if symbolic links should be created instead of plain copy. Works only on OS supporting symbolic links.

      • makeSymlinksInMass

        @Deprecated
private boolean makeSymlinksInMass
        Deprecated.

      • resolveId

        private java.lang.String resolveId
        The id used to store the resolve information.

    • Constructor Detail

      • RetrieveOptions

        public RetrieveOptions()

    • Method Detail

      • getDestArtifactPattern

        public java.lang.String getDestArtifactPattern()

      • setDestArtifactPattern

        public RetrieveOptions setDestArtifactPattern​(java.lang.String destArtifactPattern)

      • getConfs

        public java.lang.String[] getConfs()

      • getOverwriteMode

        public java.lang.String getOverwriteMode()

      • setOverwriteMode

        public RetrieveOptions setOverwriteMode​(java.lang.String overwriteMode)

      • getDestIvyPattern

        public java.lang.String getDestIvyPattern()

      • setDestIvyPattern

        public RetrieveOptions setDestIvyPattern​(java.lang.String destIvyPattern)

      • isMakeSymlinks

        public boolean isMakeSymlinks()

      • isMakeSymlinksInMass

        @Deprecated
public boolean isMakeSymlinksInMass()
        Deprecated.
        Starting 2.5, creating symlinks in mass is no longer supported and this method will always return false
        Returns:
        false

      • setMakeSymlinks

        public RetrieveOptions setMakeSymlinks​(boolean makeSymlinks)

      • setMakeSymlinksInMass

        @Deprecated
public RetrieveOptions 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. Use setMakeSymlinks(boolean) instead
        Parameters:
        makeSymlinksInMass - ditto
        Returns:
        RetrieveOptions

      • isSync

        public boolean isSync()

      • isUseOrigin

        public boolean isUseOrigin()

      • setUseOrigin

        public RetrieveOptions setUseOrigin​(boolean useOrigin)

      • getResolveId

        public java.lang.String getResolveId()

      • setResolveId

        public RetrieveOptions setResolveId​(java.lang.String resolveId)