jetbrains.vcs.api

Interface ChangeData

All Superinterfaces:

CommitData

All Known Implementing Classes:

ModificationData

public interface ChangeData
extends CommitData

This interface represents a change collected from the repository.

Since:

8.0 `

Author:

kir

See Also:

CollectChangesService

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.lang.String>	getAttributes()
java.util.List<VcsChange>	getChanges()
java.lang.String	getDescription()
java.lang.String	getDisplayVersion()
java.util.List<java.lang.String>	getParentRevisions()
java.lang.String	getUserName()
java.util.Date	getVcsDate()
VcsRoot	getVcsRoot() Get VcsRoot, associated with the change.
java.lang.String	getVersion()
boolean	isCanBeIgnored()

Method Detail

getUserName

@Nullable
java.lang.String getUserName()

Returns:

VCS user name

getVersion

@NotNull
java.lang.String getVersion()

Specified by:

getVersion in interface CommitData

Returns:

VCS revision (internal representation)

getDisplayVersion

@NotNull
java.lang.String getDisplayVersion()

Specified by:

getDisplayVersion in interface CommitData

Returns:

VCS revision (displayable representation)

getDescription

@Nullable
java.lang.String getDescription()

Returns:

VCS commit message

getVcsDate

@NotNull
java.util.Date getVcsDate()

Specified by:

getVcsDate in interface CommitData

Returns:

VCS change date

getChanges

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

Returns:

List of file changes in this change

getParentRevisions

@NotNull
java.util.List<java.lang.String> getParentRevisions()

Specified by:

getParentRevisions in interface CommitData

Returns:

parent revisions of this change, returns an empty list if VCS does not provide information about parents.

Since:

7.0

getAttributes

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

Specified by:

getAttributes in interface CommitData

Returns:

attributes of this change

Since:

8.0

isCanBeIgnored

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.

getVcsRoot

@NotNull
VcsRoot getVcsRoot()

Get VcsRoot, associated with the change.