diff options
author | Matthias Sohn <matthias.sohn@sap.com> | 2017-12-19 11:55:51 +0100 |
---|---|---|
committer | Matthias Sohn <matthias.sohn@sap.com> | 2017-12-20 22:10:09 +0100 |
commit | 781e106a2607665a7a47b626fd5b67fa8b491d18 (patch) | |
tree | de19ed5137ce0e3fde078566dfa98ca09e6e7c95 /org.eclipse.jgit/src/org/eclipse/jgit/transport/FetchConnection.java | |
parent | c1a02f497a945d51b205c13a71f94c539ef0079b (diff) | |
download | jgit-781e106a2607665a7a47b626fd5b67fa8b491d18.tar.gz jgit-781e106a2607665a7a47b626fd5b67fa8b491d18.zip |
Fix javadoc in org.eclipse.jgit transport package
Change-Id: Id70e2c27e38bf12f87e66b28fbd0b06908494764
Signed-off-by: Matthias Sohn <matthias.sohn@sap.com>
Diffstat (limited to 'org.eclipse.jgit/src/org/eclipse/jgit/transport/FetchConnection.java')
-rw-r--r-- | org.eclipse.jgit/src/org/eclipse/jgit/transport/FetchConnection.java | 31 |
1 files changed, 17 insertions, 14 deletions
diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/transport/FetchConnection.java b/org.eclipse.jgit/src/org/eclipse/jgit/transport/FetchConnection.java index 2d042400f6..f0c45d5fb6 100644 --- a/org.eclipse.jgit/src/org/eclipse/jgit/transport/FetchConnection.java +++ b/org.eclipse.jgit/src/org/eclipse/jgit/transport/FetchConnection.java @@ -64,9 +64,9 @@ import org.eclipse.jgit.lib.Ref; * one-way object transfer service to copy objects from the remote repository * into this local repository. * <p> - * Instances of a FetchConnection must be created by a {@link Transport} that - * implements a specific object transfer protocol that both sides of the - * connection understand. + * Instances of a FetchConnection must be created by a + * {@link org.eclipse.jgit.transport.Transport} that implements a specific + * object transfer protocol that both sides of the connection understand. * <p> * FetchConnection instances are not thread safe and may be accessed by only one * thread at a time. @@ -78,7 +78,7 @@ public interface FetchConnection extends Connection { * Fetch objects we don't have but that are reachable from advertised refs. * <p> * Only one call per connection is allowed. Subsequent calls will result in - * {@link TransportException}. + * {@link org.eclipse.jgit.errors.TransportException}. * </p> * <p> * Implementations are free to use network connections as necessary to @@ -87,7 +87,8 @@ public interface FetchConnection extends Connection { * avoid replacing/overwriting/duplicating an object already available in * the local destination repository. Locally available objects and packs * should always be preferred over remotely available objects and packs. - * {@link Transport#isFetchThin()} should be honored if applicable. + * {@link org.eclipse.jgit.transport.Transport#isFetchThin()} should be + * honored if applicable. * </p> * * @param monitor @@ -103,7 +104,7 @@ public interface FetchConnection extends Connection { * repository, especially if they aren't yet reachable by the ref * database. Connections should take this set as an addition to * what is reachable through all Refs, not in replace of it. - * @throws TransportException + * @throws org.eclipse.jgit.errors.TransportException * objects could not be copied due to a network failure, * protocol error, or error on remote side, or connection was * already used for fetch. @@ -116,7 +117,7 @@ public interface FetchConnection extends Connection { * Fetch objects we don't have but that are reachable from advertised refs. * <p> * Only one call per connection is allowed. Subsequent calls will result in - * {@link TransportException}. + * {@link org.eclipse.jgit.errors.TransportException}. * </p> * <p> * Implementations are free to use network connections as necessary to @@ -125,7 +126,8 @@ public interface FetchConnection extends Connection { * avoid replacing/overwriting/duplicating an object already available in * the local destination repository. Locally available objects and packs * should always be preferred over remotely available objects and packs. - * {@link Transport#isFetchThin()} should be honored if applicable. + * {@link org.eclipse.jgit.transport.Transport#isFetchThin()} should be + * honored if applicable. * </p> * * @param monitor @@ -143,7 +145,7 @@ public interface FetchConnection extends Connection { * what is reachable through all Refs, not in replace of it. * @param out * OutputStream to write sideband messages to - * @throws TransportException + * @throws org.eclipse.jgit.errors.TransportException * objects could not be copied due to a network failure, * protocol error, or error on remote side, or connection was * already used for fetch. @@ -157,11 +159,12 @@ public interface FetchConnection extends Connection { * Did the last {@link #fetch(ProgressMonitor, Collection, Set)} get tags? * <p> * Some Git aware transports are able to implicitly grab an annotated tag if - * {@link TagOpt#AUTO_FOLLOW} or {@link TagOpt#FETCH_TAGS} was selected and - * the object the tag peels to (references) was transferred as part of the - * last {@link #fetch(ProgressMonitor, Collection, Set)} call. If it is - * possible for such tags to have been included in the transfer this method - * returns true, allowing the caller to attempt tag discovery. + * {@link org.eclipse.jgit.transport.TagOpt#AUTO_FOLLOW} or + * {@link org.eclipse.jgit.transport.TagOpt#FETCH_TAGS} was selected and the + * object the tag peels to (references) was transferred as part of the last + * {@link #fetch(ProgressMonitor, Collection, Set)} call. If it is possible + * for such tags to have been included in the transfer this method returns + * true, allowing the caller to attempt tag discovery. * <p> * By returning only true/false (and not the actual list of tags obtained) * the transport itself does not need to be aware of whether or not tags |