OptionParser (Xerial Project API Javadoc)

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.xerial.util.cui
Class OptionParser<OptionID extends Comparable>

java.lang.Object
  org.xerial.util.cui.OptionParser<OptionID>

public class OptionParser<OptionID extends Comparable>
extends Object
extends Object

OptionParser parses command line arguments

Usage:

 
  public static void main(String[] args)
  {
       enum Opt { HELP, OUTDIR } 
       OptionParser<Opt> p = new OptionParser<Opt>();
       p.addOption(Opt.HELP, "h", "help", "display help message");
       // adds an option with an argument whose default value is "."     
       p.addOptionWithArgument(Opt.OUTDIR, "o", "outdir", "DIR", "specify output direcotry", ".");
       
       p.parse(args);
       
       if(p.isSet(Opt.HELP))
       {
          // print help message
          System.out.println(p.helpMessage());
          return; 
       }
       
       if(p.isSet(Opt.OUTDIR))
       {
           String outDir = p.getValue(Opt.OUTDIR);
       }
   }

Author:: leo

Constructor Summary
`OptionParser()` A constructor

Method Summary
`void`	`addOption(Option<OptionID> option)` Deprecated. use `addOption(Comparable, String, String, String, OptionHandler)` instead.
`void`	`addOption(OptionID optionID, String shortOptionName, String longOptionName, String description)` Adds an option to detect
`void`	`addOption(OptionID optionID, String shortOptionName, String longOptionName, String description, boolean presetValue)` Adds an option with the default argument (set or not set)
`void`	`addOption(OptionID optionID, String shortOptionName, String longOptionName, String description, OptionHandler handler)` Adds an option to detect
`void`	`addOptionGroup(OptionGroup<OptionID> optionGroup)` Adds an option group
`void`	`addOptionWithArgument(OptionID optionID, String shortOptionName, String longOptionName, String argumentName, String description)` Adds an option that takes an argument value
`void`	`addOptionWithArgument(OptionID optionID, String shortOptionName, String longOptionName, String argumentName, String description, OptionHandler<OptionID> handler)` Adds an option that takes an argument value
`void`	`addOptionWithArgument(OptionID optionID, String shortOptionName, String longOptionName, String argumentName, String description, String defaultValue)` Adds an option that takes an argument value
`void`	`addOptionWithArgument(OptionID optionID, String shortOptionName, String longOptionName, String argumentName, String description, String defaultValue, OptionHandler<OptionID> handler)` Adds an option that takes an argument value
`List<String>`	`getArgument()` ƒIƒvƒVƒ‡ƒ“ŠÖ˜AˆÈŠO‚ÌƒRƒ}ƒ“ƒhƒ‰ƒCƒ“‚Ìˆø”‚ÌƒŠƒXƒg‚ð“¾‚é
`String`	`getArgument(int index)` index”Ô–Ú‚ÌƒRƒ}ƒ“ƒhƒ‰ƒCƒ“ˆø”iƒIƒvƒVƒ‡ƒ“ˆÈŠOj
`int`	`getArgumentLength()` ƒIƒvƒVƒ‡ƒ“ˆÈŠO‚ÌƒRƒ}ƒ“ƒhƒ‰ƒCƒ“ˆø”‚Ì”‚ð•Ô‚·
`double`	`getDoubleValue(OptionID optionID)` optionˆø”‚Ì double’l
`float`	`getFloatValue(OptionID optionID)` optionˆø”‚Ìfloat’l
`int`	`getIntValue(OptionID optionID)` optionˆø”(—á:--width=100 ‚Ì100) ‚Ìint value
`String`	`getValue(OptionID optionID)` Gets the option argument value as a `String`
`String`	`getValue(OptionID optionID, String defaultValue)` Gets the option argument value as a `String`
`String`	`helpMessage()` Generates the help message for this option parser
`boolean`	`isSet(OptionID optionID)` “Á’è‚Ìoption‚ªƒZƒbƒg‚³‚ê‚Ä‚¢‚é‚©’²‚×‚é
`void`	`parse(String[] args)` Parses the command line arguments.
`void`	`setIgnoreUnknownOption(boolean ignore)`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

OptionParser

public OptionParser()

A constructor

Method Detail

addOption

public void addOption(OptionID optionID,
                      String shortOptionName,
                      String longOptionName,
                      String description)

Adds an option to detect

Parameters:: optionID - the option ID; shortOptionName - the short option name, e.g. "h", which corresponds to "-h" in the command line arguments.; longOptionName - the long option name, e.g. "help", which corresponds to "--help" in the command line arguments.; description - the description of the option, which is used to generate the help message of this option

addOption

public void addOption(OptionID optionID,
                      String shortOptionName,
                      String longOptionName,
                      String description,
                      OptionHandler handler)

Adds an option to detect

Parameters:: optionID - the option ID; shortOptionName - the short option name, e.g. "h", which corresponds to "-h" in the command line arguments.; longOptionName - the long option name, e.g. "help", which corresponds to "--help" in the command line arguments.; description - the description of the option, which is used to generate the help message of this option; handler - the option argument handler invoked when the option is set

addOption

public void addOption(Option<OptionID> option)

Deprecated. use addOption(Comparable, String, String, String, OptionHandler) instead.

Parameters:: option -

addOption

public void addOption(OptionID optionID,
                      String shortOptionName,
                      String longOptionName,
                      String description,
                      boolean presetValue)

Adds an option with the default argument (set or not set)

Parameters:: optionID - the option ID; shortOptionName - the short option name, e.g. "h", which corresponds to "-h" in the command line arguments.; longOptionName - the long option name, e.g. "help", which corresponds to "--help" in the command line arguments.; description - the description of the option, which is used to generate the help message of this option; presetValue - when true, the option is assumed to be set in default, otherwise false

addOptionWithArgument

public void addOptionWithArgument(OptionID optionID,
                                  String shortOptionName,
                                  String longOptionName,
                                  String argumentName,
                                  String description)

Adds an option that takes an argument value

Parameters:: optionID - the option ID; shortOptionName - the short option name, e.g. "h", which corresponds to "-h" in the command line arguments.; longOptionName - the long option name, e.g. "help", which corresponds to "--help" in the command line arguments.; description - the description of the option, which is used to generate the help message of this option

addOptionWithArgument

public void addOptionWithArgument(OptionID optionID,
                                  String shortOptionName,
                                  String longOptionName,
                                  String argumentName,
                                  String description,
                                  OptionHandler<OptionID> handler)

Adds an option that takes an argument value

Parameters:: optionID - the option ID; shortOptionName - the short option name, e.g. "h", which corresponds to "-h" in the command line arguments.; longOptionName - the long option name, e.g. "help", which corresponds to "--help" in the command line arguments.; description - the description of the option, which is used to generate the help message of this option; handler - the option argument handler invoked when the option is set

addOptionWithArgument

public void addOptionWithArgument(OptionID optionID,
                                  String shortOptionName,
                                  String longOptionName,
                                  String argumentName,
                                  String description,
                                  String defaultValue)

Adds an option that takes an argument value

Parameters:: optionID - the option ID; shortOptionName - the short option name, e.g. "h", which corresponds to "-h" in the command line arguments.; longOptionName - the long option name, e.g. "help", which corresponds to "--help" in the command line arguments.; description - the description of the option, which is used to generate the help message of this option; defaultValue - the default value of the option

addOptionWithArgument

public void addOptionWithArgument(OptionID optionID,
                                  String shortOptionName,
                                  String longOptionName,
                                  String argumentName,
                                  String description,
                                  String defaultValue,
                                  OptionHandler<OptionID> handler)

Adds an option that takes an argument value

Parameters:: optionID - the option ID; shortOptionName - the short option name, e.g. "h", which corresponds to "-h" in the command line arguments.; longOptionName - the long option name, e.g. "help", which corresponds to "--help" in the command line arguments.; description - the description of the option, which is used to generate the help message of this option; defaultValue - the default value of the option; handler - the option argument handler invoked when the option is set

addOptionGroup

public void addOptionGroup(OptionGroup<OptionID> optionGroup)

Adds an option group

Parameters:: optionGroup - the option group

parse

public void parse(String[] args)
           throws OptionParserException

Parses the command line arguments. After calling this method, you can retrieve the status of options via isSet(Comparable) or getValue(Comparable) methods, etc.

Parameters:: args - the command line arguments, which is given by the main(String[] args) method
Throws:: OptionParserException - when the given command line has invalid syntax or when incompatible options are set at the same time.

getArgument

public List<String> getArgument()

ƒIƒvƒVƒ‡ƒ“ŠÖ˜AˆÈŠO‚ÌƒRƒ}ƒ“ƒhƒ‰ƒCƒ“‚Ìˆø”‚ÌƒŠƒXƒg‚ð“¾‚é

Returns:: ƒIƒvƒVƒ‡ƒ“ŠÖ˜AˆÈŠO‚ÌƒRƒ}ƒ“ƒhƒ‰ƒCƒ“ˆø”‚ÌƒŠƒXƒg

getArgument

public String getArgument(int index)

index”Ô–Ú‚ÌƒRƒ}ƒ“ƒhƒ‰ƒCƒ“ˆø”iƒIƒvƒVƒ‡ƒ“ˆÈŠOj

Parameters:: index -
Returns:: index”Ô–Ú(0 origin)‚ÌƒIƒvƒVƒ‡ƒ“ŠÖ˜AˆÈŠO‚ÌƒRƒ}ƒ“ƒhƒ‰ƒCƒ“ˆø”

getArgumentLength

public int getArgumentLength()

ƒIƒvƒVƒ‡ƒ“ˆÈŠO‚ÌƒRƒ}ƒ“ƒhƒ‰ƒCƒ“ˆø”‚Ì”‚ð•Ô‚·

Returns:: ˆø”‚Ì”

isSet

public boolean isSet(OptionID optionID)
              throws OptionParserException

“Á’è‚Ìoption‚ªƒZƒbƒg‚³‚ê‚Ä‚¢‚é‚©’²‚×‚é

Parameters:: optionID -
Returns:: ƒRƒ}ƒ“ƒhƒ‰ƒCƒ“‚Å‚»‚ÌƒIƒvƒVƒ‡ƒ“‚ªŽg‚í‚ê‚Ä‚¢‚ê‚ÎTrueB‚»‚êˆÈŠO‚Ífalse
Throws:: OptionParserException - optionID‚ÉŠY“–‚·‚éƒIƒvƒVƒ‡ƒ“‚ªÝ’è‚³‚ê‚Ä‚¢‚È‚¢ê‡

getIntValue

public int getIntValue(OptionID optionID)
                throws OptionParserException

optionˆø”(—á:--width=100 ‚Ì100) ‚Ìint value

Parameters:: optionID -
Returns:: int’l
Throws:: OptionParserException - ŠY“–‚·‚éoptionID‚Í‚È‚¢A‚ ‚é‚¢‚Íˆø”‚ªint‚É•ÏŠ·‚Å‚«‚È‚¢ê‡A‚ ‚é‚¢‚Íˆø”‚ðŽæ‚ê‚È‚¢ƒIƒvƒVƒ‡ƒ“‚Ìê‡

getDoubleValue

public double getDoubleValue(OptionID optionID)
                      throws OptionParserException

optionˆø”‚Ì double’l

Parameters:: optionID -
Returns:: optionˆø”‚Ì double’l
Throws:: OptionParserException - ŠY“–‚·‚éoptionID‚Í‚È‚¢A‚ ‚é‚¢‚Íˆø”‚ªdouble‚É•ÏŠ·‚Å‚«‚È‚¢ê‡A‚ ‚é‚¢‚Íˆø”‚ðŽæ‚ê‚È‚¢ƒIƒvƒVƒ‡ƒ“‚Ìê‡

getFloatValue

public float getFloatValue(OptionID optionID)
                    throws OptionParserException

optionˆø”‚Ìfloat’l

Parameters:: optionID -
Returns:: optionˆø”‚Ìfloat’l
Throws:: OptionParserException - ŠY“–‚·‚éoptionID‚Í‚È‚¢A‚ ‚é‚¢‚Íˆø”‚ªfloat‚É•ÏŠ·‚Å‚«‚È‚¢ê‡A‚ ‚é‚¢‚Íˆø”‚ðŽæ‚ê‚È‚¢ƒIƒvƒVƒ‡ƒ“‚Ìê‡

getValue

public String getValue(OptionID optionID)
                throws OptionParserException

Gets the option argument value as a String

Parameters:: optionID - the target option that takes argument value
Returns:: the string value of the specified option argument
Throws:: OptionParserException - if the specified option ID is not found or if the option cannot take arguments

getValue

public String getValue(OptionID optionID,
                       String defaultValue)
                throws OptionParserException

Gets the option argument value as a String

Parameters:: optionID - the target option that takes argument value; defaultValue - the default value to be returned when this option is not present in the command line arguments
Returns:: the string value of the specified option argument
Throws:: OptionParserException - if the specified option ID is not found or if the option cannot take arguments

helpMessage

public String helpMessage()

Generates the help message for this option parser

Returns:: the help message that can be used as a list of command line options

setIgnoreUnknownOption

public void setIgnoreUnknownOption(boolean ignore)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

This work is licensed under a Creative Commons Attribution-ShareAlike 2.1 Japan License.

org.xerial.util.cui Class OptionParser<OptionID extends Comparable>

Usage:

OptionParser

addOption

addOption

addOption

addOption

addOptionWithArgument

addOptionWithArgument

addOptionWithArgument

addOptionWithArgument

addOptionGroup

parse

getArgument

getArgument

getArgumentLength

isSet

getIntValue

getDoubleValue

getFloatValue

getValue

getValue

helpMessage

setIgnoreUnknownOption

org.xerial.util.cui
Class OptionParser<OptionID extends Comparable>