View Javadoc
1   /*
2    * Copyright (C) 2011, Ketan Padegaonkar <KetanPadegaonkar@gmail.com>
3    * and other copyright owners as documented in the project's IP log.
4    *
5    * This program and the accompanying materials are made available
6    * under the terms of the Eclipse Distribution License v1.0 which
7    * accompanies this distribution, is reproduced below, and is
8    * available at http://www.eclipse.org/org/documents/edl-v10.php
9    *
10   * All rights reserved.
11   *
12   * Redistribution and use in source and binary forms, with or
13   * without modification, are permitted provided that the following
14   * conditions are met:
15   *
16   * - Redistributions of source code must retain the above copyright
17   *   notice, this list of conditions and the following disclaimer.
18   *
19   * - Redistributions in binary form must reproduce the above
20   *   copyright notice, this list of conditions and the following
21   *   disclaimer in the documentation and/or other materials provided
22   *   with the distribution.
23   *
24   * - Neither the name of the Eclipse Foundation, Inc. nor the
25   *   names of its contributors may be used to endorse or promote
26   *   products derived from this software without specific prior
27   *   written permission.
28   *
29   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
30   * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
31   * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
32   * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
33   * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
34   * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
35   * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
36   * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
37   * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
38   * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
39   * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
40   * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
41   * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
42   */
43  package org.eclipse.jgit.ant.tasks;
44  
45  import java.io.File;
46  import java.io.IOException;
47  
48  import org.apache.tools.ant.BuildException;
49  import org.apache.tools.ant.Task;
50  import org.eclipse.jgit.api.CheckoutCommand;
51  import org.eclipse.jgit.api.Git;
52  import org.eclipse.jgit.lib.Repository;
53  import org.eclipse.jgit.storage.file.FileRepositoryBuilder;
54  
55  /**
56   * Checkout a branch or paths to the working tree.
57   *
58   * @see <a
59   *      href="http://www.kernel.org/pub/software/scm/git/docs/git-checkout.html"
60   *      >git-checkout(1)</a>
61   */
62  public class GitCheckoutTask extends Task {
63  
64  	private File src;
65  	private String branch;
66  	private boolean createBranch;
67  	private boolean force;
68  
69  	/**
70  	 * Set the <code>src</code>
71  	 *
72  	 * @param src
73  	 *            the src to set
74  	 */
75  	public void setSrc(File src) {
76  		this.src = src;
77  	}
78  
79  	/**
80  	 * Set <code>branch</code>
81  	 *
82  	 * @param branch
83  	 *            the initial branch to check out
84  	 */
85  	public void setBranch(String branch) {
86  		this.branch = branch;
87  	}
88  
89  	/**
90  	 * Set if branch should be created if not yet existing
91  	 *
92  	 * @param createBranch
93  	 *            whether the branch should be created if it does not already
94  	 *            exist
95  	 */
96  	public void setCreateBranch(boolean createBranch) {
97  		this.createBranch = createBranch;
98  	}
99  
100 	/**
101 	 * Set <code>force</code>
102 	 *
103 	 * @param force
104 	 *            if <code>true</code> and the branch with the given name
105 	 *            already exists, the start-point of an existing branch will be
106 	 *            set to a new start-point; if false, the existing branch will
107 	 *            not be changed
108 	 */
109 	public void setForce(boolean force) {
110 		this.force = force;
111 	}
112 
113 	/** {@inheritDoc} */
114 	@Override
115 	public void execute() throws BuildException {
116 		CheckoutCommand checkout;
117 		try (Repository repo = new FileRepositoryBuilder().readEnvironment()
118 				.findGitDir(src).build();
119 			Git git = new Git(repo)) {
120 			checkout = git.checkout();
121 		} catch (IOException e) {
122 			throw new BuildException("Could not access repository " + src, e);
123 		}
124 
125 		try {
126 			checkout.setCreateBranch(createBranch).setForce(force)
127 					.setName(branch);
128 			checkout.call();
129 		} catch (Exception e) {
130 			throw new BuildException("Could not checkout repository " + src, e);
131 		}
132 	}
133 
134 }