jetbrains.buildServer.artifacts

Interface ArtifactDependency

All Known Subinterfaces:

SArtifactDependency

All Known Implementing Classes:

ArtifactDependencyInfo, BaseArtifactDependency

public interface ArtifactDependency

Represents dependency on one or more artifacts of some build.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getId() Returns artifact dependency id
java.util.List<java.lang.String>	getReferences() Returns references used in this dependency (in destination path, source paths or in the build number)
RevisionRule	getRevisionRule() Returns revision rule for downloaded artifacts.
java.lang.String	getSourceBuildTypeId() Returns internal id of source build configuration
java.lang.String	getSourceExternalId() Returns external id of source build configuration
java.lang.String	getSourceName() Returns name of the source build configuration
java.lang.String	getSourcePaths() Returns paths to artifacts in source build configuration
boolean	isCleanDestinationFolder() Indicates whether destination folder should be cleaned before artifacts downloading
boolean	isSimilarTo(ArtifactDependency dep) Checks if another artifact dependency object is equal to this, ignoring differences in ids (if any)
void	replaceReferences(ValueResolver resolver) Replaces references in this artifact dependency using the provided resolver
void	setCleanDestinationFolder(boolean cleanDestinationFolder) Set to true if destination directory should be cleaned before artifacts processing
void	setRevisionRule(RevisionRule revisionRule) Sets new revision rule to this artifact dependency
void	setSourceBuildTypeId(java.lang.String sourceBuildTypeInternalId) Sets new source build configuration id
void	setSourcePaths(java.lang.String paths) Sets new source paths to this artifact dependency

Method Detail

getSourceBuildTypeId

@NotNull
java.lang.String getSourceBuildTypeId()

Returns internal id of source build configuration

Returns:

build configuration internal id

getSourceExternalId

@NotNull
java.lang.String getSourceExternalId()

Returns external id of source build configuration

Returns:

build configuration external id

Since:

8.0

getSourceName

@NotNull
java.lang.String getSourceName()

Returns name of the source build configuration

Returns:

name of the source build configuration

getSourcePaths

@NotNull
java.lang.String getSourcePaths()

Returns paths to artifacts in source build configuration

Returns:

collection of paths

isCleanDestinationFolder

boolean isCleanDestinationFolder()

Indicates whether destination folder should be cleaned before artifacts downloading

Returns:

true if destination directory cleaning is required

getRevisionRule

@NotNull
RevisionRule getRevisionRule()

Returns revision rule for downloaded artifacts. Revision rule identifies build from which artifacts should be downloaded.

Returns:

revision rule

setCleanDestinationFolder

void setCleanDestinationFolder(boolean cleanDestinationFolder)

Set to true if destination directory should be cleaned before artifacts processing

Parameters:

cleanDestinationFolder - true to clean destination directory

setSourceBuildTypeId

void setSourceBuildTypeId(@NotNull
                          java.lang.String sourceBuildTypeInternalId)

Sets new source build configuration id

Parameters:

sourceBuildTypeInternalId - new source build configuration id

setRevisionRule

void setRevisionRule(@NotNull
                     RevisionRule revisionRule)

Sets new revision rule to this artifact dependency

Parameters:

revisionRule - new revision rule

setSourcePaths

void setSourcePaths(@NotNull
                    java.lang.String paths)

Sets new source paths to this artifact dependency

Parameters:

paths - paths

replaceReferences

void replaceReferences(@NotNull
                       ValueResolver resolver)

Replaces references in this artifact dependency using the provided resolver

Parameters:

resolver - replacement map

getId

@NotNull
java.lang.String getId()

Returns artifact dependency id

Returns:

id

Since:

10.0

isSimilarTo

boolean isSimilarTo(ArtifactDependency dep)

Checks if another artifact dependency object is equal to this, ignoring differences in ids (if any)

Parameters:

dep - Another artifact dependency

Returns:

true if artifact dependency objects are equal (ignoring ids)

Since:

10.0

getReferences

java.util.List<java.lang.String> getReferences()

Returns references used in this dependency (in destination path, source paths or in the build number)

Returns:

see above