Module org.arakhne.afc.bootique.bootique_synopsishelp

Package org.arakhne.afc.bootique.synopsishelp.help

Class SynopsisHelpGenerator.SynopsisHelpAppender

java.lang.Object

io.bootique.help.HelpAppender

org.arakhne.afc.bootique.synopsishelp.help.SynopsisHelpGenerator.SynopsisHelpAppender

Enclosing class:

SynopsisHelpGenerator

protected static class SynopsisHelpGenerator.SynopsisHelpAppender
extends io.bootique.help.HelpAppender

Appender for the synopsis help.

Since:

15.0

Version:

17.0 2020-01-04 14:41:57

Author:

Stéphane GALLAND

Maven Group Id:

org.arakhne.afc.bootique

Maven Artifact Id:

bootique-synopsishelp

Constructor Summary

Constructors

Constructor	Description
SynopsisHelpAppender(io.bootique.help.ConsoleAppender appender)	Constructor.

Method Summary

Modifier and Type	Method	Description
protected io.bootique.help.ConsoleAppender	getOrCreateDoubleOffsetAppender()	Get or create an appender with a single offset.
protected io.bootique.help.ConsoleAppender	getOrCreateOffsetAppender()	Get or create an appender with a single offset.
void	printLongDescription(String... parts)	Print a long description.

Methods inherited from class io.bootique.help.HelpAppender

getAppender, printDescription, println, printSectionName, printSubsectionHeader, printSubsectionHeader, printText

Methods inherited from class java.lang.Object

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

Constructor Detail

SynopsisHelpAppender

public SynopsisHelpAppender(io.bootique.help.ConsoleAppender appender)

Constructor.

Parameters:

appender - the console appender.

Method Detail

getOrCreateOffsetAppender

protected io.bootique.help.ConsoleAppender getOrCreateOffsetAppender()

Get or create an appender with a single offset.

Returns:

the appender.

getOrCreateDoubleOffsetAppender

protected io.bootique.help.ConsoleAppender getOrCreateDoubleOffsetAppender()

Get or create an appender with a single offset.

Returns:

the appender.

printLongDescription

public void printLongDescription(String... parts)

Print a long description. Each part is a different paragraph.

Parameters:

parts - the parts to print out.