com.openexchange.admin.console
Class AdminParser

java.lang.Object
  extended by com.openexchange.admin.console.CmdLineParser
      extended by com.openexchange.admin.console.AdminParser

public class AdminParser
extends CmdLineParser

This class is used to extend the CmdLineParser which two main things: 1. The ability to output help texts 2. The ability to have mandatory options


Nested Class Summary
static class AdminParser.NeededQuadState
           
 
Nested classes/interfaces inherited from class com.openexchange.admin.console.CmdLineParser
CmdLineParser.IllegalOptionValueException, CmdLineParser.NotFlagException, CmdLineParser.Option, CmdLineParser.OptionException, CmdLineParser.UnknownOptionException, CmdLineParser.UnknownSuboptionException
 
Constructor Summary
AdminParser(java.lang.String appname)
           
 
Method Summary
 CmdLineParser.Option addIntegerOption(java.lang.String longForm, java.lang.String longFormParameterDescription, java.lang.String description, boolean needed, boolean hasarg, boolean extended)
           
 CmdLineParser.Option addOption(char shortForm, java.lang.String longForm, java.lang.String description, boolean needed)
          This method is used to add an option with a mandatory field
 CmdLineParser.Option addOption(char shortForm, java.lang.String longForm, java.lang.String longFormParameterDescription, java.lang.String description, AdminParser.NeededQuadState needed, boolean hasarg)
           
 CmdLineParser.Option addOption(char shortForm, java.lang.String longForm, java.lang.String longFormParameterDescription, java.lang.String description, boolean needed)
          This method is used if you want to add an option with a description for the long parameter
 CmdLineParser.Option addOption(java.lang.String longForm, java.lang.String longFormParameterDescription, java.lang.String description, boolean needed)
           
 CmdLineParser.Option addOption(java.lang.String longForm, java.lang.String longFormParameterDescription, java.lang.String description, boolean needed, boolean hasarg)
           
 CmdLineParser.Option addOption(java.lang.String longForm, java.lang.String longFormParameterDescription, java.lang.String description, boolean needed, boolean hasarg, boolean extended)
           
 CmdLineParser.Option addSettableBooleanOption(java.lang.String longForm, java.lang.String longFormParameterDescription, java.lang.String description, boolean needed, boolean hasarg, boolean extended)
           
 boolean checkNoNewLine()
           
 void ownparse(java.lang.String[] args)
           
 void printEnvUsage()
           
 void printUsage()
           
 void printUsageExtended()
           
 void removeOption(java.lang.String shortForm, java.lang.String longForm)
           
 void setExtendedOptions()
           
 
Methods inherited from class com.openexchange.admin.console.CmdLineParser
addBooleanOption, addBooleanOption, addDoubleOption, addDoubleOption, addIntegerOption, addIntegerOption, addLongOption, addLongOption, addOption, addSettableBooleanOption, addStringOption, addStringOption, getOptionValue, getOptionValue, getOptionValues, getRemainingArgs, parse, parse
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AdminParser

public AdminParser(java.lang.String appname)
Method Detail

addOption

public final CmdLineParser.Option addOption(char shortForm,
                                            java.lang.String longForm,
                                            java.lang.String description,
                                            boolean needed)
This method is used to add an option with a mandatory field

Parameters:
shortForm -
longForm -
description -
needed -
Returns:

addOption

public final CmdLineParser.Option addOption(char shortForm,
                                            java.lang.String longForm,
                                            java.lang.String longFormParameterDescription,
                                            java.lang.String description,
                                            boolean needed)
This method is used if you want to add an option with a description for the long parameter

Parameters:
shortForm -
longForm -
longFormParameterDescription -
description -
Returns:

addOption

public final CmdLineParser.Option addOption(char shortForm,
                                            java.lang.String longForm,
                                            java.lang.String longFormParameterDescription,
                                            java.lang.String description,
                                            AdminParser.NeededQuadState needed,
                                            boolean hasarg)
Parameters:
shortForm -
longForm -
longFormParameterDescription -
description -
needed -
hasarg -
Returns:

addOption

public final CmdLineParser.Option addOption(java.lang.String longForm,
                                            java.lang.String longFormParameterDescription,
                                            java.lang.String description,
                                            boolean needed)
Parameters:
longForm -
longFormParameterDescription -
description -
needed -
Returns:

addOption

public final CmdLineParser.Option addOption(java.lang.String longForm,
                                            java.lang.String longFormParameterDescription,
                                            java.lang.String description,
                                            boolean needed,
                                            boolean hasarg)
Parameters:
longForm -
longFormParameterDescription -
description -
needed -
hasarg -
Returns:

addOption

public final CmdLineParser.Option addOption(java.lang.String longForm,
                                            java.lang.String longFormParameterDescription,
                                            java.lang.String description,
                                            boolean needed,
                                            boolean hasarg,
                                            boolean extended)
Parameters:
longForm -
longFormParameterDescription -
description -
needed -
hasarg -
extended -
Returns:

addIntegerOption

public final CmdLineParser.Option addIntegerOption(java.lang.String longForm,
                                                   java.lang.String longFormParameterDescription,
                                                   java.lang.String description,
                                                   boolean needed,
                                                   boolean hasarg,
                                                   boolean extended)
Parameters:
longForm -
longFormParameterDescription -
description -
needed -
hasarg -
extended -
Returns:

addSettableBooleanOption

public final CmdLineParser.Option addSettableBooleanOption(java.lang.String longForm,
                                                           java.lang.String longFormParameterDescription,
                                                           java.lang.String description,
                                                           boolean needed,
                                                           boolean hasarg,
                                                           boolean extended)

checkNoNewLine

public final boolean checkNoNewLine()

ownparse

public final void ownparse(java.lang.String[] args)
                    throws CmdLineParser.IllegalOptionValueException,
                           CmdLineParser.UnknownOptionException,
                           MissingOptionException
Throws:
CmdLineParser.IllegalOptionValueException
CmdLineParser.UnknownOptionException
MissingOptionException

setExtendedOptions

public final void setExtendedOptions()

printEnvUsage

public final void printEnvUsage()

printUsage

public final void printUsage()

printUsageExtended

public final void printUsageExtended()

removeOption

public void removeOption(java.lang.String shortForm,
                         java.lang.String longForm)