Package ubic.gemma.cli.completion

Class WikiCompletionGenerator

java.lang.Object

ubic.gemma.cli.completion.WikiCompletionGenerator

All Implemented Interfaces:

CompletionGenerator

public class WikiCompletionGenerator
extends Object
implements CompletionGenerator

Wraps ConfluenceWikiHtmlGenerator so that we can use it as a CompletionGenerator.

Author:

poirigui

Field Summary

Fields

Modifier and Type	Field	Description
final ConfluenceWikiHtmlGenerator	wikiGenerator

Constructor Summary

Constructors

Constructor	Description
WikiCompletionGenerator(String executableName, SortedMap<CLI.CommandGroup,SortedMap<String,ConfluenceWikiHtmlGenerator.CommandMeta>> commands, String pageSuffix, Path outputDir)

Method Summary

Modifier and Type	Method	Description
void	afterCompletion(PrintWriter writer)	Executed after all completions have been generated.
void	beforeCompletion(PrintWriter writer)	Executed before any completions has been generated.
void	generateCompletion(org.apache.commons.cli.Options options, PrintWriter writer)	Generate completion for the given options.
void	generateSubcommandCompletion(String subcommand, org.apache.commons.cli.Options subcommandOptions, String subcommandDescription, boolean allowsPositionalArguments, PrintWriter writer)	Generate completions for the given subcommand.

Methods inherited from class java.lang.Object

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

Field Details

wikiGenerator

public final ConfluenceWikiHtmlGenerator wikiGenerator

Constructor Details

WikiCompletionGenerator

public WikiCompletionGenerator(String executableName,
 SortedMap<CLI.CommandGroup,SortedMap<String,ConfluenceWikiHtmlGenerator.CommandMeta>> commands,
 String pageSuffix,
 Path outputDir)

Method Details

beforeCompletion

public void beforeCompletion(PrintWriter writer)

Description copied from interface: CompletionGenerator

Executed before any completions has been generated.

Specified by:

beforeCompletion in interface CompletionGenerator

generateCompletion

public void generateCompletion(org.apache.commons.cli.Options options,
 PrintWriter writer)

Description copied from interface: CompletionGenerator

Generate completion for the given options.

Specified by:

generateCompletion in interface CompletionGenerator

generateSubcommandCompletion

public void generateSubcommandCompletion(String subcommand,
 org.apache.commons.cli.Options subcommandOptions,
 @Nullable
 String subcommandDescription,
 boolean allowsPositionalArguments,
 PrintWriter writer)

Description copied from interface: CompletionGenerator

Generate completions for the given subcommand.

Specified by:

generateSubcommandCompletion in interface CompletionGenerator

afterCompletion

public void afterCompletion(PrintWriter writer)

Description copied from interface: CompletionGenerator

Executed after all completions have been generated.

Specified by:

afterCompletion in interface CompletionGenerator