diff options
Diffstat (limited to 'org.eclipse.jgit/src/org/eclipse/jgit/api/CherryPickResult.java')
| -rw-r--r-- | org.eclipse.jgit/src/org/eclipse/jgit/api/CherryPickResult.java | 28 |
1 files changed, 20 insertions, 8 deletions
diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/api/CherryPickResult.java b/org.eclipse.jgit/src/org/eclipse/jgit/api/CherryPickResult.java index b121291fca..ff55aebd91 100644 --- a/org.eclipse.jgit/src/org/eclipse/jgit/api/CherryPickResult.java +++ b/org.eclipse.jgit/src/org/eclipse/jgit/api/CherryPickResult.java @@ -46,12 +46,11 @@ import java.util.List; import java.util.Map; import org.eclipse.jgit.lib.Ref; -import org.eclipse.jgit.merge.ResolveMerger; import org.eclipse.jgit.merge.ResolveMerger.MergeFailureReason; import org.eclipse.jgit.revwalk.RevCommit; /** - * Encapsulates the result of a {@link CherryPickCommand}. + * Encapsulates the result of a {@link org.eclipse.jgit.api.CherryPickCommand}. */ public class CherryPickResult { @@ -91,6 +90,8 @@ public class CherryPickResult { private final Map<String, MergeFailureReason> failingPaths; /** + * Constructor for CherryPickResult + * * @param newHead * commit the head points at after this cherry-pick * @param cherryPickedRefs @@ -104,9 +105,12 @@ public class CherryPickResult { } /** + * Constructor for CherryPickResult + * * @param failingPaths * list of paths causing this cherry-pick to fail (see - * {@link ResolveMerger#getFailingPaths()} for details) + * {@link org.eclipse.jgit.merge.ResolveMerger#getFailingPaths()} + * for details) */ public CherryPickResult(Map<String, MergeFailureReason> failingPaths) { this.status = CherryPickStatus.FAILED; @@ -130,6 +134,8 @@ public class CherryPickResult { CherryPickStatus.CONFLICTING); /** + * Get status + * * @return the status this cherry-pick resulted in */ public CherryPickStatus getStatus() { @@ -137,28 +143,34 @@ public class CherryPickResult { } /** + * Get the new head after this cherry-pick + * * @return the commit the head points at after this cherry-pick, * <code>null</code> if {@link #getStatus} is not - * {@link CherryPickStatus#OK} + * {@link org.eclipse.jgit.api.CherryPickResult.CherryPickStatus#OK} */ public RevCommit getNewHead() { return newHead; } /** + * Get the cherry-picked {@code Ref}s + * * @return the list of successfully cherry-picked <code>Ref</code>'s, * <code>null</code> if {@link #getStatus} is not - * {@link CherryPickStatus#OK} + * {@link org.eclipse.jgit.api.CherryPickResult.CherryPickStatus#OK} */ public List<Ref> getCherryPickedRefs() { return cherryPickedRefs; } /** + * Get the list of paths causing this cherry-pick to fail + * * @return the list of paths causing this cherry-pick to fail (see - * {@link ResolveMerger#getFailingPaths()} for details), - * <code>null</code> if {@link #getStatus} is not - * {@link CherryPickStatus#FAILED} + * {@link org.eclipse.jgit.merge.ResolveMerger#getFailingPaths()} + * for details), <code>null</code> if {@link #getStatus} is not + * {@link org.eclipse.jgit.api.CherryPickResult.CherryPickStatus#FAILED} */ public Map<String, MergeFailureReason> getFailingPaths() { return failingPaths; |