1 /*
2 * Copyright (C) 2008, Mike Ralphson <mike@abacus.co.uk>
3 * Copyright (C) 2008, Shawn O. Pearce <spearce@spearce.org>
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.transport;
46
47 import java.text.MessageFormat;
48
49 import org.eclipse.jgit.internal.JGitText;
50
51 /** Specification of annotated tag behavior during fetch. */
52 public enum TagOpt {
53 /**
54 * Automatically follow tags if we fetch the thing they point at.
55 * <p>
56 * This is the default behavior and tries to balance the benefit of having
57 * an annotated tag against the cost of possibly objects that are only on
58 * branches we care nothing about. Annotated tags are fetched only if we can
59 * prove that we already have (or will have when the fetch completes) the
60 * object the annotated tag peels (dereferences) to.
61 */
62 AUTO_FOLLOW(""), //$NON-NLS-1$
63
64 /**
65 * Never fetch tags, even if we have the thing it points at.
66 * <p>
67 * This option must be requested by the user and always avoids fetching
68 * annotated tags. It is most useful if the location you are fetching from
69 * publishes annotated tags, but you are not interested in the tags and only
70 * want their branches.
71 */
72 NO_TAGS("--no-tags"), //$NON-NLS-1$
73
74 /**
75 * Always fetch tags, even if we do not have the thing it points at.
76 * <p>
77 * Unlike {@link #AUTO_FOLLOW} the tag is always obtained. This may cause
78 * hundreds of megabytes of objects to be fetched if the receiving
79 * repository does not yet have the necessary dependencies.
80 */
81 FETCH_TAGS("--tags"); //$NON-NLS-1$
82
83 private final String option;
84
85 private TagOpt(final String o) {
86 option = o;
87 }
88
89 /**
90 * Get the command line/configuration file text for this value.
91 *
92 * @return text that appears in the configuration file to activate this.
93 */
94 public String option() {
95 return option;
96 }
97
98 /**
99 * Convert a command line/configuration file text into a value instance.
100 *
101 * @param o
102 * the configuration file text value.
103 * @return the option that matches the passed parameter.
104 */
105 public static TagOpt fromOption(final String o) {
106 if (o == null || o.length() == 0)
107 return AUTO_FOLLOW;
108 for (final TagOpt tagopt : values()) {
109 if (tagopt.option().equals(o))
110 return tagopt;
111 }
112 throw new IllegalArgumentException(MessageFormat.format(JGitText.get().invalidTagOption, o));
113 }
114 }