aboutsummaryrefslogtreecommitdiffstats
path: root/org.eclipse.jgit.pgm/src/org/eclipse/jgit/pgm/CommandRef.java
blob: fb5a8fffc1f951e630b3a1b93def350e71a0f5b5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
/*
 * Copyright (C) 2008, Shawn O. Pearce <spearce@spearce.org> and others
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Distribution License v. 1.0 which is available at
 * https://www.eclipse.org/org/documents/edl-v10.php.
 *
 * SPDX-License-Identifier: BSD-3-Clause
 */

package org.eclipse.jgit.pgm;

import java.lang.reflect.Constructor;
import java.lang.reflect.InvocationTargetException;
import java.text.MessageFormat;

import org.eclipse.jgit.pgm.internal.CLIText;

/**
 * Description of a command (a {@link org.eclipse.jgit.pgm.TextBuiltin}
 * subclass).
 * <p>
 * These descriptions are lightweight compared to creating a command instance
 * and are therefore suitable for catalogs of "known" commands without linking
 * the command's implementation and creating a dummy instance of the command.
 */
public class CommandRef {
	private final Class<? extends TextBuiltin> impl;

	private final String name;

	private String usage;

	boolean common;

	CommandRef(Class<? extends TextBuiltin> clazz) {
		this(clazz, guessName(clazz));
	}

	CommandRef(Class<? extends TextBuiltin> clazz, Command cmd) {
		this(clazz, cmd.name().length() > 0 ? cmd.name() : guessName(clazz));
		usage = cmd.usage();
		common = cmd.common();
	}

	private CommandRef(Class<? extends TextBuiltin> clazz, String cn) {
		impl = clazz;
		name = cn;
		usage = ""; //$NON-NLS-1$
	}

	private static String guessName(Class<? extends TextBuiltin> clazz) {
		final StringBuilder s = new StringBuilder();
		if (clazz.getName().startsWith("org.eclipse.jgit.pgm.debug.")) //$NON-NLS-1$
			s.append("debug-"); //$NON-NLS-1$

		boolean lastWasDash = true;
		for (char c : clazz.getSimpleName().toCharArray()) {
			if (Character.isUpperCase(c)) {
				if (!lastWasDash)
					s.append('-');
				lastWasDash = !lastWasDash;
				s.append(Character.toLowerCase(c));
			} else {
				s.append(c);
				lastWasDash = false;
			}
		}
		return s.toString();
	}

	/**
	 * Get the <code>name</code>.
	 *
	 * @return name the command is invoked as from the command line.
	 */
	public String getName() {
		return name;
	}

	/**
	 * Get <code>usage</code>.
	 *
	 * @return one line description of the command's feature set.
	 */
	public String getUsage() {
		return usage;
	}

	/**
	 * Is this command commonly used
	 *
	 * @return true if this command is considered to be commonly used.
	 */
	public boolean isCommon() {
		return common;
	}

	/**
	 * Get implementation class name
	 *
	 * @return name of the Java class which implements this command.
	 */
	public String getImplementationClassName() {
		return impl.getName();
	}

	/**
	 * Get implementation class loader
	 *
	 * @return loader for {@link #getImplementationClassName()}.
	 */
	public ClassLoader getImplementationClassLoader() {
		return impl.getClassLoader();
	}

	/**
	 * Create an instance of the command implementation
	 *
	 * @return a new instance of the command implementation.
	 */
	public TextBuiltin create() {
		final Constructor<? extends TextBuiltin> c;
		try {
			c = impl.getDeclaredConstructor();
		} catch (SecurityException | NoSuchMethodException e) {
			throw new RuntimeException(MessageFormat
					.format(CLIText.get().cannotCreateCommand, getName(), e));
		}
		c.setAccessible(true);

		final TextBuiltin r;
		try {
			r = c.newInstance();
		} catch (InstantiationException | IllegalAccessException
				| IllegalArgumentException | InvocationTargetException e) {
			throw new RuntimeException(MessageFormat
					.format(CLIText.get().cannotCreateCommand, getName(), e));
		}
		r.setCommandName(getName());
		return r;
	}

	@SuppressWarnings("nls")
	@Override
	public String toString() {
		return "CommandRef [impl=" + impl + ", name=" + name + ", usage="
				+ CLIText.get().resourceBundle().getString(usage) + ", common="
				+ common + "]";
	}
}