org.ajoberstar.grgit.operation.RmOp.groovy Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of grgit Show documentation

The Groovy way to use Git.

There is a newer version: 1.8.0-rc.1

/*
 * Copyright 2012-2015 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.ajoberstar.grgit.operation

import java.util.concurrent.Callable

import org.ajoberstar.grgit.Repository
import org.ajoberstar.grgit.exception.GrgitException

import org.eclipse.jgit.api.RmCommand
import org.eclipse.jgit.api.errors.GitAPIException

/**
 * Remove files from the index and (optionally) delete them from the working tree.
 * Note that wildcards are not supported.
 *
 * Remove specific file or directory from both the index and working tree.
 *
 *  * grgit.remove(patterns: ['1.txt', 'some/dir'])
 * grgit.remove(patterns: ['1.txt', 'some/dir'], cached: false)
 * 
 *
 * Remove specific file or directory from the index, but leave the in the working tree.
 *
 *  * grgit.remove(patterns: ['1.txt', 'some/dir'], cached: true)
 * 
 *
 * See git-rm Manual Page.
 *
 * @since 0.1.0
 * @see git-rm Manual Page
 */
class RmOp implements Callable {
	private final Repository repo

	/**
	 * The file patterns to remove.
	 */
	Set patterns = []

	/**
	 * {@code true} if files should only be removed from the index,
	 * {@code false} (the default) otherwise.
	 */
	boolean cached = false

	RmOp(Repository repo) {
		this.repo = repo
	}

	Void call() {
		RmCommand cmd = repo.jgit.rm()
		patterns.each { cmd.addFilepattern(it) }
		cmd.cached = cached
		try {
			cmd.call()
			return null
		} catch (GitAPIException e) {
			throw new GrgitException('Problem removing files from index.', e)
		}
	}
}