de.unibremen.informatik.st.libvcs4j.Commit Maven / Gradle / Ivy

Go to download
package de.unibremen.informatik.st.libvcs4j;

import java.time.LocalDateTime;
import java.util.List;

/**
 * Represents a single commit.
 */
public interface Commit extends VCSModelElement {

	/**
	 * Returns the commit id.
	 *
	 * @return
	 * 		The commit id.
	 */
	String getId();

	/**
	 * Returns the author of this commit.
	 *
	 * @return
	 * 		The author of this commit.
	 */
	String getAuthor();

	/**
	 * Returns the commit message.
	 *
	 * @return
	 * 		The commit message.
	 */
	String getMessage();

	/**
	 * Returns the datetime of this commit.
	 *
	 * @return
	 * 		The datetime of this commit.
	 */
	LocalDateTime getDateTime();

	/**
	 * Returns the ids of the parents of this commit.
	 *
	 * @return
	 *      The ids of the parents of this commit.
	 */
	List getParentIds();

	/**
	 * Returns the list of file changes.
	 *
	 * @return
	 * 		The list of file changes.
	 */
	List getFileChanges();

	/**
	 * Returns the issues referenced by this commit. To enable this feature
	 * when processing a repository, set an appropriate {@link ITEngine} with
	 * {@link VCSEngine#setITEngine(ITEngine)}. The returned list does not
	 * contain the same issue (according to {@link Issue#getId()}) twice.
	 *
	 * @return
	 * 		The Issues referenced by this commit.
	 */
	List getIssues();

	/**
	 * Returns whether this commit is a merge commit. That is, it has more than
	 * one parent (see {@link #getParentIds()}).
	 *
	 * @return
	 *      {@code true} if this commit is a merge commit, {@code false}
	 *      otherwise.
	 */
	default boolean isMerge() {
		return getParentIds().size() >= 2;
	}
}