|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.crsh.cli.descriptor.Format
public abstract class Format
Format the command descriptor for producing documentation.
Nested Class Summary | |
---|---|
static class |
Format.Describe
The command description in one line. |
static class |
Format.Man
The command manual. |
static class |
Format.Usage
The command usage. |
Field Summary | |
---|---|
static Format.Describe |
DESCRIBE
. |
static Format.Man |
MAN
. |
static Format.Usage |
USAGE
. |
Constructor Summary | |
---|---|
Format()
|
Method Summary | |
---|---|
abstract void |
print(CommandDescriptor<?> command,
Appendable stream)
Print the specified command to the stream |
protected void |
printFQN(CommandDescriptor<?> command,
Appendable stream)
Print the full qualified name of the command. |
protected void |
printFQNWithOptions(CommandDescriptor<?> command,
Appendable stream)
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final Format.Describe DESCRIBE
public static final Format.Usage USAGE
public static final Format.Man MAN
Constructor Detail |
---|
public Format()
Method Detail |
---|
public abstract void print(CommandDescriptor<?> command, Appendable stream) throws IOException
command
to the stream
command
- the command to printstream
- the output
IOException
protected void printFQN(CommandDescriptor<?> command, Appendable stream) throws IOException
command
- the commandstream
- the output
IOException
- any io exceptionprotected void printFQNWithOptions(CommandDescriptor<?> command, Appendable stream) throws IOException
IOException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |