co.cask.cdap.docgen.cli

Class GenerateCLIDocsTableCommand

java.lang.Object

co.cask.cdap.cli.command.system.HelpCommand

co.cask.cdap.docgen.cli.GenerateCLIDocsTableCommand

All Implemented Interfaces:

co.cask.common.cli.Command

public class GenerateCLIDocsTableCommand
extends HelpCommand

Generates data for the table in cdap-docs/reference-manual/source/cli-api.rst.

Field Summary

Fields inherited from class co.cask.cdap.cli.command.system.HelpCommand

commands

Constructor Summary

Constructors

Constructor and Description
GenerateCLIDocsTableCommand(co.cask.common.cli.CommandSet commands, TableRendererConfig tableRendererConfig)

Method Summary

Methods

Modifier and Type	Method and Description
void	execute(co.cask.common.cli.Arguments arguments, PrintStream output)
String	getDescription()
String	getPattern()

Methods inherited from class co.cask.cdap.cli.command.system.HelpCommand

categorizeCommands, printCommands

Methods inherited from class java.lang.Object

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

Constructor Detail

GenerateCLIDocsTableCommand

public GenerateCLIDocsTableCommand(co.cask.common.cli.CommandSet commands,
                           TableRendererConfig tableRendererConfig)

Method Detail

execute

public void execute(co.cask.common.cli.Arguments arguments,
           PrintStream output)
             throws Exception

Specified by:

execute in interface co.cask.common.cli.Command

Overrides:

execute in class HelpCommand

Throws:

Exception

getPattern

public String getPattern()

Specified by:

getPattern in interface co.cask.common.cli.Command

Overrides:

getPattern in class HelpCommand

getDescription

public String getDescription()

Specified by:

getDescription in interface co.cask.common.cli.Command

Overrides:

getDescription in class HelpCommand