Package jetbrains.buildServer.agent.impl.artifacts

Class ArtifactsCollection

java.lang.Object

jetbrains.buildServer.agent.impl.artifacts.ArtifactsCollection

public class ArtifactsCollection
extends Object

Contains data about artifacts ready to be published to TeamCity server.

Constructor Summary

Constructors

Constructor	Description
ArtifactsCollection(String sourcePath, String targetPath, Map<File,String> filePathMap)
ArtifactsCollection(String sourcePath, String targetPath, Map<File,String> filePathMap, boolean isExclude)
ArtifactsCollection(String sourcePath, String targetPath, Map<File,String> filePathMap, boolean isExclude, ArtifactsPreprocessor.SymbolicLinksMode symbolicLinksMode)
ArtifactsCollection(String sourcePath, String targetPath, Map<File,String> filePathMap, boolean isExclude, ArtifactsPreprocessor.SymbolicLinksMode symbolicLinksMode, String originalRule)

Method Summary

Modifier and Type	Method	Description
Map<File,String>	getFilePathMap()	Returns map of files/artifacts on local disk to their respective files on the remote side
List<String>	getOriginalArtifactRules()	Returns artifact rules, this collection was parsed by.
String	getSourcePath()	Returns source part of the artifacts specification (source => target)
ArtifactsPreprocessor.SymbolicLinksMode	getSymbolicLinksMode()	Returns enum of symbolic links archiving mode
String	getTargetPath()	Returns path on the remote side where artifacts must be stored
boolean	isEmpty()	Returns true if this collection does not have artifacts to publish
boolean	isExclude()	Indicates, whether this collection contains files that needs to be excluded
ArtifactsCollection	merge(ArtifactsCollection toMerge, boolean archiveTarget)	Merges this collection with another one
void	setFilePathMap(Map<File,String> filePathMap)	Sets new files map to this collection
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ArtifactsCollection

public ArtifactsCollection(@NotNull
                           String sourcePath,
                           @NotNull
                           String targetPath,
                           @NotNull
                           Map<File,String> filePathMap)

ArtifactsCollection

public ArtifactsCollection(@NotNull
                           String sourcePath,
                           @NotNull
                           String targetPath,
                           @NotNull
                           Map<File,String> filePathMap,
                           boolean isExclude)

ArtifactsCollection

public ArtifactsCollection(@NotNull
                           String sourcePath,
                           @NotNull
                           String targetPath,
                           @NotNull
                           Map<File,String> filePathMap,
                           boolean isExclude,
                           @NotNull
                           ArtifactsPreprocessor.SymbolicLinksMode symbolicLinksMode)

ArtifactsCollection

public ArtifactsCollection(@NotNull
                           String sourcePath,
                           @NotNull
                           String targetPath,
                           @NotNull
                           Map<File,String> filePathMap,
                           boolean isExclude,
                           @NotNull
                           ArtifactsPreprocessor.SymbolicLinksMode symbolicLinksMode,
                           @Nullable
                           String originalRule)

Method Detail

getTargetPath

@NotNull
public String getTargetPath()

Returns path on the remote side where artifacts must be stored

Returns:

see abote

getFilePathMap

@NotNull
public Map<File,String> getFilePathMap()

Returns map of files/artifacts on local disk to their respective files on the remote side

Returns:

see above

setFilePathMap

public void setFilePathMap(@NotNull
                           Map<File,String> filePathMap)

Sets new files map to this collection

Parameters:

filePathMap - new files map

isEmpty

public boolean isEmpty()

Returns true if this collection does not have artifacts to publish

Returns:

see above

getSymbolicLinksMode

@NotNull
public ArtifactsPreprocessor.SymbolicLinksMode getSymbolicLinksMode()

Returns enum of symbolic links archiving mode

Returns:

see above

merge

@NotNull
public ArtifactsCollection merge(@NotNull
                                 ArtifactsCollection toMerge,
                                 boolean archiveTarget)

Merges this collection with another one

Parameters:

toMerge - collection to merge with

archiveTarget - true if target is archive and we could provide several target paths for the same source file

Returns:

merged collection

getSourcePath

@NotNull
public String getSourcePath()

Returns source part of the artifacts specification (source => target)

Returns:

see above

isExclude

public boolean isExclude()

Indicates, whether this collection contains files that needs to be excluded

Returns:

see above

getOriginalArtifactRules

@NotNull
public List<String> getOriginalArtifactRules()

Returns artifact rules, this collection was parsed by. Contains multiple rules if this collection represents a merged set of the artifacts

Returns:

see above

toString

public String toString()

Overrides:

toString in class Object