Format.Usage (CRaSH Doc API 1.3.1 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.crsh.cli.descriptor
Class Format.Usage

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

Enclosing class:: Format

public static class Format.Usage

extends Format

The command usage.

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.Usage()`

Method Summary
`private List<String[]>`	`collectParametersTuples(CommandDescriptor<?> command)`
`void`	`print(CommandDescriptor<?> command, Appendable stream)` Print the specified `command` to the `stream`
`void`	`printDetailsSection(CommandDescriptor<?> command, Appendable stream)`
`void`	`printUsageSection(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.Usage

public Format.Usage()

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

printUsageSection

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

Throws:: IOException

collectParametersTuples

private List<String[]> collectParametersTuples(CommandDescriptor<?> command)
                                        throws IOException

Throws:: IOException

printDetailsSection

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