git/list[1] front-page[2] threads[3] people[4] search[5] about
 

[EGIT PATCH 06/23] Refactor: extract superclass OperationResult from FetchResult

From
MZMarek Zawirski <marek.zawirski@gmail.com>
Date
Jun 27, 2008, 22:06 UTC
Message-ID
<1214604407-30572-7-git-send-email-marek.zawirski@gmail.com>
In-Reply-To
<1214604407-30572-6-git-send-email-marek.zawirski@gmail.com>

New superclass holds information about advertised refs and updated tracking refs, which is all common to fetch and push operations.

Signed-off-by: Marek Zawirski <marek.zawirski@gmail.com>
---
 .../org/spearce/jgit/transport/FetchResult.java    |   74 +------------
 .../spearce/jgit/transport/OperationResult.java    |  119 ++++++++++++++++++++
 2 files changed, 120 insertions(+), 73 deletions(-)
 create mode 100644 org.spearce.jgit/src/org/spearce/jgit/transport/OperationResult.java
diff --git a/org.spearce.jgit/src/org/spearce/jgit/transport/FetchResult.java b/org.spearce.jgit/src/org/spearce/jgit/transport/FetchResult.java
index bd94b5f..cc8557f 100644
--- a/org.spearce.jgit/src/org/spearce/jgit/transport/FetchResult.java
+++ b/org.spearce.jgit/src/org/spearce/jgit/transport/FetchResult.java
@@ -40,94 +40,22 @@ package org.spearce.jgit.transport;
 
 import java.util.ArrayList;
 import java.util.Collection;
-import java.util.Collections;
 import java.util.List;
-import java.util.Map;
-import java.util.SortedMap;
-import java.util.TreeMap;
-
-import org.spearce.jgit.lib.Ref;
 
 /**
  * Final status after a successful fetch from a remote repository.
  * 
  * @see Transport#fetch(org.spearce.jgit.lib.ProgressMonitor, Collection)
  */
-public class FetchResult {
-	private final SortedMap<String, TrackingRefUpdate> updates;
-
+public class FetchResult extends OperationResult {
 	private final List<FetchHeadRecord> forMerge;
 
-	private Map<String, Ref> advertisedRefs;
-
 	FetchResult() {
-		updates = new TreeMap<String, TrackingRefUpdate>();
 		forMerge = new ArrayList<FetchHeadRecord>();
-		advertisedRefs = Collections.<String, Ref> emptyMap();
-	}
-
-	void add(final TrackingRefUpdate u) {
-		updates.put(u.getLocalName(), u);
 	}
 
 	void add(final FetchHeadRecord r) {
 		if (!r.notForMerge)
 			forMerge.add(r);
 	}
-
-	void setAdvertisedRefs(final Map<String, Ref> ar) {
-		advertisedRefs = ar;
-	}
-
-	/**
-	 * Get the complete list of refs advertised by the remote.
-	 * <p>
-	 * The returned refs may appear in any order. If the caller needs these to
-	 * be sorted, they should be copied into a new array or List and then sorted
-	 * by the caller as necessary.
-	 * 
-	 * @return available/advertised refs. Never null. Not modifiable. The
-	 *         collection can be empty if the remote side has no refs (it is an
-	 *         empty/newly created repository).
-	 */
-	public Collection<Ref> getAdvertisedRefs() {
-		return advertisedRefs.values();
-	}
-
-	/**
-	 * Get a single advertised ref by name.
-	 * <p>
-	 * The name supplied should be valid ref name. To get a peeled value for a
-	 * ref (aka <code>refs/tags/v1.0^{}</code>) use the base name (without
-	 * the <code>^{}</code> suffix) and look at the peeled object id.
-	 * 
-	 * @param name
-	 *            name of the ref to obtain.
-	 * @return the requested ref; null if the remote did not advertise this ref.
-	 */
-	public final Ref getAdvertisedRef(final String name) {
-		return advertisedRefs.get(name);
-	}
-
-	/**
-	 * Get the status of all local tracking refs that were updated.
-	 * 
-	 * @return unmodifiable collection of local updates. Never null. Empty if
-	 *         there were no local tracking refs updated.
-	 */
-	public Collection<TrackingRefUpdate> getTrackingRefUpdates() {
-		return Collections.unmodifiableCollection(updates.values());
-	}
-
-	/**
-	 * Get the status for a specific local tracking ref update.
-	 * 
-	 * @param localName
-	 *            name of the local ref (e.g. "refs/remotes/origin/master").
-	 * @return status of the local ref; null if this local ref was not touched
-	 *         during this fetch.
-	 */
-	public TrackingRefUpdate getTrackingRefUpdate(final String localName) {
-		return updates.get(localName);
-	}
 }
diff --git a/org.spearce.jgit/src/org/spearce/jgit/transport/OperationResult.java b/org.spearce.jgit/src/org/spearce/jgit/transport/OperationResult.java
new file mode 100644
index 0000000..9b411e1
--- /dev/null
+++ b/org.spearce.jgit/src/org/spearce/jgit/transport/OperationResult.java
@@ -0,0 +1,119 @@
+/*
+ * Copyright (C) 2007, Robin Rosenberg <robin.rosenberg@dewire.com>
+ * Copyright (C) 2008, Shawn O. Pearce <spearce@spearce.org>
+ * Copyright (C) 2008, Marek Zawirski <marek.zawirski@gmail.com>
+ *
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or
+ * without modification, are permitted provided that the following
+ * conditions are met:
+ *
+ * - Redistributions of source code must retain the above copyright
+ *   notice, this list of conditions and the following disclaimer.
+ *
+ * - Redistributions in binary form must reproduce the above
+ *   copyright notice, this list of conditions and the following
+ *   disclaimer in the documentation and/or other materials provided
+ *   with the distribution.
+ *
+ * - Neither the name of the Git Development Community nor the
+ *   names of its contributors may be used to endorse or promote
+ *   products derived from this software without specific prior
+ *   written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
+ * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
+ * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
+ * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
+ * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
+ * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+ * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+ * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
+ * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
+ * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+package org.spearce.jgit.transport;
+
+import java.util.Collection;
+import java.util.Collections;
+import java.util.Map;
+import java.util.SortedMap;
+import java.util.TreeMap;
+
+import org.spearce.jgit.lib.Ref;
+
+/**
+ * Class holding result of operation on remote repository. This includes refs
+ * advertised by remote repo and local tracking refs updates.
+ */
+public abstract class OperationResult {
+
+	protected Map<String, Ref> advertisedRefs = Collections.emptyMap();
+
+	protected final SortedMap<String, TrackingRefUpdate> updates = new TreeMap<String, TrackingRefUpdate>();
+
+	/**
+	 * Get the complete list of refs advertised by the remote.
+	 * <p>
+	 * The returned refs may appear in any order. If the caller needs these to
+	 * be sorted, they should be copied into a new array or List and then sorted
+	 * by the caller as necessary.
+	 * 
+	 * @return available/advertised refs. Never null. Not modifiable. The
+	 *         collection can be empty if the remote side has no refs (it is an
+	 *         empty/newly created repository).
+	 */
+	public Collection<Ref> getAdvertisedRefs() {
+		return Collections.unmodifiableCollection(advertisedRefs.values());
+	}
+
+	/**
+	 * Get a single advertised ref by name.
+	 * <p>
+	 * The name supplied should be valid ref name. To get a peeled value for a
+	 * ref (aka <code>refs/tags/v1.0^{}</code>) use the base name (without
+	 * the <code>^{}</code> suffix) and look at the peeled object id.
+	 * 
+	 * @param name
+	 *            name of the ref to obtain.
+	 * @return the requested ref; null if the remote did not advertise this ref.
+	 */
+	public final Ref getAdvertisedRef(final String name) {
+		return advertisedRefs.get(name);
+	}
+
+	/**
+	 * Get the status of all local tracking refs that were updated.
+	 * 
+	 * @return unmodifiable collection of local updates. Never null. Empty if
+	 *         there were no local tracking refs updated.
+	 */
+	public Collection<TrackingRefUpdate> getTrackingRefUpdates() {
+		return Collections.unmodifiableCollection(updates.values());
+	}
+
+	/**
+	 * Get the status for a specific local tracking ref update.
+	 * 
+	 * @param localName
+	 *            name of the local ref (e.g. "refs/remotes/origin/master").
+	 * @return status of the local ref; null if this local ref was not touched
+	 *         during this operation.
+	 */
+	public TrackingRefUpdate getTrackingRefUpdate(final String localName) {
+		return updates.get(localName);
+	}
+
+	protected void setAdvertisedRefs(final Map<String, Ref> ar) {
+		advertisedRefs = ar;
+	}
+
+	protected void add(final TrackingRefUpdate u) {
+		updates.put(u.getLocalName(), u);
+	}
+}
\ No newline at end of file

-- 
1.5.5.3
Previous: Marek ZawirskiNext: Marek Zawirski
Message 7 of 26 in “Push implementation”
  1. 00/23 Push implementationMarek Zawirski, Jun 27, 2008
  2. 01/23 Fix: let FetchProcess use fetch() instead of doFetch()Marek Zawirski, Jun 27, 2008
  3. 02/23 RefUpdate: new possible result Result.IO_FAILUREMarek Zawirski, Jun 27, 2008
  4. 03/23 Refactor TrackingRefUpdate to not hold RefSpecMarek Zawirski, Jun 27, 2008
  5. 04/23 New constructor without RefSpec for TrackingRefUpdateMarek Zawirski, Jun 27, 2008
  6. 05/23 Add RemoteRefUpdate classMarek Zawirski, Jun 27, 2008
  7. 06/23 Refactor: extract superclass OperationResult from FetchResultMarek Zawirski, Jun 27, 2008
  8. 07/23 Add PushResult classMarek Zawirski, Jun 27, 2008
  9. 08/23 Support for fetchThin and pushThin options in TransportMarek Zawirski, Jun 27, 2008
  10. 09/23 Big refactor: *Connection hierarchyMarek Zawirski, Jun 27, 2008
  11. 10/23 Add ignoreMissingUninteresting option to PackWriterMarek Zawirski, Jun 27, 2008
  12. 11/23 Add BasePackPushConnection implementing git-send-pack protocolMarek Zawirski, Jun 27, 2008
  13. 12/23 Fix: let RevWalk reset correctly before isMergedInto()Marek Zawirski, Jun 27, 2008
  14. 13/23 Add PushProcess class implementing git-send-pack logicMarek Zawirski, Jun 27, 2008
  15. 14/23 Clarify Repository#resolve() documentationMarek Zawirski, Jun 27, 2008
  16. 15/23 Add String versions of methods in RefSpecMarek Zawirski, Jun 27, 2008
  17. 16/23 Transport* - general support for push() and implementationsMarek Zawirski, Jun 27, 2008
  18. 17/23 Test cases for PushProcessMarek Zawirski, Jun 27, 2008
  19. 18/23 Test cases for RefSpec to RemoteRefUpdate conversionsMarek Zawirski, Jun 27, 2008
  20. 19/23 Repository search for command line toolsMarek Zawirski, Jun 27, 2008
  21. 20/23 Push command line utilityMarek Zawirski, Jun 27, 2008
  22. 21/23 Don't accept RefSpec with null source for fetchMarek Zawirski, Jun 27, 2008
  23. 22/23 Add new handy constructors to TransportException, PackProtocolExceptionMarek Zawirski, Jun 27, 2008
  24. 23/23 Use new TransportException constructorsMarek Zawirski, Jun 27, 2008
  25. Robin RosenbergJun 28, 2008
  26. Robin RosenbergJun 27, 2008

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.