in shell/console/src/main/java/org/apache/felix/gogo/commands/basic/DefaultActionPreparator.java [361:468]
protected void printUsage(CommandSession session, Action action, Map<Option, Field> optionsMap, Map<Argument, Field> argsMap, PrintStream out) {
Command command = action.getClass().getAnnotation(Command.class);
if (command != null) {
List<Argument> arguments = new ArrayList<>(argsMap.keySet());
arguments.sort(Comparator.comparing(Argument::index));
Set<Option> options = new HashSet<>(optionsMap.keySet());
options.add(HELP);
boolean globalScope = NameScoping.isGlobalScope(session, command.scope());
if (command != null && (command.description() != null || command.name() != null)) {
out.println(INTENSITY_BOLD + "DESCRIPTION" + INTENSITY_NORMAL);
out.print(" ");
if (command.name() != null) {
if (globalScope) {
out.println(INTENSITY_BOLD + command.name() + INTENSITY_NORMAL);
} else {
out.println(command.scope() + ":" + INTENSITY_BOLD + command.name() + INTENSITY_NORMAL);
}
out.println();
}
out.print("\t");
out.println(command.description());
out.println();
}
StringBuilder syntax = new StringBuilder();
if (command != null) {
if (globalScope) {
syntax.append(command.name());
} else {
syntax.append(String.format("%s:%s", command.scope(), command.name()));
}
}
if (options.size() > 0) {
syntax.append(" [options]");
}
if (arguments.size() > 0) {
syntax.append(' ');
for (Argument argument : arguments) {
if (!argument.required()) {
syntax.append(String.format("[%s] ", argument.name()));
} else {
syntax.append(String.format("%s ", argument.name()));
}
}
}
int width = getWidth(session);
out.println(INTENSITY_BOLD + "SYNTAX" + INTENSITY_NORMAL);
out.print(" ");
out.println(syntax.toString());
out.println();
if (arguments.size() > 0) {
out.println(INTENSITY_BOLD + "ARGUMENTS" + INTENSITY_NORMAL);
for (Argument argument : arguments) {
out.print(" ");
out.println(INTENSITY_BOLD + argument.name() + INTENSITY_NORMAL);
printFormatted(" ", argument.description(), width, out);
if (!argument.required()) {
if (argument.valueToShowInHelp() != null && argument.valueToShowInHelp().length() != 0) {
try {
if (Argument.DEFAULT_STRING.equals(argument.valueToShowInHelp())) {
argsMap.get(argument).setAccessible(true);
Object o = argsMap.get(argument).get(action);
printObjectDefaultsTo(out, o);
} else {
printDefaultsTo(out, argument.valueToShowInHelp());
}
} catch (Throwable t) {
// Ignore
}
}
}
}
out.println();
}
if (options.size() > 0) {
out.println(INTENSITY_BOLD + "OPTIONS" + INTENSITY_NORMAL);
for (Option option : options) {
StringBuilder opt = new StringBuilder(option.name());
for (String alias : option.aliases()) {
opt.append(", ").append(alias);
}
out.print(" ");
out.println(INTENSITY_BOLD + opt + INTENSITY_NORMAL);
printFormatted(" ", option.description(), width, out);
if (option.valueToShowInHelp() != null && option.valueToShowInHelp().length() != 0) {
try {
if (Option.DEFAULT_STRING.equals(option.valueToShowInHelp())) {
optionsMap.get(option).setAccessible(true);
Object o = optionsMap.get(option).get(action);
printObjectDefaultsTo(out, o);
} else {
printDefaultsTo(out, option.valueToShowInHelp());
}
} catch (Throwable t) {
// Ignore
}
}
}
out.println();
}
if (command.detailedDescription().length() > 0) {
out.println(INTENSITY_BOLD + "DETAILS" + INTENSITY_NORMAL);
String desc = loadDescription(action.getClass(), command.detailedDescription());
printFormatted(" ", desc, width, out);
}
}
}