View Javadoc
1   /*
2    * Copyright (C) 2010, Mathias Kinzler <mathias.kinzler@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 org.eclipse.jgit.transport.FetchResult;
46  
47  /**
48   * Encapsulates the result of a {@link org.eclipse.jgit.api.PullCommand}
49   */
50  public class PullResult {
51  	private final FetchResult fetchResult;
52  
53  	private final MergeResult mergeResult;
54  
55  	private final RebaseResult rebaseResult;
56  
57  	private final String fetchedFrom;
58  
59  	PullResult(FetchResult fetchResult, String fetchedFrom,
60  			MergeResult mergeResult) {
61  		this.fetchResult = fetchResult;
62  		this.fetchedFrom = fetchedFrom;
63  		this.mergeResult = mergeResult;
64  		this.rebaseResult = null;
65  	}
66  
67  	PullResult(FetchResult fetchResult, String fetchedFrom,
68  			RebaseResult rebaseResult) {
69  		this.fetchResult = fetchResult;
70  		this.fetchedFrom = fetchedFrom;
71  		this.mergeResult = null;
72  		this.rebaseResult = rebaseResult;
73  	}
74  
75  	/**
76  	 * Get fetch result
77  	 *
78  	 * @return the fetch result, or <code>null</code>
79  	 */
80  	public FetchResult getFetchResult() {
81  		return this.fetchResult;
82  	}
83  
84  	/**
85  	 * Get merge result
86  	 *
87  	 * @return the merge result, or <code>null</code>
88  	 */
89  	public MergeResult getMergeResult() {
90  		return this.mergeResult;
91  	}
92  
93  	/**
94  	 * Get rebase result
95  	 *
96  	 * @return the rebase result, or <code>null</code>
97  	 */
98  	public RebaseResult getRebaseResult() {
99  		return this.rebaseResult;
100 	}
101 
102 	/**
103 	 * Get name of the remote configuration from which fetch was tried
104 	 *
105 	 * @return the name of the remote configuration from which fetch was tried,
106 	 *         or <code>null</code>
107 	 */
108 	public String getFetchedFrom() {
109 		return this.fetchedFrom;
110 	}
111 
112 	/**
113 	 * Whether the pull was successful
114 	 *
115 	 * @return whether the pull was successful
116 	 */
117 	public boolean isSuccessful() {
118 		if (mergeResult != null)
119 			return mergeResult.getMergeStatus().isSuccessful();
120 		else if (rebaseResult != null)
121 			return rebaseResult.getStatus().isSuccessful();
122 		return true;
123 	}
124 
125 	/** {@inheritDoc} */
126 	@SuppressWarnings("nls")
127 	@Override
128 	public String toString() {
129 		StringBuilder sb = new StringBuilder();
130 		if (fetchResult != null)
131 			sb.append(fetchResult.toString());
132 		else
133 			sb.append("No fetch result");
134 		sb.append("\n");
135 		if (mergeResult != null)
136 			sb.append(mergeResult.toString());
137 		else if (rebaseResult != null)
138 			sb.append(rebaseResult.toString());
139 		else
140 			sb.append("No update result");
141 		return sb.toString();
142 	}
143 }