From 08f0e1ffed11012e5069945eb730d44f0adbcd68 Mon Sep 17 00:00:00 2001 From: Abhishek Bhatnagar Date: Fri, 20 May 2011 12:01:37 -0400 Subject: [PATCH] Add CleanCommand to JGit API Bug: 334767 Change-Id: I2650c77bc4af2d8f401bbcce5384b44ff2a64ba2 Signed-off-by: Chris Aniszczyk --- .../org/eclipse/jgit/api/CleanCommand.java | 110 ++++++++++++++++++ .../src/org/eclipse/jgit/api/Git.java | 13 +++ 2 files changed, 123 insertions(+) create mode 100644 org.eclipse.jgit/src/org/eclipse/jgit/api/CleanCommand.java diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/api/CleanCommand.java b/org.eclipse.jgit/src/org/eclipse/jgit/api/CleanCommand.java new file mode 100644 index 000000000..a3c8e5c93 --- /dev/null +++ b/org.eclipse.jgit/src/org/eclipse/jgit/api/CleanCommand.java @@ -0,0 +1,110 @@ +/* + * Copyright (C) 2011, Chris Aniszczyk + * Copyright (C) 2011, Abhishek Bhatnagar + * and other copyright owners as documented in the project's IP log. + * + * 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 + * + * 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. + */ +package org.eclipse.jgit.api; + +import java.io.File; +import java.io.IOException; +import java.util.Collections; +import java.util.Set; + +import org.eclipse.jgit.api.errors.JGitInternalException; +import org.eclipse.jgit.lib.Repository; +import org.eclipse.jgit.util.FileUtils; + +/** + * Remove untracked files from the working tree + * + * @see Git documentation about Clean + */ +public class CleanCommand extends GitCommand> { + + private Set paths = Collections.emptySet(); + + /** + * @param repo + */ + protected CleanCommand(Repository repo) { + super(repo); + } + + /** + * Executes the {@code clean} 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 (means: one + * call to {@link #call()}) + * + * @return a set of strings representing each file cleaned. + */ + public Set call() { + Set files = Collections.emptySet(); + try { + StatusCommand command = new StatusCommand(repo); + Status status = command.call(); + files = status.getUntracked(); + + for (String file : files) { + if (paths.isEmpty() || paths.contains(file)) + FileUtils.delete(new File(repo.getWorkTree(), file)); + } + } catch (IOException e) { + throw new JGitInternalException(e.getMessage(), e); + } + return files; + } + + /** + * If paths are set, only these paths are affected by the cleaning. + * + * @param paths + * the paths to set + * @return {@code this} + */ + public CleanCommand setPaths(Set paths) { + this.paths = paths; + return this; + } + +} diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/api/Git.java b/org.eclipse.jgit/src/org/eclipse/jgit/api/Git.java index d3185faaa..682455077 100644 --- a/org.eclipse.jgit/src/org/eclipse/jgit/api/Git.java +++ b/org.eclipse.jgit/src/org/eclipse/jgit/api/Git.java @@ -442,6 +442,19 @@ public class Git { return new LsRemoteCommand(repo); } + /** + * Returns a command object to execute a {@code clean} command + * + * @see Git documentation about Clean + * @return a {@link CleanCommand} used to collect all optional parameters + * and to finally execute the {@code clean} command + */ + public CleanCommand clean() { + return new CleanCommand(repo); + } + /** * @return the git repository this class is interacting with */