diff options
Diffstat (limited to 'org.eclipse.jgit/src/org/eclipse/jgit/api/StatusCommand.java')
| -rw-r--r-- | org.eclipse.jgit/src/org/eclipse/jgit/api/StatusCommand.java | 76 |
1 files changed, 26 insertions, 50 deletions
diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/api/StatusCommand.java b/org.eclipse.jgit/src/org/eclipse/jgit/api/StatusCommand.java index 9752195b95..cdd078ea25 100644 --- a/org.eclipse.jgit/src/org/eclipse/jgit/api/StatusCommand.java +++ b/org.eclipse.jgit/src/org/eclipse/jgit/api/StatusCommand.java @@ -1,49 +1,16 @@ /* - * Copyright (C) 2011, Christian Halstrick <christian.halstrick@sap.com> - * and other copyright owners as documented in the project's IP log. + * Copyright (C) 2011, Christian Halstrick <christian.halstrick@sap.com> 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; import java.io.IOException; -import java.util.LinkedList; +import java.util.ArrayList; import java.util.List; import org.eclipse.jgit.api.errors.GitAPIException; @@ -64,9 +31,9 @@ import org.eclipse.jgit.treewalk.filter.PathFilterGroup; * to finally execute the command. Each instance of this class should only be * used for one invocation of the command (means: one call to {@link #call()}) * - * @see <a - * href="http://www.kernel.org/pub/software/scm/git/docs/git-status.html" - * >Git documentation about Status</a> + * @see <a href= + * "http://www.kernel.org/pub/software/scm/git/docs/git-status.html" >Git + * documentation about Status</a> */ public class StatusCommand extends GitCommand<Status> { private WorkingTreeIterator workingTreeIt; @@ -76,14 +43,21 @@ public class StatusCommand extends GitCommand<Status> { private IgnoreSubmoduleMode ignoreSubmoduleMode = null; /** + * Constructor for StatusCommand. + * * @param repo + * a {@link org.eclipse.jgit.lib.Repository} object. */ protected StatusCommand(Repository repo) { super(repo); } /** + * Whether to ignore submodules + * * @param mode + * the + * {@link org.eclipse.jgit.submodule.SubmoduleWalk.IgnoreSubmoduleMode} * @return {@code this} * @since 3.6 */ @@ -109,7 +83,7 @@ public class StatusCommand extends GitCommand<Status> { */ public StatusCommand addPath(String path) { if (paths == null) - paths = new LinkedList<String>(); + paths = new ArrayList<>(); paths.add(path); return this; } @@ -126,14 +100,14 @@ public class StatusCommand extends GitCommand<Status> { } /** + * {@inheritDoc} + * <p> * Executes the {@code Status} command with all the options and parameters * collected by the setter methods of this class. Each instance of this * class should only be used for one invocation of the command. Don't call * this method twice on an instance. - * - * @return a {@link Status} object telling about each path where working - * tree, index or HEAD differ from each other. */ + @Override public Status call() throws GitAPIException, NoWorkTreeException { if (workingTreeIt == null) workingTreeIt = new FileTreeIterator(repo); @@ -156,8 +130,9 @@ public class StatusCommand extends GitCommand<Status> { } /** - * To set the {@link WorkingTreeIterator} which should be used. If this - * method is not called a standard {@link FileTreeIterator} is used. + * To set the {@link org.eclipse.jgit.treewalk.WorkingTreeIterator} which + * should be used. If this method is not called a standard + * {@link org.eclipse.jgit.treewalk.FileTreeIterator} is used. * * @param workingTreeIt * a working tree iterator @@ -169,10 +144,11 @@ public class StatusCommand extends GitCommand<Status> { } /** - * To set the {@link ProgressMonitor} which contains callback methods to - * inform you about the progress of this command. + * To set the {@link org.eclipse.jgit.lib.ProgressMonitor} which contains + * callback methods to inform you about the progress of this command. * * @param progressMonitor + * a {@link org.eclipse.jgit.lib.ProgressMonitor} object. * @return {@code this} * @since 3.1 */ |