jetbrains.buildServer.vcs
Class BaseModificationData

java.lang.Object
  extended by jetbrains.buildServer.vcs.BaseModificationData
Direct Known Subclasses:
ModificationData, VcsModificationData

public class BaseModificationData
extends java.lang.Object

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


Constructor Summary
protected BaseModificationData(java.lang.String user, java.lang.String description, java.util.Date vcsDate, java.util.List<VcsChange> changes, java.lang.String version, java.lang.String displayVersion, int changesCount)
           
 
Method Summary
 void addParentRevision(java.lang.String parentRevision)
          Add parent revision for this change
 boolean equals(java.lang.Object o)
           
 java.util.Map<java.lang.String,java.lang.String> getAttributes()
           
 int getChangeCount()
           
 java.util.List<VcsChange> getChanges()
           
 java.lang.String getDescription()
           
 java.lang.String getDisplayVersion()
           
 java.util.List<java.lang.String> getParentRevisions()
          Get parent revisions of this change, returns an empty list if VCS does not provide information about parents.
 java.lang.String getUserName()
           
 java.util.Date getVcsDate()
           
 java.lang.String getVersion()
           
 int hashCode()
           
 boolean isCanBeIgnored()
          Returns true if this change can be ignored (i.e.
 void setAttribute(java.lang.String name, java.lang.String value)
           
 void setAttributes(java.util.Map<java.lang.String,java.lang.String> attributes)
           
 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.
 void setParentRevisions(java.util.Collection<java.lang.String> parentRevisions)
          Set parent revisions for this change
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

BaseModificationData

protected BaseModificationData(@Nullable
                               java.lang.String user,
                               @Nullable
                               java.lang.String description,
                               @NotNull
                               java.util.Date vcsDate,
                               @NotNull
                               java.util.List<VcsChange> changes,
                               @NotNull
                               java.lang.String version,
                               @NotNull
                               java.lang.String displayVersion,
                               int changesCount)
Method Detail

getUserName

@Nullable
public java.lang.String getUserName()

getDescription

@Nullable
public java.lang.String getDescription()

getVcsDate

@NotNull
public java.util.Date getVcsDate()

getChanges

@NotNull
public java.util.List<VcsChange> getChanges()

getVersion

@NotNull
public java.lang.String getVersion()

getDisplayVersion

@NotNull
public java.lang.String getDisplayVersion()

getChangeCount

public int getChangeCount()

addParentRevision

public void addParentRevision(@NotNull
                              java.lang.String parentRevision)
Add parent revision for this change

Parameters:
parentRevision - parent revision
Since:
7.0

setParentRevisions

public void setParentRevisions(@NotNull
                               java.util.Collection<java.lang.String> parentRevisions)
Set parent revisions for this change

Parameters:
parentRevisions - parent revisions
Since:
7.0

getParentRevisions

@NotNull
public java.util.List<java.lang.String> getParentRevisions()
Get parent revisions of this change, returns an empty list if VCS does not provide information about parents.

Returns:
see above
Since:
7.0

setAttributes

public void setAttributes(@NotNull
                          java.util.Map<java.lang.String,java.lang.String> attributes)

setAttribute

public void setAttribute(@NotNull
                         java.lang.String name,
                         @NotNull
                         java.lang.String value)

getAttributes

@NotNull
public java.util.Map<java.lang.String,java.lang.String> getAttributes()

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(java.lang.Object o)
Overrides:
equals in class java.lang.Object

hashCode

public int hashCode()
Overrides:
hashCode in class java.lang.Object

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object