jetbrains.vcs.api

Interface CommitInfo

All Superinterfaces:

CommitData

All Known Implementing Classes:

CommitDataBean

public interface CommitInfo
extends CommitData

Created 30.09.13 12:47

Since:

8.1

Author:

Eugene Petrenko (eugene.petrenko@jetbrains.com)

Method Summary

Modifier and Type	Method and Description
java.util.List<java.lang.String>	getBranches()
java.lang.String	getCommitAuthor()
java.lang.String	getCommitMessage()
java.util.List<java.lang.String>	getHeadNames() Repository's current state contains a number of named commits.
java.util.List<CommitMountPointInfo>	getMountPoints()
java.util.List<java.lang.String>	getTags()
boolean	isIncludedByCheckoutRules()

Methods inherited from interface jetbrains.vcs.api.CommitData

getAttributes, getDisplayVersion, getParentRevisions, getVcsDate, getVersion

Method Detail

getBranches

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

Returns:

branches to which commit belongs or empty list if nothing is known

Since:

8.1

getHeadNames

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

Repository's current state contains a number of named commits. We name those commits 'heads' This method returns association of a commit with heads that are on the commit

Returns:

all head names that are on this commit

Since:

8.1

getTags

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

Returns:

tags for commit

Since:

8.1

isIncludedByCheckoutRules

boolean isIncludedByCheckoutRules()

Returns:

true if commit is not filtered by checkout rules

Since:

8.1

getCommitAuthor

@Nullable
java.lang.String getCommitAuthor()

Returns:

commit author associated with it

Since:

8.1

getCommitMessage

@Nullable
java.lang.String getCommitMessage()

Returns:

commit message

Since:

8.1

getMountPoints

@NotNull
java.util.List<CommitMountPointInfo> getMountPoints()

Returns:

mount points detected for the commit

Since:

8.1