diff options
Diffstat (limited to 'org.eclipse.jgit/src/org/eclipse/jgit/transport')
20 files changed, 304 insertions, 42 deletions
diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/transport/CapabilitiesV2Request.java b/org.eclipse.jgit/src/org/eclipse/jgit/transport/CapabilitiesV2Request.java index 9c5a54e9cb..27afdc29be 100644 --- a/org.eclipse.jgit/src/org/eclipse/jgit/transport/CapabilitiesV2Request.java +++ b/org.eclipse.jgit/src/org/eclipse/jgit/transport/CapabilitiesV2Request.java @@ -21,7 +21,11 @@ public final class CapabilitiesV2Request { private CapabilitiesV2Request() { } - /** @return A builder of {@link CapabilitiesV2Request}. */ + /** + * Create builder + * + * @return A builder of {@link CapabilitiesV2Request}. + */ public static Builder builder() { return new Builder(); } @@ -31,7 +35,11 @@ public final class CapabilitiesV2Request { private Builder() { } - /** @return CapabilitiesV2Request */ + /** + * Build the request + * + * @return CapabilitiesV2Request + */ public CapabilitiesV2Request build() { return new CapabilitiesV2Request(); } diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/transport/ConnectivityChecker.java b/org.eclipse.jgit/src/org/eclipse/jgit/transport/ConnectivityChecker.java index dcffe48be8..cbb3420db2 100644 --- a/org.eclipse.jgit/src/org/eclipse/jgit/transport/ConnectivityChecker.java +++ b/org.eclipse.jgit/src/org/eclipse/jgit/transport/ConnectivityChecker.java @@ -60,6 +60,8 @@ public interface ConnectivityChecker { private RevWalk walk; /** + * Get database we write the stored objects into + * * @return database we write the stored objects into. */ public Repository getRepository() { @@ -67,6 +69,8 @@ public interface ConnectivityChecker { } /** + * Set database we write the stored objects into + * * @param repository * set database we write the stored objects into. */ @@ -75,6 +79,8 @@ public interface ConnectivityChecker { } /** + * Get the parser used to parse pack + * * @return the parser used to parse pack. */ public PackParser getParser() { @@ -82,6 +88,8 @@ public interface ConnectivityChecker { } /** + * Set the parser + * * @param parser * the parser to set */ @@ -90,6 +98,8 @@ public interface ConnectivityChecker { } /** + * Whether checker should check objects + * * @return if checker should check objects. */ public boolean isCheckObjects() { @@ -97,6 +107,8 @@ public interface ConnectivityChecker { } /** + * Set whether objects should be checked + * * @param checkObjects * set if checker should check referenced objects outside of * the received pack are reachable. @@ -106,21 +118,27 @@ public interface ConnectivityChecker { } /** - * @return command received by the current request. + * Get commands received by the current request + * + * @return commands received by the current request. */ public List<ReceiveCommand> getCommands() { return commands; } /** + * Set commands received by the current request + * * @param commands - * set command received by the current request. + * commands received by the current request. */ public void setCommands(List<ReceiveCommand> commands) { this.commands = commands; } /** + * Set the walk to parse commits + * * @param walk * the walk to parse commits */ @@ -129,6 +147,8 @@ public interface ConnectivityChecker { } /** + * Get the walk to parse commits + * * @return the walk to parse commits */ public RevWalk getWalk() { diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/transport/CredentialItem.java b/org.eclipse.jgit/src/org/eclipse/jgit/transport/CredentialItem.java index 78c5c6374f..32852890c0 100644 --- a/org.eclipse.jgit/src/org/eclipse/jgit/transport/CredentialItem.java +++ b/org.eclipse.jgit/src/org/eclipse/jgit/transport/CredentialItem.java @@ -109,12 +109,18 @@ public abstract class CredentialItem { value = null; } - /** @return the current value */ + /** + * Get value + * + * @return the current value + */ public String getValue() { return value; } /** + * Set value + * * @param newValue * the new value */ @@ -214,7 +220,11 @@ public abstract class CredentialItem { value = false; } - /** @return the current value */ + /** + * Get value + * + * @return the current value + */ public boolean getValue() { return value; } diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/transport/FetchRequest.java b/org.eclipse.jgit/src/org/eclipse/jgit/transport/FetchRequest.java index 009a70b7b3..91eed96d4e 100644 --- a/org.eclipse.jgit/src/org/eclipse/jgit/transport/FetchRequest.java +++ b/org.eclipse.jgit/src/org/eclipse/jgit/transport/FetchRequest.java @@ -85,6 +85,8 @@ abstract class FetchRequest { } /** + * Get object ids in the "want" lines + * * @return object ids in the "want" (and "want-ref") lines of the request */ @NonNull @@ -93,6 +95,8 @@ abstract class FetchRequest { } /** + * Get the depth set in a "deepen" line + * * @return the depth set in a "deepen" line. 0 by default. */ int getDepth() { @@ -112,6 +116,8 @@ abstract class FetchRequest { } /** + * Get the filter spec given in a "filter" line + * * @return the filter spec given in a "filter" line */ @NonNull @@ -152,6 +158,8 @@ abstract class FetchRequest { } /** + * Get refs received in "deepen-not" lines + * * @return refs received in "deepen-not" lines. */ @NonNull @@ -160,6 +168,8 @@ abstract class FetchRequest { } /** + * Get string identifying the agent + * * @return string identifying the agent (as sent in the request body by the * client) */ @@ -169,8 +179,10 @@ abstract class FetchRequest { } /** - * @return string identifying the client session ID (as sent in the request body by the - * client) + * Get string identifying the client session ID + * + * @return string identifying the client session ID (as sent in the request + * body by the client) */ @Nullable String getClientSID() { diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/transport/FetchV0Request.java b/org.eclipse.jgit/src/org/eclipse/jgit/transport/FetchV0Request.java index ca3639d03c..53b3e19263 100644 --- a/org.eclipse.jgit/src/org/eclipse/jgit/transport/FetchV0Request.java +++ b/org.eclipse.jgit/src/org/eclipse/jgit/transport/FetchV0Request.java @@ -58,6 +58,8 @@ final class FetchV0Request extends FetchRequest { String clientSID; /** + * Add wantId + * * @param objectId * object id received in a "want" line * @return this builder @@ -68,6 +70,8 @@ final class FetchV0Request extends FetchRequest { } /** + * Set depth + * * @param d * depth set in a "deepen" line * @return this builder @@ -78,6 +82,8 @@ final class FetchV0Request extends FetchRequest { } /** + * Get depth + * * @return depth set in the request (via a "deepen" line). Defaulting to * 0 if not set. */ @@ -86,6 +92,8 @@ final class FetchV0Request extends FetchRequest { } /** + * Whether there's at least one "deepen not" line + * * @return true if there has been at least one "deepen not" line in the * request so far */ @@ -94,6 +102,8 @@ final class FetchV0Request extends FetchRequest { } /** + * Add "deepen not" + * * @param deepenNot * reference received in a "deepen not" line * @return this builder @@ -104,6 +114,8 @@ final class FetchV0Request extends FetchRequest { } /** + * Set "deepen since" + * * @param value * Unix timestamp received in a "deepen since" line * @return this builder @@ -114,6 +126,8 @@ final class FetchV0Request extends FetchRequest { } /** + * Get "deepen since + * * @return shallow since value, sent before in a "deepen since" line. 0 * by default. */ @@ -122,6 +136,8 @@ final class FetchV0Request extends FetchRequest { } /** + * Add client shallow commit + * * @param shallowOid * object id received in a "shallow" line * @return this builder @@ -132,6 +148,8 @@ final class FetchV0Request extends FetchRequest { } /** + * Add client capabilities + * * @param clientCapabilities * client capabilities sent by the client in the first want * line of the request @@ -143,6 +161,8 @@ final class FetchV0Request extends FetchRequest { } /** + * Set agent + * * @param clientAgent * agent line sent by the client in the request body * @return this builder @@ -153,6 +173,8 @@ final class FetchV0Request extends FetchRequest { } /** + * Set client session id + * * @param clientSID * session-id line sent by the client in the request body * @return this builder @@ -163,6 +185,8 @@ final class FetchV0Request extends FetchRequest { } /** + * Set filter spec + * * @param filter * the filter set in a filter line * @return this builder diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/transport/FetchV2Request.java b/org.eclipse.jgit/src/org/eclipse/jgit/transport/FetchV2Request.java index 3d4f38131c..21284db2c1 100644 --- a/org.eclipse.jgit/src/org/eclipse/jgit/transport/FetchV2Request.java +++ b/org.eclipse.jgit/src/org/eclipse/jgit/transport/FetchV2Request.java @@ -70,6 +70,8 @@ public final class FetchV2Request extends FetchRequest { } /** + * Get object ids received in the "have" lines + * * @return object ids received in the "have" lines */ @NonNull @@ -78,6 +80,8 @@ public final class FetchV2Request extends FetchRequest { } /** + * Get list of references received in "want-ref" lines + * * @return list of references received in "want-ref" lines * * @since 5.4 @@ -88,6 +92,8 @@ public final class FetchV2Request extends FetchRequest { } /** + * Whether the request had a "done" line + * * @return true if the request had a "done" line */ boolean wasDoneReceived() { @@ -95,6 +101,8 @@ public final class FetchV2Request extends FetchRequest { } /** + * Whether the request had a "wait-for-done" line + * * @return true if the request had a "wait-for-done" line */ boolean wasWaitForDoneReceived() { @@ -115,6 +123,8 @@ public final class FetchV2Request extends FetchRequest { } /** + * Whether "sideband-all" was received + * * @return true if "sideband-all" was received */ boolean getSidebandAll() { @@ -126,7 +136,11 @@ public final class FetchV2Request extends FetchRequest { return packfileUriProtocols; } - /** @return A builder of {@link FetchV2Request}. */ + /** + * Get builder + * + * @return A builder of {@link FetchV2Request}. + */ static Builder builder() { return new Builder(); } @@ -171,6 +185,8 @@ public final class FetchV2Request extends FetchRequest { } /** + * Add object the peer has + * * @param objectId * object id received in a "have" line * @return this builder @@ -181,7 +197,7 @@ public final class FetchV2Request extends FetchRequest { } /** - * Ref received in "want-ref" line and the object-id it refers to + * Add Ref received in "want-ref" line and the object-id it refers to * * @param refName * reference name @@ -193,6 +209,8 @@ public final class FetchV2Request extends FetchRequest { } /** + * Add client capability + * * @param clientCapability * capability line sent by the client * @return this builder @@ -203,6 +221,8 @@ public final class FetchV2Request extends FetchRequest { } /** + * Add object received in "want" line + * * @param wantId * object id received in a "want" line * @return this builder @@ -213,6 +233,8 @@ public final class FetchV2Request extends FetchRequest { } /** + * Add Object received in a "shallow" line + * * @param shallowOid * object id received in a "shallow" line * @return this builder @@ -223,6 +245,8 @@ public final class FetchV2Request extends FetchRequest { } /** + * Set depth received in "deepen" line + * * @param d * Depth received in a "deepen" line * @return this builder @@ -233,6 +257,8 @@ public final class FetchV2Request extends FetchRequest { } /** + * Get depth set in request + * * @return depth set in the request (via a "deepen" line). Defaulting to * 0 if not set. */ @@ -241,6 +267,8 @@ public final class FetchV2Request extends FetchRequest { } /** + * Whether there has been at least one ""deepen not" line + * * @return true if there has been at least one "deepen not" line in the * request so far */ @@ -249,6 +277,8 @@ public final class FetchV2Request extends FetchRequest { } /** + * Add reference received in a "deepen not" line + * * @param deepenNot * reference received in a "deepen not" line * @return this builder @@ -259,6 +289,8 @@ public final class FetchV2Request extends FetchRequest { } /** + * Set Unix timestamp received in a "deepen since" line + * * @param value * Unix timestamp received in a "deepen since" line * @return this builder @@ -269,6 +301,8 @@ public final class FetchV2Request extends FetchRequest { } /** + * Get shallow since value + * * @return shallow since value, sent before in a "deepen since" line. 0 * by default. */ @@ -277,6 +311,8 @@ public final class FetchV2Request extends FetchRequest { } /** + * Set filter spec + * * @param filter * spec set in a "filter" line * @return this builder @@ -321,6 +357,8 @@ public final class FetchV2Request extends FetchRequest { } /** + * Set value of client-supplied session capability + * * @param clientSIDValue * the client-supplied session capability, without the * leading "session-id=" @@ -347,7 +385,10 @@ public final class FetchV2Request extends FetchRequest { } /** - * @param value true if client sent "sideband-all" + * Set whether client sent "sideband-all + * + * @param value + * true if client sent "sideband-all" * @return this builder */ Builder setSidebandAll(boolean value) { @@ -361,6 +402,8 @@ public final class FetchV2Request extends FetchRequest { } /** + * Build initialized fetch request + * * @return Initialized fetch request */ FetchV2Request build() { diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/transport/FilterSpec.java b/org.eclipse.jgit/src/org/eclipse/jgit/transport/FilterSpec.java index 12a7dd3af4..442b963440 100644 --- a/org.eclipse.jgit/src/org/eclipse/jgit/transport/FilterSpec.java +++ b/org.eclipse.jgit/src/org/eclipse/jgit/transport/FilterSpec.java @@ -137,6 +137,8 @@ public final class FilterSpec { } /** + * Specify permitted object types + * * @param types * set of permitted object types, for use in "blob:none" and * "object:none" filters @@ -147,6 +149,8 @@ public final class FilterSpec { } /** + * Specify blob limit + * * @param blobLimit * the blob limit in a "blob:[limit]" filter line * @return a filter spec which filters blobs above a certain size @@ -160,6 +164,8 @@ public final class FilterSpec { } /** + * Specify tree depth limit + * * @param treeDepthLimit * the tree depth limit in a "tree:[depth]" filter line * @return a filter spec which filters blobs and trees beyond a certain tree @@ -179,6 +185,8 @@ public final class FilterSpec { public static final FilterSpec NO_FILTER = new FilterSpec(ObjectTypes.ALL, -1, -1); /** + * Whether object type is allowed + * * @param type * a Git object type, such as * {@link org.eclipse.jgit.lib.Constants#OBJ_BLOB} @@ -191,6 +199,8 @@ public final class FilterSpec { } /** + * Get blob size limit + * * @return -1 if this filter does not filter blobs based on size, or a * non-negative integer representing the max size of blobs to allow */ @@ -199,6 +209,8 @@ public final class FilterSpec { } /** + * Get tree depth limit + * * @return -1 if this filter does not filter blobs and trees based on depth, * or a non-negative integer representing the max tree depth of * blobs and trees to fetch @@ -208,6 +220,8 @@ public final class FilterSpec { } /** + * Whether this filter is a no-op + * * @return true if this filter doesn't filter out anything */ public boolean isNoOp() { @@ -215,7 +229,10 @@ public final class FilterSpec { } /** - * @return the filter line which describes this spec, e.g. "filter blob:limit=42" + * Get filter line describing this spec + * + * @return the filter line which describes this spec, e.g. "filter + * blob:limit=42" */ @Nullable public String filterLine() { diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/transport/FtpChannel.java b/org.eclipse.jgit/src/org/eclipse/jgit/transport/FtpChannel.java index 6d5b5e61ec..5d334e67f7 100644 --- a/org.eclipse.jgit/src/org/eclipse/jgit/transport/FtpChannel.java +++ b/org.eclipse.jgit/src/org/eclipse/jgit/transport/FtpChannel.java @@ -81,6 +81,8 @@ public interface FtpChannel { void disconnect(); /** + * Whether the FtpChannel is connected + * * @return whether the {@link FtpChannel} is connected */ boolean isConnected(); @@ -96,6 +98,8 @@ public interface FtpChannel { void cd(String path) throws IOException; /** + * Get current remote directory path + * * @return the current remote directory path * @throws IOException * if an IO error occurred diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/transport/LsRefsV2Request.java b/org.eclipse.jgit/src/org/eclipse/jgit/transport/LsRefsV2Request.java index b2799e1362..008f1d9b20 100644 --- a/org.eclipse.jgit/src/org/eclipse/jgit/transport/LsRefsV2Request.java +++ b/org.eclipse.jgit/src/org/eclipse/jgit/transport/LsRefsV2Request.java @@ -53,22 +53,36 @@ public final class LsRefsV2Request { this.clientSID = clientSID; } - /** @return ref prefixes that the client requested. */ + /** + * Get ref prefixes + * + * @return ref prefixes that the client requested. + */ public List<String> getRefPrefixes() { return refPrefixes; } - /** @return true if the client requests symbolic references. */ + /** + * Whether the client requests symbolic references + * + * @return true if the client requests symbolic references. + */ public boolean getSymrefs() { return symrefs; } - /** @return true if the client requests tags to be peeled. */ + /** + * Whether the client requests tags to be peeled + * + * @return true if the client requests tags to be peeled. + */ public boolean getPeel() { return peel; } /** + * Get agent reported by the client + * * @return agent as reported by the client * * @since 5.2 @@ -79,6 +93,8 @@ public final class LsRefsV2Request { } /** + * Get session-id reported by the client + * * @return session-id as reported by the client * * @since 6.4 @@ -106,7 +122,11 @@ public final class LsRefsV2Request { return serverOptions; } - /** @return A builder of {@link LsRefsV2Request}. */ + /** + * Create builder + * + * @return A builder of {@link LsRefsV2Request}. + */ public static Builder builder() { return new Builder(); } @@ -129,6 +149,8 @@ public final class LsRefsV2Request { } /** + * Set ref prefixes + * * @param value * ref prefix values * @return the Builder @@ -139,6 +161,8 @@ public final class LsRefsV2Request { } /** + * Set symrefs + * * @param value * of symrefs * @return the Builder @@ -149,6 +173,8 @@ public final class LsRefsV2Request { } /** + * Set whether to peel tags + * * @param value * of peel * @return the Builder diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/transport/ObjectInfoRequest.java b/org.eclipse.jgit/src/org/eclipse/jgit/transport/ObjectInfoRequest.java index 2a52d7fd7f..241f1e749f 100644 --- a/org.eclipse.jgit/src/org/eclipse/jgit/transport/ObjectInfoRequest.java +++ b/org.eclipse.jgit/src/org/eclipse/jgit/transport/ObjectInfoRequest.java @@ -34,12 +34,20 @@ public final class ObjectInfoRequest { this.objectIDs = objectIDs; } - /** @return object IDs that the client requested. */ + /** + * Get object ids requested by the client + * + * @return object IDs that the client requested. + */ public List<ObjectId> getObjectIDs() { return this.objectIDs; } - /** @return A builder of {@link ObjectInfoRequest}. */ + /** + * Create builder + * + * @return A builder of {@link ObjectInfoRequest}. + */ public static Builder builder() { return new Builder(); } @@ -52,6 +60,8 @@ public final class ObjectInfoRequest { } /** + * Set object ids + * * @param value * of objectIds * @return the Builder diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/transport/PackParser.java b/org.eclipse.jgit/src/org/eclipse/jgit/transport/PackParser.java index fe9ddabf8e..c6bf77db24 100644 --- a/org.eclipse.jgit/src/org/eclipse/jgit/transport/PackParser.java +++ b/org.eclipse.jgit/src/org/eclipse/jgit/transport/PackParser.java @@ -1668,17 +1668,27 @@ public abstract class PackParser { long sizeBeforeInflating; - /** @return offset within the input stream. */ + /** + * Get offset within the input stream + * + * @return offset within the input stream. + */ public long getOffset() { return position; } - /** @return the CRC-32 checksum of the stored delta data. */ + /** + * Get the CRC-32 checksum of the stored delta data + * + * @return the CRC-32 checksum of the stored delta data. + */ public int getCRC() { return crc; } /** + * Set the CRC-32 checksum of the stored delta data + * * @param crc32 * the CRC-32 checksum of the stored delta data. */ diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/transport/PackedObjectInfo.java b/org.eclipse.jgit/src/org/eclipse/jgit/transport/PackedObjectInfo.java index d7ef4f8f0a..fae26cda95 100644 --- a/org.eclipse.jgit/src/org/eclipse/jgit/transport/PackedObjectInfo.java +++ b/org.eclipse.jgit/src/org/eclipse/jgit/transport/PackedObjectInfo.java @@ -148,6 +148,8 @@ public class PackedObjectInfo extends ObjectIdOwnerMap.Entry { } /** + * Get full size (inflated, undeltified) + * * @return size of the object (inflated, undeltified) * * @since 6.4 diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/transport/PacketLineOut.java b/org.eclipse.jgit/src/org/eclipse/jgit/transport/PacketLineOut.java index 77f0a7a516..43b742b02d 100644 --- a/org.eclipse.jgit/src/org/eclipse/jgit/transport/PacketLineOut.java +++ b/org.eclipse.jgit/src/org/eclipse/jgit/transport/PacketLineOut.java @@ -85,8 +85,10 @@ public class PacketLineOut { } /** + * Whether is using sideband + * * @return whether to add a sideband designator to each non-flush and - * non-delim packet + * non-delim packet * @see #setUsingSideband * @since 5.5 */ @@ -95,11 +97,14 @@ public class PacketLineOut { } /** - * @param value If true, when writing packet lines, add, as the first - * byte, a sideband designator to each non-flush and non-delim - * packet. See pack-protocol.txt and protocol-v2.txt from the Git - * project for more information, specifically the "side-band" and - * "sideband-all" sections. + * Set whether to use sideband + * + * @param value + * If true, when writing packet lines, add, as the first byte, a + * sideband designator to each non-flush and non-delim packet. + * See pack-protocol.txt and protocol-v2.txt from the Git project + * for more information, specifically the "side-band" and + * "sideband-all" sections. * @since 5.5 */ public void setUsingSideband(boolean value) { diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/transport/ProtocolV2Hook.java b/org.eclipse.jgit/src/org/eclipse/jgit/transport/ProtocolV2Hook.java index d7626df3fa..2caecbe843 100644 --- a/org.eclipse.jgit/src/org/eclipse/jgit/transport/ProtocolV2Hook.java +++ b/org.eclipse.jgit/src/org/eclipse/jgit/transport/ProtocolV2Hook.java @@ -24,6 +24,8 @@ public interface ProtocolV2Hook { }; /** + * Handle capabilities request + * * @param req * the capabilities request * @throws ServiceMayNotContinueException @@ -36,6 +38,8 @@ public interface ProtocolV2Hook { } /** + * Handle ls-refs request + * * @param req * the ls-refs request * @throws ServiceMayNotContinueException @@ -48,8 +52,12 @@ public interface ProtocolV2Hook { } /** - * @param req the fetch request - * @throws ServiceMayNotContinueException abort; the message will be sent to the user + * Handle fetch request + * + * @param req + * the fetch request + * @throws ServiceMayNotContinueException + * abort; the message will be sent to the user */ default void onFetch(FetchV2Request req) throws ServiceMayNotContinueException { @@ -57,6 +65,8 @@ public interface ProtocolV2Hook { } /** + * Handle object-info request + * * @param req * the object-info request * @throws ServiceMayNotContinueException diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/transport/ReceivePack.java b/org.eclipse.jgit/src/org/eclipse/jgit/transport/ReceivePack.java index 9a61774334..ddde6038e9 100644 --- a/org.eclipse.jgit/src/org/eclipse/jgit/transport/ReceivePack.java +++ b/org.eclipse.jgit/src/org/eclipse/jgit/transport/ReceivePack.java @@ -108,12 +108,20 @@ public class ReceivePack { command = FirstCommand.fromLine(line); } - /** @return non-capabilities part of the line. */ + /** + * Get non-capabilities part of the line + * + * @return non-capabilities part of the line. + */ public String getLine() { return command.getLine(); } - /** @return capabilities parsed from the line. */ + /** + * Get capabilities parsed from the line + * + * @return capabilities parsed from the line. + */ public Set<String> getCapabilities() { Set<String> reconstructedCapabilites = new HashSet<>(); for (Map.Entry<String, String> e : command.getCapabilities() @@ -2130,8 +2138,10 @@ public class ReceivePack { } /** + * Set the unpackErrorHandler + * * @param unpackErrorHandler - * the unpackErrorHandler to set + * the unpackErrorHandler * @since 5.7 */ public void setUnpackErrorHandler(UnpackErrorHandler unpackErrorHandler) { @@ -2155,6 +2165,8 @@ public class ReceivePack { } /** + * Get the client session-id + * * @return The client session-id. * @since 6.4 */ diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/transport/ReceivedPackStatistics.java b/org.eclipse.jgit/src/org/eclipse/jgit/transport/ReceivedPackStatistics.java index d7bc40006b..8887e263ea 100644 --- a/org.eclipse.jgit/src/org/eclipse/jgit/transport/ReceivedPackStatistics.java +++ b/org.eclipse.jgit/src/org/eclipse/jgit/transport/ReceivedPackStatistics.java @@ -174,7 +174,10 @@ public class ReceivedPackStatistics { private long numDeltaTag; /** - * @param numBytesRead number of bytes read from the input stream + * Set number of bytes read from the input stream + * + * @param numBytesRead + * number of bytes read from the input stream * @return this */ public Builder setNumBytesRead(long numBytesRead) { @@ -183,6 +186,8 @@ public class ReceivedPackStatistics { } /** + * Increment additional bytes already in the local database + * * @param size * additional bytes already in the local database * @return this @@ -220,13 +225,21 @@ public class ReceivedPackStatistics { return this; } - /** @return this */ + /** + * Increment offset delta + * + * @return this + */ public Builder addOffsetDelta() { numOfsDelta++; return this; } - /** @return this */ + /** + * Increment ref delta + * + * @return this + */ public Builder addRefDelta() { numRefDelta++; return this; diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/transport/RefAdvertiser.java b/org.eclipse.jgit/src/org/eclipse/jgit/transport/RefAdvertiser.java index 6b022ea5d1..f72c421920 100644 --- a/org.eclipse.jgit/src/org/eclipse/jgit/transport/RefAdvertiser.java +++ b/org.eclipse.jgit/src/org/eclipse/jgit/transport/RefAdvertiser.java @@ -161,9 +161,11 @@ public abstract class RefAdvertiser { } /** + * Set whether this advertiser should use protocol v2 + * * @param b - * true if this advertiser should advertise using the protocol - * v2 format, false otherwise + * true if this advertiser should advertise using the protocol v2 + * format, false otherwise * @since 5.0 */ public void setUseProtocolV2(boolean b) { diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/transport/TransferConfig.java b/org.eclipse.jgit/src/org/eclipse/jgit/transport/TransferConfig.java index 064201a629..5333beff4b 100644 --- a/org.eclipse.jgit/src/org/eclipse/jgit/transport/TransferConfig.java +++ b/org.eclipse.jgit/src/org/eclipse/jgit/transport/TransferConfig.java @@ -297,6 +297,8 @@ public class TransferConfig { } /** + * Whether clients are allowed to specify "filter" line + * * @return true if clients are allowed to specify a "filter" line * @since 5.0 */ @@ -305,6 +307,8 @@ public class TransferConfig { } /** + * Whether clients are allowed to specify "want-ref" line + * * @return true if clients are allowed to specify a "want-ref" line * @since 5.1 */ @@ -313,6 +317,8 @@ public class TransferConfig { } /** + * Whether the server accepts sideband-all requests + * * @return true if the server accepts sideband-all requests (see * {{@link #isAdvertiseSidebandAll()} for the advertisement) * @since 5.5 @@ -322,6 +328,8 @@ public class TransferConfig { } /** + * Whether to advertise sideband all to the clients + * * @return true to advertise sideband all to the clients * @since 5.6 */ @@ -330,6 +338,8 @@ public class TransferConfig { } /** + * Whether to advertise wait-for-done all to the clients + * * @return true to advertise wait-for-done all to the clients * @since 5.13 */ @@ -338,6 +348,8 @@ public class TransferConfig { } /** + * Whether to advertise object-info to all clients + * * @return true to advertise object-info to all clients * @since 5.13 */ @@ -346,6 +358,8 @@ public class TransferConfig { } /** + * Whether to advertise and receive session-id capability + * * @return true to advertise and receive session-id capability * @since 6.4 */ diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/transport/Transport.java b/org.eclipse.jgit/src/org/eclipse/jgit/transport/Transport.java index 50eca21c66..4a02d6d452 100644 --- a/org.eclipse.jgit/src/org/eclipse/jgit/transport/Transport.java +++ b/org.eclipse.jgit/src/org/eclipse/jgit/transport/Transport.java @@ -1145,6 +1145,8 @@ public abstract class Transport implements AutoCloseable { } /** + * Get filter spec + * * @return the last filter spec set with {@link #setFilterSpec(FilterSpec)}, * or {@link FilterSpec#NO_FILTER} if it was never invoked. * @since 5.4 @@ -1154,7 +1156,10 @@ public abstract class Transport implements AutoCloseable { } /** - * @param filter a new filter to use for this transport + * Set filter spec + * + * @param filter + * a new filter to use for this transport * @since 5.4 */ public final void setFilterSpec(@NonNull FilterSpec filter) { @@ -1203,6 +1208,8 @@ public abstract class Transport implements AutoCloseable { } /** + * Get deepen-since + * * @return the deepen-since for a shallow clone * @since 6.3 */ @@ -1221,7 +1228,9 @@ public abstract class Transport implements AutoCloseable { } /** - * @return the deepen-not for a shallow clone + * Get list of deepen-not + * + * @return the list of deepen-not for a shallow clone * @since 6.3 */ public final List<String> getDeepenNots() { diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/transport/UploadPack.java b/org.eclipse.jgit/src/org/eclipse/jgit/transport/UploadPack.java index 78e9110c7c..5220057f4f 100644 --- a/org.eclipse.jgit/src/org/eclipse/jgit/transport/UploadPack.java +++ b/org.eclipse.jgit/src/org/eclipse/jgit/transport/UploadPack.java @@ -194,12 +194,20 @@ public class UploadPack implements Closeable { } } - /** @return non-capabilities part of the line. */ + /** + * Get non-capabilities part of the line + * + * @return non-capabilities part of the line. + */ public String getLine() { return firstWant.getLine(); } - /** @return capabilities parsed from the line. */ + /** + * Get capabilities parsed from the line + * + * @return capabilities parsed from the line. + */ public Set<String> getOptions() { if (firstWant.getAgent() != null) { Set<String> caps = new HashSet<>(firstWant.getCapabilities()); @@ -732,8 +740,11 @@ public class UploadPack implements Closeable { } /** - * @param p provider of URIs corresponding to cached packs (to support - * the packfile URIs feature) + * Set provider of cached pack URIs + * + * @param p + * provider of URIs corresponding to cached packs (to support the + * packfile URIs feature) * @since 5.5 */ public void setCachedPackUriProvider(@Nullable CachedPackUriProvider p) { |