View Javadoc
1   /*
2    * Copyright (C) 2009, Google Inc.
3    * Copyright (C) 2008, Marek Zawirski <marek.zawirski@gmail.com>
4    * Copyright (C) 2009, Robin Rosenberg <robin.rosenberg@dewire.com>
5    * and other copyright owners as documented in the project's IP log.
6    *
7    * This program and the accompanying materials are made available
8    * under the terms of the Eclipse Distribution License v1.0 which
9    * accompanies this distribution, is reproduced below, and is
10   * available at http://www.eclipse.org/org/documents/edl-v10.php
11   *
12   * All rights reserved.
13   *
14   * Redistribution and use in source and binary forms, with or
15   * without modification, are permitted provided that the following
16   * conditions are met:
17   *
18   * - Redistributions of source code must retain the above copyright
19   *   notice, this list of conditions and the following disclaimer.
20   *
21   * - Redistributions in binary form must reproduce the above
22   *   copyright notice, this list of conditions and the following
23   *   disclaimer in the documentation and/or other materials provided
24   *   with the distribution.
25   *
26   * - Neither the name of the Eclipse Foundation, Inc. nor the
27   *   names of its contributors may be used to endorse or promote
28   *   products derived from this software without specific prior
29   *   written permission.
30   *
31   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
32   * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
33   * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
34   * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
35   * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
36   * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
37   * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
38   * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
39   * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
40   * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
41   * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
42   * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
43   * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
44   */
45  
46  package org.eclipse.jgit.transport;
47  
48  import java.util.Collection;
49  import java.util.Collections;
50  import java.util.Map;
51  
52  /**
53   * Result of push operation to the remote repository. Holding information of
54   * {@link org.eclipse.jgit.transport.OperationResult} and remote refs updates
55   * status.
56   *
57   * @see Transport#push(org.eclipse.jgit.lib.ProgressMonitor, Collection)
58   */
59  public class PushResult extends OperationResult {
60  	private Map<String, RemoteRefUpdate> remoteUpdates = Collections.emptyMap();
61  
62  	/**
63  	 * Get status of remote refs updates. Together with
64  	 * {@link #getAdvertisedRefs()} it provides full description/status of each
65  	 * ref update.
66  	 * <p>
67  	 * Returned collection is not sorted in any order.
68  	 * </p>
69  	 *
70  	 * @return collection of remote refs updates
71  	 */
72  	public Collection<RemoteRefUpdate> getRemoteUpdates() {
73  		return Collections.unmodifiableCollection(remoteUpdates.values());
74  	}
75  
76  	/**
77  	 * Get status of specific remote ref update by remote ref name. Together
78  	 * with {@link #getAdvertisedRef(String)} it provide full description/status
79  	 * of this ref update.
80  	 *
81  	 * @param refName
82  	 *            remote ref name
83  	 * @return status of remote ref update
84  	 */
85  	public RemoteRefUpdate getRemoteUpdate(String refName) {
86  		return remoteUpdates.get(refName);
87  	}
88  
89  	void setRemoteUpdates(
90  			final Map<String, RemoteRefUpdate> remoteUpdates) {
91  		this.remoteUpdates = remoteUpdates;
92  	}
93  }