Package jetbrains.buildServer.vcs

Class ModificationData

java.lang.Object

jetbrains.buildServer.vcs.BaseCommitData

jetbrains.buildServer.vcs.BaseModificationData

jetbrains.buildServer.vcs.TModificationData<VcsRoot>

jetbrains.buildServer.vcs.ModificationData

All Implemented Interfaces:

ChangeData, CommitData

public class ModificationData
extends TModificationData<VcsRoot>
implements ChangeData

Bean object to represent modification happened to the version control as reported by version control integration plugin.

Author:

Kir

Constructor Summary

Constructors

Constructor	Description
ModificationData(Date changeDate, List<VcsChange> changes, String description, String user, VcsRoot vcsRoot, String version, String displayVersion)	This constructor has to be used in production code to create ModificationData instance

Method Summary

Modifier and Type	Method	Description
static ModificationData	substituteFiles(ModificationData originalData, List<VcsChange> changedFiles)	Creates a copy of modification data with changed files substituted.

Methods inherited from class jetbrains.buildServer.vcs.TModificationData

equals, getVcsRoot, getVcsRootObject, hashCode, substituteFiles

Methods inherited from class jetbrains.buildServer.vcs.BaseModificationData

getChangeCount, getChanges, getDescription, getUserName, isCanBeIgnored, setCanBeIgnored, toString

Methods inherited from class jetbrains.buildServer.vcs.BaseCommitData

addParentRevision, equalsImpl, getAttributes, getDisplayVersion, getParentRevisions, getVcsDate, getVersion, setAttribute, setAttributes, setParentRevisions

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface jetbrains.vcs.api.ChangeData

getAttributes, getChanges, getDescription, getDisplayVersion, getParentRevisions, getUserName, getVcsDate, getVcsRoot, getVersion, isCanBeIgnored

Constructor Detail

ModificationData

public ModificationData(@NotNull
                        Date changeDate,
                        @NotNull
                        List<VcsChange> changes,
                        @Nullable
                        String description,
                        @Nullable
                        String user,
                        VcsRoot vcsRoot,
                        @NotNull
                        String version,
                        @Nullable
                        String displayVersion)

This constructor has to be used in production code to create ModificationData instance

Parameters:

changeDate - date of the change.

changes - list of all files affected by this modification.

description - commit message.

user - user name in the version control.

vcsRoot - current settings.

version - repository version right after the modification. Has to have the same meaning as VcsSupport.getCurrentVersion.

displayVersion - repository version right after the modification in the human readable format. Used for presentation purpose only.

Method Detail

substituteFiles

@NotNull
public static ModificationData substituteFiles(@NotNull
                                               ModificationData originalData,
                                               @NotNull
                                               List<VcsChange> changedFiles)

Creates a copy of modification data with changed files substituted.

Parameters:

originalData - original data

changedFiles - new changed files

Returns:

ModificationData copy but with different changed files