diff options
Diffstat (limited to 'org.eclipse.jgit/src/org/eclipse/jgit/api/TransportCommand.java')
| -rw-r--r-- | org.eclipse.jgit/src/org/eclipse/jgit/api/TransportCommand.java | 91 |
1 files changed, 39 insertions, 52 deletions
diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/api/TransportCommand.java b/org.eclipse.jgit/src/org/eclipse/jgit/api/TransportCommand.java index 1aeb6109ec..30f1bc9cc6 100644 --- a/org.eclipse.jgit/src/org/eclipse/jgit/api/TransportCommand.java +++ b/org.eclipse.jgit/src/org/eclipse/jgit/api/TransportCommand.java @@ -1,44 +1,11 @@ /* - * Copyright (C) 2011, GitHub Inc. - * and other copyright owners as documented in the project's IP log. + * Copyright (C) 2011, GitHub Inc. and others * - * This program and the accompanying materials are made available - * under the terms of the Eclipse Distribution License v1.0 which - * accompanies this distribution, is reproduced below, and is - * available at http://www.eclipse.org/org/documents/edl-v10.php + * This program and the accompanying materials are made available under the + * terms of the Eclipse Distribution License v. 1.0 which is available at + * https://www.eclipse.org/org/documents/edl-v10.php. * - * 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 Eclipse Foundation, Inc. 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. + * SPDX-License-Identifier: BSD-3-Clause */ package org.eclipse.jgit.api; @@ -47,14 +14,17 @@ import org.eclipse.jgit.transport.CredentialsProvider; import org.eclipse.jgit.transport.Transport; /** - * Base class for commands that use a {@link Transport} during execution. + * Base class for commands that use a + * {@link org.eclipse.jgit.transport.Transport} during execution. * <p> * This class provides standard configuration of a transport for options such as - * a {@link CredentialsProvider}, a timeout, and a - * {@link TransportConfigCallback}. + * a {@link org.eclipse.jgit.transport.CredentialsProvider}, a timeout, and a + * {@link org.eclipse.jgit.api.TransportConfigCallback}. * * @param <C> + * concrete type of this {@code GitCommand} * @param <T> + * the return type of the {@code GitCommand}'s {@code call()} method */ public abstract class TransportCommand<C extends GitCommand, T> extends GitCommand<T> { @@ -75,15 +45,21 @@ public abstract class TransportCommand<C extends GitCommand, T> extends protected TransportConfigCallback transportConfigCallback; /** - * @param repo + * <p>Constructor for TransportCommand.</p> + * + * @param repo a {@link org.eclipse.jgit.lib.Repository} object. */ - protected TransportCommand(final Repository repo) { + protected TransportCommand(Repository repo) { super(repo); + setCredentialsProvider(CredentialsProvider.getDefault()); } /** + * Set the <code>credentialsProvider</code>. + * * @param credentialsProvider - * the {@link CredentialsProvider} to use + * the {@link org.eclipse.jgit.transport.CredentialsProvider} to + * use * @return {@code this} */ public C setCredentialsProvider( @@ -93,8 +69,10 @@ public abstract class TransportCommand<C extends GitCommand, T> extends } /** + * Set <code>timeout</code>. + * * @param timeout - * the timeout used for the transport step + * the timeout (in seconds) used for the transport step * @return {@code this} */ public C setTimeout(int timeout) { @@ -103,12 +81,15 @@ public abstract class TransportCommand<C extends GitCommand, T> extends } /** + * Set the <code>TransportConfigCallback</code>. + * * @param transportConfigCallback * if set, the callback will be invoked after the - * {@link Transport} has created, but before the - * {@link Transport} is used. The callback can use this - * opportunity to set additional type-specific configuration on - * the {@link Transport} instance. + * {@link org.eclipse.jgit.transport.Transport} has created, but + * before the {@link org.eclipse.jgit.transport.Transport} is + * used. The callback can use this opportunity to set additional + * type-specific configuration on the + * {@link org.eclipse.jgit.transport.Transport} instance. * @return {@code this} */ public C setTransportConfigCallback( @@ -117,7 +98,11 @@ public abstract class TransportCommand<C extends GitCommand, T> extends return self(); } - /** @return {@code this} */ + /** + * Return this command cast to {@code C} + * + * @return {@code this} cast to {@code C} + */ @SuppressWarnings("unchecked") protected final C self() { return (C) this; @@ -128,9 +113,10 @@ public abstract class TransportCommand<C extends GitCommand, T> extends * callback * * @param transport + * a {@link org.eclipse.jgit.transport.Transport} object. * @return {@code this} */ - protected C configure(final Transport transport) { + protected C configure(Transport transport) { if (credentialsProvider != null) transport.setCredentialsProvider(credentialsProvider); transport.setTimeout(timeout); @@ -144,9 +130,10 @@ public abstract class TransportCommand<C extends GitCommand, T> extends * {@code this} command * * @param childCommand + * a {@link org.eclipse.jgit.api.TransportCommand} object. * @return {@code this} */ - protected C configure(final TransportCommand childCommand) { + protected C configure(TransportCommand childCommand) { childCommand.setCredentialsProvider(credentialsProvider); childCommand.setTimeout(timeout); childCommand.setTransportConfigCallback(transportConfigCallback); |