Package jetbrains.buildServer.vcs

Class TModificationData<TRoot extends VcsRoot>

java.lang.Object

jetbrains.buildServer.vcs.BaseCommitData

jetbrains.buildServer.vcs.BaseModificationData

jetbrains.buildServer.vcs.TModificationData<TRoot>

All Implemented Interfaces:

CommitData

Direct Known Subclasses:

ModificationData

public class TModificationData<TRoot extends VcsRoot>
extends BaseModificationData

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

Author:

Kir

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
TRoot	getVcsRoot()
TRoot	getVcsRootObject()
int	hashCode()
static <TRoot extends VcsRoot> TModificationData<TRoot>	substituteFiles(TModificationData<TRoot> originalData, List<VcsChange> changedFiles)	Creates a copy of modification data with changed files substituted.

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

Constructor Detail

TModificationData

protected TModificationData(@NotNull
                            Date changeDate,
                            @NotNull
                            List<VcsChange> changes,
                            @Nullable
                            String description,
                            @Nullable
                            String user,
                            TRoot vcsRoot,
                            @NotNull
                            String version,
                            @NotNull
                            String displayVersion,
                            int changesCount)

TModificationData

public TModificationData(@NotNull
                         Date changeDate,
                         @NotNull
                         List<VcsChange> changes,
                         @Nullable
                         String description,
                         @Nullable
                         String user,
                         TRoot 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 <TRoot extends VcsRoot> TModificationData<TRoot> substituteFiles(@NotNull
                                                                               TModificationData<TRoot> 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

getVcsRootObject

@NotNull
public TRoot getVcsRootObject()

equals

public boolean equals(Object o)

Overrides:

equals in class BaseModificationData

hashCode

public int hashCode()

Overrides:

hashCode in class BaseModificationData

getVcsRoot

@NotNull
public TRoot getVcsRoot()