Package jetbrains.buildServer.vcs
Interface VcsChangeInfo
-
- All Known Subinterfaces:
VcsFileModification
- All Known Implementing Classes:
FilteredVcsChange
,MockVcsFileModification
,ServerSideVcsFileModificationImpl
,VcsChange
public interface VcsChangeInfo
Presents information about file change in version control modification
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static class
VcsChangeInfo.ContentType
Type of file content requested for file changestatic class
VcsChangeInfo.Type
Type of file change
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description String
getAfterChangeRevisionNumber()
Revision number of the file after the change.String
getBeforeChangeRevisionNumber()
Revision number of the file before the change.String
getChangeTypeName()
String
getFileName()
String
getRelativeFileName()
Returns the relative name of this file.VcsChangeInfo.Type
getType()
default boolean
needsApplicabilityCheck()
-
-
-
Method Detail
-
getChangeTypeName
@Nullable String getChangeTypeName()
- Returns:
- human readable change type name
-
getFileName
@NotNull String getFileName()
- Returns:
- whole file name
-
getRelativeFileName
@NotNull String getRelativeFileName()
Returns the relative name of this file. Note: the result path can be mapped (i.e. takes into account checkout rules) or not depending on how this object has been acquired.- Returns:
- relative to vcs root file name
-
getType
@NotNull VcsChangeInfo.Type getType()
- Returns:
- change type
-
getBeforeChangeRevisionNumber
@Nullable String getBeforeChangeRevisionNumber()
Revision number of the file before the change. This revision may or may not be the same as version returned by see jetbrains.buildServer.vcs.CollectChangesPolicy This revision is shown in the web UI only and it should have some meaningful value for users. Also this revision may help VCS plugin to obtain file content, see jetbrains.buildServer.vcs.VcsFileContentProvider- Returns:
- revision number before the change
-
getAfterChangeRevisionNumber
@Nullable String getAfterChangeRevisionNumber()
Revision number of the file after the change. See alsogetBeforeChangeRevisionNumber()
.- Returns:
- revision number after the change
-
needsApplicabilityCheck
default boolean needsApplicabilityCheck()
- Returns:
- true if this change relates to modification of an existing object, so suitability check is required
- Since:
- 2024.12
-
-