1 /*
2 * Copyright (C) 2011, Philipp Thun <philipp.thun@sap.com>
3 * and other copyright owners as documented in the project's IP log.
4 *
5 * This program and the accompanying materials are made available
6 * under the terms of the Eclipse Distribution License v1.0 which
7 * accompanies this distribution, is reproduced below, and is
8 * available at http://www.eclipse.org/org/documents/edl-v10.php
9 *
10 * All rights reserved.
11 *
12 * Redistribution and use in source and binary forms, with or
13 * without modification, are permitted provided that the following
14 * conditions are met:
15 *
16 * - Redistributions of source code must retain the above copyright
17 * notice, this list of conditions and the following disclaimer.
18 *
19 * - Redistributions in binary form must reproduce the above
20 * copyright notice, this list of conditions and the following
21 * disclaimer in the documentation and/or other materials provided
22 * with the distribution.
23 *
24 * - Neither the name of the Eclipse Foundation, Inc. nor the
25 * names of its contributors may be used to endorse or promote
26 * products derived from this software without specific prior
27 * written permission.
28 *
29 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
30 * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
31 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
32 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
33 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
34 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
35 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
36 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
37 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
38 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
39 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
40 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
41 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
42 */
43 package org.eclipse.jgit.api;
44
45 import java.util.List;
46 import java.util.Map;
47
48 import org.eclipse.jgit.lib.Ref;
49 import org.eclipse.jgit.merge.ResolveMerger;
50 import org.eclipse.jgit.merge.ResolveMerger.MergeFailureReason;
51 import org.eclipse.jgit.revwalk.RevCommit;
52
53 /**
54 * Encapsulates the result of a {@link CherryPickCommand}.
55 */
56 public class CherryPickResult {
57
58 /**
59 * The cherry-pick status
60 */
61 public enum CherryPickStatus {
62 /** */
63 OK {
64 @Override
65 public String toString() {
66 return "Ok"; //$NON-NLS-1$
67 }
68 },
69 /** */
70 FAILED {
71 @Override
72 public String toString() {
73 return "Failed"; //$NON-NLS-1$
74 }
75 },
76 /** */
77 CONFLICTING {
78 @Override
79 public String toString() {
80 return "Conflicting"; //$NON-NLS-1$
81 }
82 }
83 }
84
85 private final CherryPickStatus status;
86
87 private final RevCommit newHead;
88
89 private final List<Ref> cherryPickedRefs;
90
91 private final Map<String, MergeFailureReason> failingPaths;
92
93 /**
94 * @param newHead
95 * commit the head points at after this cherry-pick
96 * @param cherryPickedRefs
97 * list of successfully cherry-picked <code>Ref</code>'s
98 */
99 public CherryPickResult(RevCommit newHead, List<Ref> cherryPickedRefs) {
100 this.status = CherryPickStatus.OK;
101 this.newHead = newHead;
102 this.cherryPickedRefs = cherryPickedRefs;
103 this.failingPaths = null;
104 }
105
106 /**
107 * @param failingPaths
108 * list of paths causing this cherry-pick to fail (see
109 * {@link ResolveMerger#getFailingPaths()} for details)
110 */
111 public CherryPickResult(Map<String, MergeFailureReason> failingPaths) {
112 this.status = CherryPickStatus.FAILED;
113 this.newHead = null;
114 this.cherryPickedRefs = null;
115 this.failingPaths = failingPaths;
116 }
117
118 private CherryPickResult(CherryPickStatus status) {
119 this.status = status;
120 this.newHead = null;
121 this.cherryPickedRefs = null;
122 this.failingPaths = null;
123 }
124
125 /**
126 * A <code>CherryPickResult</code> with status
127 * {@link CherryPickStatus#CONFLICTING}
128 */
129 public static final CherryPickResult CONFLICT = new CherryPickResult(
130 CherryPickStatus.CONFLICTING);
131
132 /**
133 * @return the status this cherry-pick resulted in
134 */
135 public CherryPickStatus getStatus() {
136 return status;
137 }
138
139 /**
140 * @return the commit the head points at after this cherry-pick,
141 * <code>null</code> if {@link #getStatus} is not
142 * {@link CherryPickStatus#OK}
143 */
144 public RevCommit getNewHead() {
145 return newHead;
146 }
147
148 /**
149 * @return the list of successfully cherry-picked <code>Ref</code>'s,
150 * <code>null</code> if {@link #getStatus} is not
151 * {@link CherryPickStatus#OK}
152 */
153 public List<Ref> getCherryPickedRefs() {
154 return cherryPickedRefs;
155 }
156
157 /**
158 * @return the list of paths causing this cherry-pick to fail (see
159 * {@link ResolveMerger#getFailingPaths()} for details),
160 * <code>null</code> if {@link #getStatus} is not
161 * {@link CherryPickStatus#FAILED}
162 */
163 public Map<String, MergeFailureReason> getFailingPaths() {
164 return failingPaths;
165 }
166 }