View Javadoc
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 java.lang.reflect.Constructor;
47  import java.lang.reflect.InvocationTargetException;
48  import java.text.MessageFormat;
49  
50  import org.eclipse.jgit.pgm.internal.CLIText;
51  
52  /**
53   * Description of a command (a {@link TextBuiltin} subclass.
54   * <p>
55   * These descriptions are lightweight compared to creating a command instance
56   * and are therefore suitable for catalogs of "known" commands without linking
57   * the command's implementation and creating a dummy instance of the command.
58   */
59  public class CommandRef {
60  	private final Class<? extends TextBuiltin> impl;
61  
62  	private final String name;
63  
64  	private String usage;
65  
66  	boolean common;
67  
68  	CommandRef(final Class<? extends TextBuiltin> clazz) {
69  		this(clazz, guessName(clazz));
70  	}
71  
72  	CommandRef(final Class<? extends TextBuiltin> clazz, final Command cmd) {
73  		this(clazz, cmd.name().length() > 0 ? cmd.name() : guessName(clazz));
74  		usage = cmd.usage();
75  		common = cmd.common();
76  	}
77  
78  	private CommandRef(final Class<? extends TextBuiltin> clazz, final String cn) {
79  		impl = clazz;
80  		name = cn;
81  		usage = ""; //$NON-NLS-1$
82  	}
83  
84  	private static String guessName(final Class<? extends TextBuiltin> clazz) {
85  		final StringBuilder s = new StringBuilder();
86  		if (clazz.getName().startsWith("org.eclipse.jgit.pgm.debug.")) //$NON-NLS-1$
87  			s.append("debug-"); //$NON-NLS-1$
88  
89  		boolean lastWasDash = true;
90  		for (final char c : clazz.getSimpleName().toCharArray()) {
91  			if (Character.isUpperCase(c)) {
92  				if (!lastWasDash)
93  					s.append('-');
94  				lastWasDash = !lastWasDash;
95  				s.append(Character.toLowerCase(c));
96  			} else {
97  				s.append(c);
98  				lastWasDash = false;
99  			}
100 		}
101 		return s.toString();
102 	}
103 
104 	/**
105 	 * @return name the command is invoked as from the command line.
106 	 */
107 	public String getName() {
108 		return name;
109 	}
110 
111 	/**
112 	 * @return one line description of the command's feature set.
113 	 */
114 	public String getUsage() {
115 		return usage;
116 	}
117 
118 	/**
119 	 * @return true if this command is considered to be commonly used.
120 	 */
121 	public boolean isCommon() {
122 		return common;
123 	}
124 
125 	/**
126 	 * @return name of the Java class which implements this command.
127 	 */
128 	public String getImplementationClassName() {
129 		return impl.getName();
130 	}
131 
132 	/**
133 	 * @return loader for {@link #getImplementationClassName()}.
134 	 */
135 	public ClassLoader getImplementationClassLoader() {
136 		return impl.getClassLoader();
137 	}
138 
139 	/**
140 	 * @return a new instance of the command implementation.
141 	 */
142 	public TextBuiltin create() {
143 		final Constructor<? extends TextBuiltin> c;
144 		try {
145 			c = impl.getDeclaredConstructor();
146 		} catch (SecurityException e) {
147 			throw new RuntimeException(MessageFormat.format(CLIText.get().cannotCreateCommand, getName(), e));
148 		} catch (NoSuchMethodException e) {
149 			throw new RuntimeException(MessageFormat.format(CLIText.get().cannotCreateCommand, getName(), e));
150 		}
151 		c.setAccessible(true);
152 
153 		final TextBuiltin r;
154 		try {
155 			r = c.newInstance();
156 		} catch (InstantiationException e) {
157 			throw new RuntimeException(MessageFormat.format(CLIText.get().cannotCreateCommand, getName(), e));
158 		} catch (IllegalAccessException e) {
159 			throw new RuntimeException(MessageFormat.format(CLIText.get().cannotCreateCommand, getName(), e));
160 		} catch (IllegalArgumentException e) {
161 			throw new RuntimeException(MessageFormat.format(CLIText.get().cannotCreateCommand, getName(), e));
162 		} catch (InvocationTargetException e) {
163 			throw new RuntimeException(MessageFormat.format(CLIText.get().cannotCreateCommand, getName(), e));
164 		}
165 		r.setCommandName(getName());
166 		return r;
167 	}
168 }