org.argeo.cli

Class HelpCommand

java.lang.Object

org.argeo.cli.HelpCommand

All Implemented Interfaces:

java.util.function.Function<java.util.List<java.lang.String>,java.lang.String>, DescribedCommand<java.lang.String>

public class HelpCommand
extends java.lang.Object
implements DescribedCommand<java.lang.String>

A special command that can describe DescribedCommand.

Constructor Summary

Constructors

Constructor and Description
HelpCommand(CommandsCli parentCommandsCli, CommandsCli commandsCli)

Method Summary

Modifier and Type	Method and Description
java.lang.String	apply(java.util.List<java.lang.String> args)
protected java.lang.String	getCommandCall(CommandsCli commandsCli)
java.lang.String	getCommandUsage(java.lang.String cmd, DescribedCommand<?> command)
java.lang.String	getDescription()
CommandsCli	getParentCommandsCli()
java.lang.String	getUsage()
static void	printHelp(CommandsCli commandsCli, java.lang.String commandName, java.io.StringWriter out)
static void	printHelp(CommandsCli commandsCli, java.io.StringWriter out)
static void	printHelp(DescribedCommand<?> command, java.io.StringWriter out)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.argeo.cli.DescribedCommand

getExamples, getOptions, mainImpl, toCommandLine

Methods inherited from interface java.util.function.Function

andThen, compose, identity

Constructor Detail

HelpCommand

public HelpCommand(CommandsCli parentCommandsCli,
                   CommandsCli commandsCli)

Method Detail

apply

public java.lang.String apply(java.util.List<java.lang.String> args)

Specified by:

apply in interface java.util.function.Function<java.util.List<java.lang.String>,java.lang.String>

getCommandUsage

public java.lang.String getCommandUsage(java.lang.String cmd,
                                        DescribedCommand<?> command)

getDescription

public java.lang.String getDescription()

Specified by:

getDescription in interface DescribedCommand<java.lang.String>

getUsage

public java.lang.String getUsage()

Specified by:

getUsage in interface DescribedCommand<java.lang.String>

getParentCommandsCli

public CommandsCli getParentCommandsCli()

getCommandCall

protected java.lang.String getCommandCall(CommandsCli commandsCli)

printHelp

public static void printHelp(DescribedCommand<?> command,
                             java.io.StringWriter out)

printHelp

public static void printHelp(CommandsCli commandsCli,
                             java.lang.String commandName,
                             java.io.StringWriter out)

printHelp

public static void printHelp(CommandsCli commandsCli,
                             java.io.StringWriter out)