Package jetbrains.buildServer.vcs

Class BaseModificationData

java.lang.Object

jetbrains.buildServer.vcs.BaseCommitData

jetbrains.buildServer.vcs.BaseModificationData

All Implemented Interfaces:

CommitData

Direct Known Subclasses:

TModificationData, VcsModificationData

public class BaseModificationData
extends BaseCommitData

This class contains all necessary information to be sent via XmlRpc to remote client about TeamCity version control modification

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BaseModificationData(String user, String description, Date vcsDate, List<VcsChange> changes, String version, String displayVersion, int changesCount)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
int	getChangeCount()
List<VcsChange>	getChanges()
String	getDescription()
String	getUserName()
int	hashCode()
boolean	isCanBeIgnored()	Returns true if this change can be ignored (i.e.
void	setCanBeIgnored(boolean canBeIgnored)	Set to false if this change cannot be ignored even if all of its files are excluded by checkout rules in all of the build configurations.
String	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

BaseModificationData

protected BaseModificationData(@Nullable
                               String user,
                               @Nullable
                               String description,
                               @NotNull
                               Date vcsDate,
                               @NotNull
                               List<VcsChange> changes,
                               @NotNull
                               String version,
                               @Nullable
                               String displayVersion,
                               int changesCount)

Method Detail

getUserName

@Nullable
public String getUserName()

getDescription

@Nullable
public String getDescription()

getChanges

@NotNull
public List<VcsChange> getChanges()

getChangeCount

public int getChangeCount()

isCanBeIgnored

public boolean isCanBeIgnored()

Returns true if this change can be ignored (i.e. is not registered in the system). Usually change can be safely ignored if all its files are excluded by checkout rules, however there are cases when it is not true. For such case use setCanBeIgnored(boolean)

Returns:

true if change can be ignored

setCanBeIgnored

public void setCanBeIgnored(boolean canBeIgnored)

Set to false if this change cannot be ignored even if all of its files are excluded by checkout rules in all of the build configurations. Default is [true].

Parameters:

canBeIgnored - set to false if change cannot be ignored

equals

public boolean equals(Object o)

Overrides:

equals in class BaseCommitData

hashCode

public int hashCode()

Overrides:

hashCode in class BaseCommitData

toString

public String toString()

Overrides:

toString in class BaseCommitData