Package org.eclipse.jgit.api

Class CherryPickResult

java.lang.Object

org.eclipse.jgit.api.CherryPickResult

public class CherryPickResult
extends java.lang.Object

Encapsulates the result of a CherryPickCommand.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CherryPickResult.CherryPickStatus	The cherry-pick status

Field Summary

Fields

Modifier and Type	Field	Description
private java.util.List<Ref>	cherryPickedRefs
static CherryPickResult	CONFLICT	A CherryPickResult with status CherryPickResult.CherryPickStatus.CONFLICTING
private java.util.Map<java.lang.String,ResolveMerger.MergeFailureReason>	failingPaths
private RevCommit	newHead
private CherryPickResult.CherryPickStatus	status

Constructor Summary

Constructors

Modifier	Constructor	Description
	CherryPickResult(java.util.Map<java.lang.String,ResolveMerger.MergeFailureReason> failingPaths)	Constructor for CherryPickResult
private	CherryPickResult(CherryPickResult.CherryPickStatus status)
	CherryPickResult(RevCommit newHead, java.util.List<Ref> cherryPickedRefs)	Constructor for CherryPickResult

Method Summary

Modifier and Type	Method	Description
java.util.List<Ref>	getCherryPickedRefs()	Get the cherry-picked Refs
java.util.Map<java.lang.String,ResolveMerger.MergeFailureReason>	getFailingPaths()	Get the list of paths causing this cherry-pick to fail
RevCommit	getNewHead()	Get the new head after this cherry-pick
CherryPickResult.CherryPickStatus	getStatus()	Get status

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

status

private final CherryPickResult.CherryPickStatus status

newHead

private final RevCommit newHead

cherryPickedRefs

private final java.util.List<Ref> cherryPickedRefs

failingPaths

private final java.util.Map<java.lang.String,ResolveMerger.MergeFailureReason> failingPaths

CONFLICT

public static final CherryPickResult CONFLICT

A CherryPickResult with status CherryPickResult.CherryPickStatus.CONFLICTING

Constructor Detail

CherryPickResult

public CherryPickResult(RevCommit newHead,
                        java.util.List<Ref> cherryPickedRefs)

Constructor for CherryPickResult

Parameters:

newHead - commit the head points at after this cherry-pick

cherryPickedRefs - list of successfully cherry-picked Ref's

CherryPickResult

public CherryPickResult(java.util.Map<java.lang.String,ResolveMerger.MergeFailureReason> failingPaths)

Constructor for CherryPickResult

Parameters:

failingPaths - list of paths causing this cherry-pick to fail (see ResolveMerger.getFailingPaths() for details)

CherryPickResult

private CherryPickResult(CherryPickResult.CherryPickStatus status)

Method Detail

getStatus

public CherryPickResult.CherryPickStatus getStatus()

Get status

Returns:

the status this cherry-pick resulted in

getNewHead

public RevCommit getNewHead()

Get the new head after this cherry-pick

Returns:

the commit the head points at after this cherry-pick, null if getStatus() is not CherryPickResult.CherryPickStatus.OK

getCherryPickedRefs

public java.util.List<Ref> getCherryPickedRefs()

Get the cherry-picked Refs

Returns:

the list of successfully cherry-picked Ref's, null if getStatus() is not CherryPickResult.CherryPickStatus.OK

getFailingPaths

public java.util.Map<java.lang.String,ResolveMerger.MergeFailureReason> getFailingPaths()

Get the list of paths causing this cherry-pick to fail

Returns:

the list of paths causing this cherry-pick to fail (see ResolveMerger.getFailingPaths() for details), null if getStatus() is not CherryPickResult.CherryPickStatus.FAILED