diff options
Diffstat (limited to 'org.eclipse.jgit/src/org/eclipse/jgit/api/Status.java')
| -rw-r--r-- | org.eclipse.jgit/src/org/eclipse/jgit/api/Status.java | 87 |
1 files changed, 42 insertions, 45 deletions
diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/api/Status.java b/org.eclipse.jgit/src/org/eclipse/jgit/api/Status.java index 48759c2d49..f01158fa79 100644 --- a/org.eclipse.jgit/src/org/eclipse/jgit/api/Status.java +++ b/org.eclipse.jgit/src/org/eclipse/jgit/api/Status.java @@ -1,44 +1,11 @@ /* - * Copyright (C) 2011, 2013 Christian Halstrick <christian.halstrick@sap.com> - * and other copyright owners as documented in the project's IP log. + * Copyright (C) 2011, 2013 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; @@ -70,7 +37,10 @@ public class Status { private final boolean hasUncommittedChanges; /** + * Constructor for Status. + * * @param diff + * the {@link org.eclipse.jgit.lib.IndexDiff} having the status */ public Status(IndexDiff diff) { super(); @@ -86,16 +56,20 @@ public class Status { } /** - * @return true if no differences exist between the working-tree, the index, - * and the current HEAD, false if differences do exist + * Whether the status is clean + * + * @return {@code true} if no differences exist between the working-tree, + * the index, and the current HEAD, {@code false} if differences do + * exist */ public boolean isClean() { return clean; } /** - * @return true if any tracked file is changed + * Whether there are uncommitted changes * + * @return {@code true} if any tracked file is changed * @since 3.2 */ public boolean hasUncommittedChanges() { @@ -103,14 +77,18 @@ public class Status { } /** + * Get files added to the index + * * @return list of files added to the index, not in HEAD (e.g. what you get - * if you call 'git add ...' on a newly created file) + * if you call {@code git add ...} on a newly created file) */ public Set<String> getAdded() { return Collections.unmodifiableSet(diff.getAdded()); } /** + * Get changed files from HEAD to index + * * @return list of files changed from HEAD to index (e.g. what you get if * you modify an existing file and call 'git add ...' on it) */ @@ -119,6 +97,8 @@ public class Status { } /** + * Get removed files + * * @return list of files removed from index, but in HEAD (e.g. what you get * if you call 'git rm ...' on a existing file) */ @@ -127,6 +107,8 @@ public class Status { } /** + * Get missing files + * * @return list of files in index, but not filesystem (e.g. what you get if * you call 'rm ...' on a existing file) */ @@ -135,6 +117,8 @@ public class Status { } /** + * Get modified files relative to the index + * * @return list of files modified on disk relative to the index (e.g. what * you get if you modify an existing file without adding it to the * index) @@ -144,6 +128,8 @@ public class Status { } /** + * Get untracked files + * * @return list of files that are not ignored, and not in the index. (e.g. * what you get if you create a new file without adding it to the * index) @@ -153,6 +139,8 @@ public class Status { } /** + * Get untracked folders + * * @return set of directories that are not ignored, and not in the index. */ public Set<String> getUntrackedFolders() { @@ -160,6 +148,8 @@ public class Status { } /** + * Get conflicting files + * * @return list of files that are in conflict. (e.g what you get if you * modify file that was modified by someone else in the meantime) */ @@ -168,7 +158,10 @@ public class Status { } /** - * @return a map from conflicting path to its {@link StageState}. + * Get StageState of conflicting files + * + * @return a map from conflicting path to its + * {@link org.eclipse.jgit.lib.IndexDiff.StageState}. * @since 3.0 */ public Map<String, StageState> getConflictingStageState() { @@ -176,6 +169,8 @@ public class Status { } /** + * Get ignored files which are not in the index + * * @return set of files and folders that are ignored and not in the index. */ public Set<String> getIgnoredNotInIndex() { @@ -183,13 +178,15 @@ public class Status { } /** + * Get uncommitted changes, i.e. all files changed in the index or working + * tree + * * @return set of files and folders that are known to the repo and changed * either in the index or in the working tree. - * * @since 3.2 */ public Set<String> getUncommittedChanges() { - Set<String> uncommittedChanges = new HashSet<String>(); + Set<String> uncommittedChanges = new HashSet<>(); uncommittedChanges.addAll(diff.getAdded()); uncommittedChanges.addAll(diff.getChanged()); uncommittedChanges.addAll(diff.getRemoved()); |