org.spearce.jgit/src/org/spearce/jgit/transport/FetchResult.java

   1 /*
   2  * Copyright (C) 2007, Robin Rosenberg <robin.rosenberg@dewire.com>
   3  * Copyright (C) 2008, Shawn O. Pearce <spearce@spearce.org>
   4  *
   5  * All rights reserved.
   6  *
   7  * Redistribution and use in source and binary forms, with or
   8  * without modification, are permitted provided that the following
   9  * conditions are met:
  10  *
  11  * - Redistributions of source code must retain the above copyright
  12  *   notice, this list of conditions and the following disclaimer.
  13  *
  14  * - Redistributions in binary form must reproduce the above
  15  *   copyright notice, this list of conditions and the following
  16  *   disclaimer in the documentation and/or other materials provided
  17  *   with the distribution.
  18  *
  19  * - Neither the name of the Git Development Community nor the
  20  *   names of its contributors may be used to endorse or promote
  21  *   products derived from this software without specific prior
  22  *   written permission.
  23  *
  24  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
  25  * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
  26  * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  27  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  28  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
  29  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  30  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  31  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  32  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  33  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  34  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  35  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
  36  * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  37  */
  38
  39 package org.spearce.jgit.transport;
  40
  41 import java.util.ArrayList;
  42 import java.util.Collection;
  43 import java.util.Collections;
  44 import java.util.List;
  45 import java.util.Map;
  46 import java.util.SortedMap;
  47 import java.util.TreeMap;
  48
  49 import org.spearce.jgit.lib.Ref;
  50
  51 /**
  52  * Final status after a successful fetch from a remote repository.
  53  *
  54  * @see Transport#fetch(org.spearce.jgit.lib.ProgressMonitor, Collection)
  55  */
  56 public class FetchResult {
  57         private final SortedMap<String, TrackingRefUpdate> updates;
  58
  59         private final List<FetchHeadRecord> forMerge;
  60
  61         private Map<String, Ref> advertisedRefs;
  62
  63         FetchResult() {
  64                 updates = new TreeMap<String, TrackingRefUpdate>();
  65                 forMerge = new ArrayList<FetchHeadRecord>();
  66                 advertisedRefs = Collections.<String, Ref> emptyMap();
  67         }
  68
  69         void add(final TrackingRefUpdate u) {
  70                 updates.put(u.getLocalName(), u);
  71         }
  72
  73         void add(final FetchHeadRecord r) {
  74                 if (!r.notForMerge)
  75                         forMerge.add(r);
  76         }
  77
  78         void setAdvertisedRefs(final Map<String, Ref> ar) {
  79                 advertisedRefs = ar;
  80         }
  81
  82         /**
  83          * Get the complete list of refs advertised by the remote.
  84          * <p>
  85          * The returned refs may appear in any order. If the caller needs these to
  86          * be sorted, they should be copied into a new array or List and then sorted
  87          * by the caller as necessary.
  88          *
  89          * @return available/advertised refs. Never null. Not modifiable. The
  90          *         collection can be empty if the remote side has no refs (it is an
  91          *         empty/newly created repository).
  92          */
  93         public Collection<Ref> getAdvertisedRefs() {
  94                 return advertisedRefs.values();
  95         }
  96
  97         /**
  98          * Get a single advertised ref by name.
  99          * <p>
 100          * The name supplied should be valid ref name. To get a peeled value for a
 101          * ref (aka <code>refs/tags/v1.0^{}</code>) use the base name (without
 102          * the <code>^{}</code> suffix) and look at the peeled object id.
 103          *
 104          * @param name
 105          *            name of the ref to obtain.
 106          * @return the requested ref; null if the remote did not advertise this ref.
 107          */
 108         public final Ref getAdvertisedRef(final String name) {
 109                 return advertisedRefs.get(name);
 110         }
 111
 112         /**
 113          * Get the status of all local tracking refs that were updated.
 114          *
 115          * @return unmodifiable collection of local updates. Never null. Empty if
 116          *         there were no local tracking refs updated.
 117          */
 118         public Collection<TrackingRefUpdate> getTrackingRefUpdates() {
 119                 return Collections.unmodifiableCollection(updates.values());
 120         }
 121
 122         /**
 123          * Get the status for a specific local tracking ref update.
 124          *
 125          * @param localName
 126          *            name of the local ref (e.g. "refs/remotes/origin/master").
 127          * @return status of the local ref; null if this local ref was not touched
 128          *         during this fetch.
 129          */
 130         public TrackingRefUpdate getTrackingRefUpdate(final String localName) {
 131                 return updates.get(localName);
 132         }
 133 }