jetbrains.buildServer.vcs
Interface IncludeRuleBasedMappingProvider

All Superinterfaces:

VcsClientMappingProvider

public interface IncludeRuleBasedMappingProvider
extends VcsClientMappingProvider

THIS IS AN INTERNAL API, AND IT IS SUBJECT TO CHANGE!

Author:

kir

Method Summary

java.util.Collection<VcsClientMapping>

getClientMapping(VcsRoot vcsRoot, IncludeRule includeRule) This method provides mapping information from given VcsRoot and a path within it to actual possible VCS paths.

Method Detail

getClientMapping

java.util.Collection<VcsClientMapping> getClientMapping(@NotNull
                                                        VcsRoot vcsRoot,
                                                        @NotNull
                                                        IncludeRule includeRule)
                                                        throws VcsException

This method provides mapping information from given VcsRoot and a path within it to actual possible VCS paths. There may be several target paths (for instance, when externals are used in Subversion and multiline client mapping is used for Perforce) This method generates a collection of possible VCS path prefixes, which can be used to create fullPath variable passed to the VcsPersonalSupport.mapFullPath(jetbrains.buildServer.vcs.VcsRootEntry, java.lang.String). In general, this is an identity of the VCS server + path within this server.

Parameters:

vcsRoot - VCS root, whose mapping should be retrieved

includeRule - a prefix for the VCS root, which may limit the scope of the searched VCS

Returns:

1+ mappings in the requested VCS root. Each mapping represents two path-like values. 1: VCS path prefix, 2: target path (relative to VCS root, the value should include includeRule.getTo() value). Note: only UNIX-like slashes are allowed in returning paths

Throws:

VcsException - when there is a problem accessing VCS

Since:

5.0