View Javadoc
1   /*
2    * Copyright (C) 2010, 2012 Chris Aniszczyk <caniszczyk@gmail.com>
3    * Copyright (C) 2013, Obeo
4    * and other copyright owners as documented in the project's IP log.
5    *
6    * This program and the accompanying materials are made available
7    * under the terms of the Eclipse Distribution License v1.0 which
8    * accompanies this distribution, is reproduced below, and is
9    * available at http://www.eclipse.org/org/documents/edl-v10.php
10   *
11   * All rights reserved.
12   *
13   * Redistribution and use in source and binary forms, with or
14   * without modification, are permitted provided that the following
15   * conditions are met:
16   *
17   * - Redistributions of source code must retain the above copyright
18   *   notice, this list of conditions and the following disclaimer.
19   *
20   * - Redistributions in binary form must reproduce the above
21   *   copyright notice, this list of conditions and the following
22   *   disclaimer in the documentation and/or other materials provided
23   *   with the distribution.
24   *
25   * - Neither the name of the Eclipse Foundation, Inc. nor the
26   *   names of its contributors may be used to endorse or promote
27   *   products derived from this software without specific prior
28   *   written permission.
29   *
30   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
31   * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
32   * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
33   * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
34   * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
35   * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
36   * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
37   * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
38   * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
39   * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
40   * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
41   * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
42   * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
43   */
44  
45  package org.eclipse.jgit.pgm;
46  
47  import java.text.MessageFormat;
48  import java.util.ArrayList;
49  import java.util.List;
50  
51  import org.eclipse.jgit.api.CheckoutCommand;
52  import org.eclipse.jgit.api.Git;
53  import org.eclipse.jgit.api.errors.CheckoutConflictException;
54  import org.eclipse.jgit.api.errors.RefAlreadyExistsException;
55  import org.eclipse.jgit.api.errors.RefNotFoundException;
56  import org.eclipse.jgit.lib.Constants;
57  import org.eclipse.jgit.lib.ObjectId;
58  import org.eclipse.jgit.lib.Ref;
59  import org.eclipse.jgit.lib.Repository;
60  import org.eclipse.jgit.lib.TextProgressMonitor;
61  import org.eclipse.jgit.pgm.internal.CLIText;
62  import org.kohsuke.args4j.Argument;
63  import org.kohsuke.args4j.Option;
64  import org.kohsuke.args4j.spi.RestOfArgumentsHandler;
65  
66  @Command(common = true, usage = "usage_checkout")
67  class Checkout extends TextBuiltin {
68  
69  	@Option(name = "-b", usage = "usage_createBranchAndCheckout")
70  	private boolean createBranch = false;
71  
72  	@Option(name = "-B", usage = "usage_forcedSwitchBranch")
73  	private boolean forceSwitchBranch = false;
74  
75  	@Option(name = "--force", aliases = { "-f" }, usage = "usage_forceCheckout")
76  	private boolean forced = false;
77  
78  	@Option(name = "--orphan", usage = "usage_orphan")
79  	private boolean orphan = false;
80  
81  	@Argument(required = false, index = 0, metaVar = "metaVar_name", usage = "usage_checkout")
82  	private String name;
83  
84  	@Option(name = "--", metaVar = "metaVar_paths", handler = RestOfArgumentsHandler.class)
85  	private List<String> paths = new ArrayList<>();
86  
87  	/** {@inheritDoc} */
88  	@Override
89  	protected void run() throws Exception {
90  		if (createBranch) {
91  			final ObjectId head = db.resolve(Constants.HEAD);
92  			if (head == null)
93  				throw die(CLIText.get().onBranchToBeBorn);
94  		}
95  
96  		try (Gitit.html#Git">Git git = new Git(db)) {
97  			CheckoutCommand command = git.checkout()
98  					.setProgressMonitor(new TextProgressMonitor(errw));
99  			if (!paths.isEmpty()) {
100 				command.setStartPoint(name);
101 				if (paths.size() == 1 && paths.get(0).equals(".")) { //$NON-NLS-1$
102 					command.setAllPaths(true);
103 				} else {
104 					command.addPaths(paths);
105 				}
106 			} else {
107 				command.setCreateBranch(createBranch);
108 				command.setName(name);
109 				command.setForceRefUpdate(forceSwitchBranch);
110 				command.setForced(forced);
111 				command.setOrphan(orphan);
112 			}
113 			try {
114 				String oldBranch = db.getBranch();
115 				Ref ref = command.call();
116 				if (ref == null)
117 					return;
118 				if (Repository.shortenRefName(ref.getName()).equals(oldBranch)) {
119 					outw.println(MessageFormat.format(
120 							CLIText.get().alreadyOnBranch,
121 							name));
122 					return;
123 				}
124 				if (createBranch || orphan)
125 					outw.println(MessageFormat.format(
126 							CLIText.get().switchedToNewBranch, name));
127 				else
128 					outw.println(MessageFormat.format(
129 							CLIText.get().switchedToBranch,
130 							Repository.shortenRefName(ref.getName())));
131 			} catch (RefNotFoundException e) {
132 				throw die(MessageFormat
133 						.format(CLIText.get().pathspecDidNotMatch, name), e);
134 			} catch (RefAlreadyExistsException e) {
135 				throw die(MessageFormat
136 						.format(CLIText.get().branchAlreadyExists, name));
137 			} catch (CheckoutConflictException e) {
138 				StringBuilder builder = new StringBuilder();
139 				builder.append(CLIText.get().checkoutConflict);
140 				builder.append(System.lineSeparator());
141 				for (String path : e.getConflictingPaths()) {
142 					builder.append(MessageFormat.format(
143 							CLIText.get().checkoutConflictPathLine, path));
144 					builder.append(System.lineSeparator());
145 				}
146 				throw die(builder.toString(), e);
147 			}
148 		}
149 	}
150 }