joptsimple
Class HelpFormatter

java.lang.Object
  extended by joptsimple.HelpFormatter
All Implemented Interfaces:
OptionSpecVisitor

 class HelpFormatter
extends java.lang.Object
implements OptionSpecVisitor

Produces text for a help screen given a set of options.

Version:
$Id: HelpFormatter.java,v 1.16 2009/04/07 00:21:24 pholser Exp $
Author:
Paul Holser

Field Summary
private  ColumnarData grid
           
 
Constructor Summary
HelpFormatter()
           
 
Method Summary
(package private)  void addHelpLineFor(AbstractOptionSpec<?> spec, java.lang.String additionalInfo)
           
private  java.lang.String createOptionDisplay(AbstractOptionSpec<?> spec)
           
(package private)  java.lang.String format(java.util.Map<java.lang.String,AbstractOptionSpec<?>> options)
           
private static java.lang.String typeIndicator(ArgumentAcceptingOptionSpec<?> spec)
           
 void visit(AlternativeLongOptionSpec spec)
           
private  void visit(ArgumentAcceptingOptionSpec<?> spec, char begin, char end)
           
 void visit(NoArgumentOptionSpec spec)
           
 void visit(OptionalArgumentOptionSpec<?> spec)
           
 void visit(RequiredArgumentOptionSpec<?> spec)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

grid

private final ColumnarData grid
Constructor Detail

HelpFormatter

HelpFormatter()
Method Detail

format

java.lang.String format(java.util.Map<java.lang.String,AbstractOptionSpec<?>> options)

addHelpLineFor

void addHelpLineFor(AbstractOptionSpec<?> spec,
                    java.lang.String additionalInfo)

visit

public void visit(NoArgumentOptionSpec spec)
Specified by:
visit in interface OptionSpecVisitor

visit

public void visit(RequiredArgumentOptionSpec<?> spec)
Specified by:
visit in interface OptionSpecVisitor

visit

public void visit(OptionalArgumentOptionSpec<?> spec)
Specified by:
visit in interface OptionSpecVisitor

visit

public void visit(AlternativeLongOptionSpec spec)
Specified by:
visit in interface OptionSpecVisitor

visit

private void visit(ArgumentAcceptingOptionSpec<?> spec,
                   char begin,
                   char end)

createOptionDisplay

private java.lang.String createOptionDisplay(AbstractOptionSpec<?> spec)

typeIndicator

private static java.lang.String typeIndicator(ArgumentAcceptingOptionSpec<?> spec)