com.scalar.dl.client.tool

Class CommandGroupRenderer

java.lang.Object

com.scalar.dl.client.tool.CommandGroupRenderer

All Implemented Interfaces:

picocli.CommandLine.IHelpSectionRenderer

public class CommandGroupRenderer
extends java.lang.Object
implements picocli.CommandLine.IHelpSectionRenderer

Renderer to display a group of subcommands like Git. ref. https://github.com/remkop/picocli/blob/main/picocli-examples/src/main/java/picocli/examples/customhelp/GroupingDemo.java

[Usage] When you initialize the renderer, provide section information to represent the usage message. sections is a key-value pair where a) the key is a section description, and b) the value is the grouped command classes associated with CommandLine.Command processor annotation for the section.

For example, a new section is registered as follows;

1) Set the section description as the key with the corresponding command class. [Note] The description MUST start/end with "%n".

 sections.put(
   "%nregister identity information%n",
   Arrays.asList(ContractsRegistration.class)
 );
 

2) The code above is turned into the usage message below.

 register identity information
   register-cert [description of register-cert if defined in @description]
 

Constructor Summary

Constructors

Constructor and Description
CommandGroupRenderer(com.google.common.collect.ImmutableMap<java.lang.String,java.util.List<java.lang.Class<?>>> sections)

Method Summary

Modifier and Type	Method and Description
java.lang.String	render(picocli.CommandLine.Help help)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CommandGroupRenderer

public CommandGroupRenderer(com.google.common.collect.ImmutableMap<java.lang.String,java.util.List<java.lang.Class<?>>> sections)

Method Detail

render

public java.lang.String render(picocli.CommandLine.Help help)

Specified by:

render in interface picocli.CommandLine.IHelpSectionRenderer