Top Description Inners Fields Constructors Methods
org.eclipse.jgit.api

public Class CherryPickResult

extends Object
Class Inheritance
Imports
java.util.List, .Map, org.eclipse.jgit.lib.Ref, org.eclipse.jgit.merge.ResolveMerger.MergeFailureReason, org.eclipse.jgit.revwalk.RevCommit
Encapsulates the result of a org.eclipse.jgit.api.CherryPickCommand.

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static enum
CherryPickResult.CherryPickStatus

The cherry-pick status

Field Summary

Modifier and TypeField and Description
private final List<Ref>
cherryPickedRefs

public static final CherryPickResult
CONFLICT

A CherryPickResult with status CherryPickStatus#CONFLICTING

private final Map<String, ResolveMerger.MergeFailureReason>
failingPaths

private final RevCommit
newHead

private final CherryPickResult.CherryPickStatus
status

Constructor Summary

AccessConstructor and Description
public
CherryPickResult(RevCommit
commit the head points at after this cherry-pick
newHead, List<Ref>
list of successfully cherry-picked Ref's
cherryPickedRefs)

Constructor for CherryPickResult

public
CherryPickResult(Map<String, ResolveMerger.MergeFailureReason>
list of paths causing this cherry-pick to fail (see org.eclipse.jgit.merge.ResolveMerger#getFailingPaths() for details)
failingPaths)

Constructor for CherryPickResult

private
CherryPickResult(CherryPickResult.CherryPickStatus status)

Method Summary

Modifier and TypeMethod and Description
public List<Ref>

Returns:

the list of successfully cherry-picked Ref's, null if getStatus is not org.eclipse.jgit.api.CherryPickResult.CherryPickStatus#OK
getCherryPickedRefs()

Get the cherry-picked Refs

public Map<String, ResolveMerger.MergeFailureReason>

Returns:

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

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

public RevCommit

Returns:

the commit the head points at after this cherry-pick, null if getStatus is not org.eclipse.jgit.api.CherryPickResult.CherryPickStatus#OK
getNewHead()

Get the new head after this cherry-pick

public CherryPickResult.CherryPickStatus

Returns:

the status this cherry-pick resulted in
getStatus()

Get status

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

cherryPickedRefsback to summary
private final List<Ref> cherryPickedRefs
CONFLICTback to summary
public static final CherryPickResult CONFLICT

A CherryPickResult with status CherryPickStatus#CONFLICTING

failingPathsback to summary
private final Map<String, ResolveMerger.MergeFailureReason> failingPaths
newHeadback to summary
private final RevCommit newHead
statusback to summary
private final CherryPickResult.CherryPickStatus status

Constructor Detail

CherryPickResultback to summary
public CherryPickResult(RevCommit newHead, List<Ref> cherryPickedRefs)

Constructor for CherryPickResult

Parameters
newHead:RevCommit

commit the head points at after this cherry-pick

cherryPickedRefs:List<Ref>

list of successfully cherry-picked Ref's

CherryPickResultback to summary
public CherryPickResult(Map<String, ResolveMerger.MergeFailureReason> failingPaths)

Constructor for CherryPickResult

Parameters
failingPaths:Map<String, ResolveMerger.MergeFailureReason>

list of paths causing this cherry-pick to fail (see org.eclipse.jgit.merge.ResolveMerger#getFailingPaths() for details)

CherryPickResultback to summary
private CherryPickResult(CherryPickResult.CherryPickStatus status)

Method Detail

getCherryPickedRefsback to summary
public List<Ref> getCherryPickedRefs()

Get the cherry-picked Refs

Returns:List<Ref>

the list of successfully cherry-picked Ref's, null if getStatus is not org.eclipse.jgit.api.CherryPickResult.CherryPickStatus#OK

getFailingPathsback to summary
public Map<String, ResolveMerger.MergeFailureReason> getFailingPaths()

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

Returns:Map<String, ResolveMerger.MergeFailureReason>

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

getNewHeadback to summary
public RevCommit getNewHead()

Get the new head after this cherry-pick

Returns:RevCommit

the commit the head points at after this cherry-pick, null if getStatus is not org.eclipse.jgit.api.CherryPickResult.CherryPickStatus#OK

getStatusback to summary
public CherryPickResult.CherryPickStatus getStatus()

Get status

Returns:CherryPickResult.CherryPickStatus

the status this cherry-pick resulted in

org.eclipse.jgit.api back to summary

public sealed Enum CherryPickResult.CherryPickStatus

extends Enum<CherryPickResult.CherryPickStatus>
Class Inheritance
The cherry-pick status

Field Summary

Modifier and TypeField and Description
public static final CherryPickResult.CherryPickStatus
CONFLICTING

Cherry-pick found conflicts to be resolved

public static final CherryPickResult.CherryPickStatus
FAILED

Cherry-pick failed

public static final CherryPickResult.CherryPickStatus
OK

Cherry-pick succeeded

Constructor Summary

AccessConstructor and Description
private
CherryPickStatus()

Method Summary

Modifier and TypeMethod and Description
public static CherryPickResult.CherryPickStatus
valueOf(String name)

public static CherryPickResult.CherryPickStatus[]
values()

Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinaltoStringvalueOf

Field Detail

CONFLICTINGback to summary
public static final CherryPickResult.CherryPickStatus CONFLICTING

Cherry-pick found conflicts to be resolved

FAILEDback to summary
public static final CherryPickResult.CherryPickStatus FAILED

Cherry-pick failed

OKback to summary
public static final CherryPickResult.CherryPickStatus OK

Cherry-pick succeeded

Constructor Detail

CherryPickStatusback to summary
private CherryPickStatus()

Method Detail

valueOfback to summary
public static CherryPickResult.CherryPickStatus valueOf(String name)
valuesback to summary
public static CherryPickResult.CherryPickStatus[] values()