View Javadoc
1   /*
2    * Copyright (C) 2013, Matthias Sohn <matthias.sohn@sap.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.pgm;
44  
45  import java.io.IOException;
46  import java.util.ArrayList;
47  import java.util.List;
48  
49  import org.eclipse.jgit.api.DescribeCommand;
50  import org.eclipse.jgit.api.Git;
51  import org.eclipse.jgit.api.errors.GitAPIException;
52  import org.eclipse.jgit.api.errors.RefNotFoundException;
53  import org.eclipse.jgit.errors.InvalidPatternException;
54  import org.eclipse.jgit.lib.ObjectId;
55  import org.eclipse.jgit.pgm.internal.CLIText;
56  import org.kohsuke.args4j.Argument;
57  import org.kohsuke.args4j.Option;
58  
59  @Command(common = true, usage = "usage_Describe")
60  class Describe extends TextBuiltin {
61  
62  	@Argument(index = 0, metaVar = "metaVar_treeish")
63  	private ObjectId tree;
64  
65  	@Option(name = "--long", usage = "usage_LongFormat")
66  	private boolean longDesc;
67  
68  	@Option(name = "--tags", usage = "usage_UseTags")
69  	private boolean useTags;
70  
71  	@Option(name = "--always", usage = "usage_AlwaysFallback")
72  	private boolean always;
73  
74  	@Option(name = "--match", usage = "usage_Match", metaVar = "metaVar_pattern")
75  	private List<String> patterns = new ArrayList<>();
76  
77  	/** {@inheritDoc} */
78  	@Override
79  	protected void run() {
80  		try (Gitit.html#Git">Git git = new Git(db)) {
81  			DescribeCommand cmd = git.describe();
82  			if (tree != null) {
83  				cmd.setTarget(tree);
84  			}
85  			cmd.setLong(longDesc);
86  			cmd.setTags(useTags);
87  			cmd.setAlways(always);
88  			cmd.setMatch(patterns.toArray(new String[0]));
89  			String result = null;
90  			try {
91  				result = cmd.call();
92  			} catch (RefNotFoundException e) {
93  				throw die(CLIText.get().noNamesFound, e);
94  			}
95  			if (result == null) {
96  				throw die(CLIText.get().noNamesFound);
97  			}
98  
99  			outw.println(result);
100 		} catch (IOException | InvalidPatternException | GitAPIException e) {
101 			throw die(e.getMessage(), e);
102 		}
103 	}
104 }