jetbrains.buildServer.vcs

Interface VcsContentManager

All Known Subinterfaces:

VcsManager

public interface VcsContentManager

Since:

8.1

Author:

Eugene Petrenko (eugene.petrenko@jetbrains.com)

Method Summary

Modifier and Type	Method and Description
byte[]	getFileContent(Build build, java.lang.String filePath) Get binary content of the single file in modification set.
byte[]	getFileContent(java.util.List<VcsRootInstanceEntry> vcsRootEntries, java.lang.String relativePath) Get the latest file content, searching it in the provided list of VCS roots
byte[]	getFileContent(SBuildType buildType, java.lang.String relativePath) Get latest file content for given relative path in the given build configuration.

Method Detail

getFileContent

@NotNull
byte[] getFileContent(Build build,
                               java.lang.String filePath)
                        throws VcsException

Get binary content of the single file in modification set.

Parameters:

filePath - - relative file path regarding to the project root, "checkout root" from vcs root should not be included

build - build for which file content should be obtained

Returns:

- specified file content, corresponding to the build

Throws:

VcsException - - throw this exception if some problem occurred while collecting changes or changes cannot be collected because of invalid configuration, or if file, corresponding to specified path cannot be found.

getFileContent

@Nullable
byte[] getFileContent(@NotNull
                                SBuildType buildType,
                                @Nullable
                                java.lang.String relativePath)
                         throws VcsException

Get latest file content for given relative path in the given build configuration.

Parameters:

buildType - build configuration

relativePath - relative path to the file to be searched in the project VCS roots

Returns:

null if no corresponding file found

Throws:

VcsException - when VCS access problem occurs

getFileContent

@Nullable
byte[] getFileContent(@NotNull
                                java.util.List<VcsRootInstanceEntry> vcsRootEntries,
                                @Nullable
                                java.lang.String relativePath)
                         throws VcsException

Get the latest file content, searching it in the provided list of VCS roots

Parameters:

vcsRootEntries - search file content in a given list of VCS root entries

relativePath - relative path to the file to be searched in the project VCS roots

Returns:

null if no corresponding file found

Throws:

VcsException - when VCS access problem occurs

See Also:

VcsRootEntry