Class RetrieveOptions

java.lang.Object
org.apache.ivy.core.LogOptions
org.apache.ivy.core.retrieve.RetrieveOptions

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

    • OVERWRITEMODE_NEVER

      public static final String OVERWRITEMODE_NEVER
      See Also:
    • OVERWRITEMODE_ALWAYS

      public static final String OVERWRITEMODE_ALWAYS
      See Also:
    • OVERWRITEMODE_NEWER

      public static final String OVERWRITEMODE_NEWER
      See Also:
    • OVERWRITEMODE_DIFFERENT

      public static final String OVERWRITEMODE_DIFFERENT
      See Also:
    • confs

      private 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 String destIvyPattern
      The pattern to which ivy files should be retrieved. If destIvyPattern is null no ivy files will be copied.
    • destArtifactPattern

      private 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 String overwriteMode
    • useOrigin

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

      @Deprecated private boolean makeSymlinksInMass
      Deprecated.
    • resolveId

      private String resolveId
      The id used to store the resolve information.
    • mapper

      private FileNameMapper mapper
  • Constructor Details

    • RetrieveOptions

      public RetrieveOptions()
    • RetrieveOptions

      public RetrieveOptions(RetrieveOptions options)
  • Method Details

    • getDestArtifactPattern

      public String getDestArtifactPattern()
    • setDestArtifactPattern

      public RetrieveOptions setDestArtifactPattern(String destArtifactPattern)
    • getArtifactFilter

      public Filter<Artifact> getArtifactFilter()
    • setArtifactFilter

      public RetrieveOptions setArtifactFilter(Filter<Artifact> artifactFilter)
    • getConfs

      public String[] getConfs()
    • setConfs

      public RetrieveOptions setConfs(String[] confs)
    • getOverwriteMode

      public String getOverwriteMode()
    • setOverwriteMode

      public RetrieveOptions setOverwriteMode(String overwriteMode)
    • getDestIvyPattern

      public String getDestIvyPattern()
    • setDestIvyPattern

      public RetrieveOptions setDestIvyPattern(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()
    • setSync

      public RetrieveOptions setSync(boolean sync)
    • isUseOrigin

      public boolean isUseOrigin()
    • setUseOrigin

      public RetrieveOptions setUseOrigin(boolean useOrigin)
    • getResolveId

      public String getResolveId()
    • setResolveId

      public RetrieveOptions setResolveId(String resolveId)
    • getMapper

      public FileNameMapper getMapper()
    • setMapper

      public RetrieveOptions setMapper(FileNameMapper mapper)