|
FindBugs™ 1.3.9 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectedu.umd.cs.findbugs.config.CommandLine
public abstract class CommandLine
Helper class for parsing command line arguments.
Nested Class Summary | |
---|---|
static class |
CommandLine.HelpRequestedException
|
Constructor Summary | |
---|---|
CommandLine()
|
Method Summary | |
---|---|
void |
addOption(java.lang.String option,
java.lang.String argumentDesc,
java.lang.String description)
Add an option requiring an argument. |
void |
addSwitch(java.lang.String option,
java.lang.String description)
Add a command line switch. |
void |
addSwitchWithOptionalExtraPart(java.lang.String option,
java.lang.String optionExtraPartSynopsis,
java.lang.String description)
Add a command line switch that allows optional extra information to be specified as part of it. |
java.lang.String[] |
expandOptionFiles(java.lang.String[] argv,
boolean ignoreComments,
boolean ignoreBlankLines)
Expand option files in given command line. |
static java.util.ArrayList<java.lang.String> |
getAnalysisOptionProperties(boolean ignoreComments,
boolean ignoreBlankLines)
|
protected abstract void |
handleOption(java.lang.String option,
java.lang.String optionExtraPart)
Callback method for handling an option. |
protected abstract void |
handleOptionWithArgument(java.lang.String option,
java.lang.String argument)
Callback method for handling an option with an argument. |
void |
makeOptionUnlisted(java.lang.String option)
Don't list this option when printing Usage information |
int |
parse(java.lang.String[] argv)
Parse a command line. |
int |
parse(java.lang.String[] argv,
int minArgs,
int maxArgs,
java.lang.String usage)
Parse switches/options, showing usage information if they can't be parsed, or if we have the wrong number of remaining arguments after parsing. |
void |
printUsage(java.io.OutputStream os)
Print command line usage information to given stream. |
void |
startOptionGroup(java.lang.String description)
Start a new group of related command-line options. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public CommandLine()
Method Detail |
---|
public void startOptionGroup(java.lang.String description)
description
- description of the grouppublic void addSwitch(java.lang.String option, java.lang.String description)
option
- the option, must start with "-"description
- single line description of the optionpublic void addSwitchWithOptionalExtraPart(java.lang.String option, java.lang.String optionExtraPartSynopsis, java.lang.String description)
option
- the option, must start with "-"optionExtraPartSynopsis
- synopsis of the optional extra informationdescription
- single-line description of the optionpublic void addOption(java.lang.String option, java.lang.String argumentDesc, java.lang.String description)
option
- the option, must start with "-"argumentDesc
- brief (one or two word) description of the argumentdescription
- single line description of the optionpublic void makeOptionUnlisted(java.lang.String option)
option
- public java.lang.String[] expandOptionFiles(java.lang.String[] argv, boolean ignoreComments, boolean ignoreBlankLines) throws java.io.IOException, CommandLine.HelpRequestedException
argv
- the original command lineignoreComments
- ignore comments (lines starting with "#")ignoreBlankLines
- ignore blank lines
java.io.IOException
CommandLine.HelpRequestedException
public static java.util.ArrayList<java.lang.String> getAnalysisOptionProperties(boolean ignoreComments, boolean ignoreBlankLines)
public int parse(java.lang.String[] argv, int minArgs, int maxArgs, java.lang.String usage)
argv
- command line argumentsminArgs
- allowed minimum number of arguments remaining after
switches/options are parsedmaxArgs
- allowed maximum number of arguments remaining after
switches/options are parsedusage
- usage synopsis
public int parse(java.lang.String[] argv) throws java.io.IOException, CommandLine.HelpRequestedException
argv
- the arguments
CommandLine.HelpRequestedException
java.io.IOException
protected abstract void handleOption(java.lang.String option, java.lang.String optionExtraPart) throws java.io.IOException
option
- the optionoptionExtraPart
- the "extra" part of the option (everything after the
colon: e.g., "withMessages" in "-xml:withMessages");
the empty string if there was no extra part
java.io.IOException
protected abstract void handleOptionWithArgument(java.lang.String option, java.lang.String argument) throws java.io.IOException
option
- the optionargument
- the argument
java.io.IOException
public void printUsage(java.io.OutputStream os)
os
- the output stream
|
FindBugs™ 1.3.9 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |