org.crsh.cli.descriptor
Class Format.Describe

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

Enclosing class:

Format

public static class Format.Describe
extends Format

The command description in one line.

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.Describe()

Method Summary

void	print(CommandDescriptor<?> command, Appendable stream) Print the specified command to the 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.Describe

public Format.Describe()

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