1 /*
2 * Copyright (C) 2008, Shawn O. Pearce <spearce@spearce.org>
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
44 package org.eclipse.jgit.pgm;
45
46 import static java.lang.annotation.ElementType.TYPE;
47 import static java.lang.annotation.RetentionPolicy.RUNTIME;
48
49 import java.lang.annotation.Retention;
50 import java.lang.annotation.Target;
51
52 /**
53 * Annotation to document a {@link org.eclipse.jgit.pgm.TextBuiltin}.
54 * <p>
55 * This is an optional annotation for TextBuiltin subclasses and it carries
56 * documentation forward into the runtime system describing what the command is
57 * and why users may want to invoke it.
58 */
59 @Retention(RUNTIME)
60 @Target( { TYPE })
61 public @interface Command {
62 /**
63 * Get the command name
64 *
65 * @return name the command is invoked as from the command line. If the
66 * (default) empty string is supplied the name will be generated
67 * from the class name.
68 */
69 public String name() default "";
70
71 /**
72 * Get command description
73 *
74 * @return one line description of the command's feature set.
75 */
76 public String usage() default "";
77
78 /**
79 * If this command is considered to be commonly used
80 *
81 * @return true if this command is considered to be commonly used.
82 */
83 public boolean common() default false;
84 }