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.api;
44  
45  import java.io.IOException;
46  import java.util.ArrayList;
47  import java.util.Collections;
48  import java.util.Comparator;
49  import java.util.List;
50  
51  import org.eclipse.jgit.api.errors.GitAPIException;
52  import org.eclipse.jgit.api.errors.JGitInternalException;
53  import org.eclipse.jgit.lib.Constants;
54  import org.eclipse.jgit.lib.Ref;
55  import org.eclipse.jgit.lib.Repository;
56  import org.eclipse.jgit.revwalk.RevWalk;
57  
58  /**
59   * Used to obtain a list of tags.
60   *
61   * @see <a href="http://www.kernel.org/pub/software/scm/git/docs/git-tag.html"
62   *      >Git documentation about Tag</a>
63   */
64  public class ListTagCommand extends GitCommand<List<Ref>> {
65  
66  	/**
67  	 * Constructor for ListTagCommand.
68  	 *
69  	 * @param repo
70  	 *            a {@link org.eclipse.jgit.lib.Repository} object.
71  	 */
72  	protected ListTagCommand(Repository repo) {
73  		super(repo);
74  	}
75  
76  	/** {@inheritDoc} */
77  	@Override
78  	public List<Ref> call() throws GitAPIException {
79  		checkCallable();
80  		List<Ref> tags = new ArrayList<>();
81  		try (RevWalk revWalk = new RevWalk(repo)) {
82  			List<Ref> refList = repo.getRefDatabase()
83  					.getRefsByPrefix(Constants.R_TAGS);
84  			for (Ref ref : refList) {
85  				tags.add(ref);
86  			}
87  		} catch (IOException e) {
88  			throw new JGitInternalException(e.getMessage(), e);
89  		}
90  		Collections.sort(tags, new Comparator<Ref>() {
91  			@Override
92  			public int compare(Ref o1, Ref o2) {
93  				return o1.getName().compareTo(o2.getName());
94  			}
95  		});
96  		setCallable(false);
97  		return tags;
98  	}
99  
100 }