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

   1 /*
   2  * Copyright (C) 2008, Shawn O. Pearce <spearce@spearce.org>
   3  *
   4  * All rights reserved.
   5  *
   6  * Redistribution and use in source and binary forms, with or
   7  * without modification, are permitted provided that the following
   8  * conditions are met:
   9  *
  10  * - Redistributions of source code must retain the above copyright
  11  *   notice, this list of conditions and the following disclaimer.
  12  *
  13  * - Redistributions in binary form must reproduce the above
  14  *   copyright notice, this list of conditions and the following
  15  *   disclaimer in the documentation and/or other materials provided
  16  *   with the distribution.
  17  *
  18  * - Neither the name of the Git Development Community nor the
  19  *   names of its contributors may be used to endorse or promote
  20  *   products derived from this software without specific prior
  21  *   written permission.
  22  *
  23  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
  24  * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
  25  * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  26  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  27  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
  28  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  29  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  30  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  31  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  32  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  33  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  34  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
  35  * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  36  */
  37
  38 package org.spearce.jgit.transport;
  39
  40 import java.util.Collection;
  41 import java.util.Set;
  42
  43 import org.spearce.jgit.errors.TransportException;
  44 import org.spearce.jgit.lib.ObjectId;
  45 import org.spearce.jgit.lib.ProgressMonitor;
  46 import org.spearce.jgit.lib.Ref;
  47
  48 /**
  49  * Base helper class for fetch connection implementations. Provides some common
  50  * typical structures and methods used during fetch connection.
  51  * <p>
  52  * Implementors of fetch over pack-based protocols should consider using
  53  * {@link BasePackFetchConnection} instead.
  54  * </p>
  55  */
  56 abstract class BaseFetchConnection extends BaseConnection implements
  57                 FetchConnection {
  58         public final void fetch(final ProgressMonitor monitor,
  59                         final Collection<Ref> want, final Set<ObjectId> have)
  60                         throws TransportException {
  61                 markStartedOperation();
  62                 doFetch(monitor, want, have);
  63         }
  64
  65         /**
  66          * Default implementation of {@link FetchConnection#didFetchIncludeTags()} -
  67          * returning false.
  68          */
  69         public boolean didFetchIncludeTags() {
  70                 return false;
  71         }
  72
  73         /**
  74          * Implementation of {@link #fetch(ProgressMonitor, Collection, Set)}
  75          * without checking for multiple fetch.
  76          *
  77          * @param monitor
  78          *            as in {@link #fetch(ProgressMonitor, Collection, Set)}
  79          * @param want
  80          *            as in {@link #fetch(ProgressMonitor, Collection, Set)}
  81          * @param have
  82          *            as in {@link #fetch(ProgressMonitor, Collection, Set)}
  83          * @throws TransportException
  84          *             as in {@link #fetch(ProgressMonitor, Collection, Set)}, but
  85          *             implementation doesn't have to care about multiple
  86          *             {@link #fetch(ProgressMonitor, Collection, Set)} calls, as it
  87          *             is checked in this class.
  88          */
  89         protected abstract void doFetch(final ProgressMonitor monitor,
  90                         final Collection<Ref> want, final Set<ObjectId> have)
  91                         throws TransportException;
  92 }