org.crsh.cli.descriptor
Class Format.Man

java.lang.Object
  org.crsh.cli.descriptor.Format
      org.crsh.cli.descriptor.Format.Man

Enclosing class:

Format

public static class Format.Man
extends Format

The command manual.

Nested Class Summary

Nested classes/interfaces inherited from class org.crsh.cli.descriptor.Format

Format.Describe, Format.Man, Format.Usage

Field Summary

Fields inherited from class org.crsh.cli.descriptor.Format

DESCRIBE, MAN, USAGE

Constructor Summary

Format.Man()

Method Summary

void	print(CommandDescriptor<?> command, Appendable stream) Print the specified command to the stream
void	printDescriptionSection(CommandDescriptor<?> command, Appendable stream)
void	printNameSection(CommandDescriptor<?> command, Appendable stream)
protected boolean	printOptions(boolean printed, CommandDescriptor<?> command, Appendable stream)
protected boolean	printParameter(boolean printed, ParameterDescriptor parameter, Appendable stream)
protected boolean	printParameters(boolean printed, CommandDescriptor<?> command, Appendable stream)
void	printParametersSection(CommandDescriptor<?> command, Appendable stream)
protected void	printSubordinates(CommandDescriptor<?> command, Appendable stream)
void	printSynopsisSection(CommandDescriptor<?> command, Appendable stream)

Methods inherited from class org.crsh.cli.descriptor.Format

printFQN, printFQNWithOptions

Methods inherited from class java.lang.Object

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

Constructor Detail

Format.Man

public Format.Man()

Method Detail

print

public void print(CommandDescriptor<?> command,
                  Appendable stream)
           throws IOException

Description copied from class: Format

Print the specified command to the stream

Specified by:

print in class Format

Parameters:

command - the command to print

stream - the output

Throws:

IOException

printNameSection

public void printNameSection(CommandDescriptor<?> command,
                             Appendable stream)
                      throws IOException

Throws:

IOException

printSynopsisSection

public void printSynopsisSection(CommandDescriptor<?> command,
                                 Appendable stream)
                          throws IOException

Throws:

IOException

printDescriptionSection

public void printDescriptionSection(CommandDescriptor<?> command,
                                    Appendable stream)
                             throws IOException

Throws:

IOException

printParametersSection

public void printParametersSection(CommandDescriptor<?> command,
                                   Appendable stream)
                            throws IOException

Throws:

IOException

printSubordinates

protected void printSubordinates(CommandDescriptor<?> command,
                                 Appendable stream)
                          throws IOException

Throws:

IOException

printOptions

protected boolean printOptions(boolean printed,
                               CommandDescriptor<?> command,
                               Appendable stream)
                        throws IOException

Throws:

IOException

printParameters

protected boolean printParameters(boolean printed,
                                  CommandDescriptor<?> command,
                                  Appendable stream)
                           throws IOException

Throws:

IOException

printParameter

protected boolean printParameter(boolean printed,
                                 ParameterDescriptor parameter,
                                 Appendable stream)
                          throws IOException

Throws:

IOException