Package edu.umd.cs.findbugs

Class TextUICommandLine

java.lang.Object

edu.umd.cs.findbugs.config.CommandLine

edu.umd.cs.findbugs.FindBugsCommandLine

edu.umd.cs.findbugs.TextUICommandLine

public class TextUICommandLine
extends FindBugsCommandLine

Helper class to parse the command line and configure the IFindBugsEngine object. As a side-effect it also configures a DetectorFactoryCollection (to enable and disable detectors as requested).

Nested Class Summary

Nested classes/interfaces inherited from class edu.umd.cs.findbugs.config.CommandLine

CommandLine.HelpRequestedException

Field Summary

Fields

Modifier and Type	Field	Description
protected java.io.File	outputFile

Fields inherited from class edu.umd.cs.findbugs.FindBugsCommandLine

project, projectLoadedFromFile, settingList

Constructor Summary

Constructors

Constructor	Description
TextUICommandLine()	Constructor.

Method Summary

Modifier and Type	Method	Description
boolean	applySuppression()
void	configureEngine(IFindBugsEngine findBugs)
Project	getProject()
boolean	getXargs()
protected void	handleOption(java.lang.String option, java.lang.String optionExtraPart)	Callback method for handling an option.
protected void	handleOptionWithArgument(java.lang.String option, java.lang.String argument)	Callback method for handling an option with an argument.
void	handleXArgs()	Handle -xargs command line option by reading jar file names from standard input and adding them to the project.
boolean	justPrintConfiguration()
boolean	justPrintVersion()
boolean	noClassOk()
boolean	quiet()
boolean	setExitCode()

Methods inherited from class edu.umd.cs.findbugs.FindBugsCommandLine

getSettingList, isProjectLoadedFromFile, loadProject

Methods inherited from class edu.umd.cs.findbugs.config.CommandLine

addOption, addSwitch, addSwitchWithOptionalExtraPart, expandOptionFiles, getAnalysisOptionProperties, makeOptionUnlisted, parse, parse, printUsage, startOptionGroup

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

outputFile

@CheckForNull
protected java.io.File outputFile

Constructor Detail

TextUICommandLine

public TextUICommandLine()

Constructor.

Method Detail

getProject

@Nonnull
public Project getProject()

Overrides:

getProject in class FindBugsCommandLine

getXargs

public boolean getXargs()

setExitCode

public boolean setExitCode()

noClassOk

public boolean noClassOk()

quiet

public boolean quiet()

applySuppression

public boolean applySuppression()

justPrintConfiguration

public boolean justPrintConfiguration()

justPrintVersion

public boolean justPrintVersion()

handleOption

protected void handleOption(java.lang.String option,
                            java.lang.String optionExtraPart)

Description copied from class: CommandLine

Callback method for handling an option.

Overrides:

handleOption in class FindBugsCommandLine

Parameters:

option - the option

optionExtraPart - 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

handleOptionWithArgument

protected void handleOptionWithArgument(java.lang.String option,
                                        java.lang.String argument)
                                 throws java.io.IOException

Description copied from class: CommandLine

Callback method for handling an option with an argument.

Overrides:

handleOptionWithArgument in class FindBugsCommandLine

Parameters:

option - the option

argument - the argument

Throws:

java.io.IOException

configureEngine

public void configureEngine(IFindBugsEngine findBugs)
                     throws java.io.IOException,
                            FilterException

Throws:

java.io.IOException

FilterException

handleXArgs

public void handleXArgs()
                 throws java.io.IOException

Handle -xargs command line option by reading jar file names from standard input and adding them to the project.

Throws:

java.io.IOException