com.google.api.tools.framework.tools

Class GenericToolDriverBase

java.lang.Object

com.google.api.tools.framework.tools.GenericToolDriverBase

Direct Known Subclasses:

ToolDriverBase

public abstract class GenericToolDriverBase
extends java.lang.Object

Abstract base class for drivers running tools based on the framework.

Uses ToolOptions to pass arguments to the driver.

Field Summary

Fields

Modifier and Type	Field and Description
protected DiagCollector	diags
protected ToolOptions	options

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	GenericToolDriverBase(ToolOptions options)
protected	GenericToolDriverBase(ToolOptions options, DiagCollector diags)

Method Summary

Modifier and Type	Method and Description
protected java.lang.String	concatenateNonEmptyStrings(java.lang.String separator, java.lang.String... parts)
protected java.lang.String	getDataPath() Returns the data path, including as specified by options and platform dependent defaults.
DiagCollector	getDiagCollector()
ToolOptions	getOptions() Returns options.
protected void	onErrorsExit() Report any errors and exit if there were some.
protected abstract void	process() Method implementing the actual tool processing.
protected void	reportDiag() Report errors and warnings.
int	run() Runs the tool.
protected void	setDiagCollector(DiagCollector diags) Sets the DiagCollector for this tool to use.

Methods inherited from class java.lang.Object

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

Field Detail

options

protected final ToolOptions options

diags

protected DiagCollector diags

Constructor Detail

GenericToolDriverBase

protected GenericToolDriverBase(ToolOptions options)

GenericToolDriverBase

protected GenericToolDriverBase(ToolOptions options,
                                DiagCollector diags)

Method Detail

getOptions

public ToolOptions getOptions()

Returns options.

setDiagCollector

protected void setDiagCollector(DiagCollector diags)

Sets the DiagCollector for this tool to use. TODO(user): The _ONLY_ reason this is here is for cases where the DiagCollector is instantiated after the tool is instantiated (e.g. using a Model's DiagCollector) that is refactored, this setDiagCollector() should be removed...so prefer passing it into the ctor when needed.

getDiagCollector

public DiagCollector getDiagCollector()

process

protected abstract void process()
                         throws java.lang.Exception

Method implementing the actual tool processing.

Throws:

java.lang.Exception

run

public int run()

Runs the tool. Returns a non-zero exit code on errors.

getDataPath

protected java.lang.String getDataPath()

Returns the data path, including as specified by options and platform dependent defaults.

concatenateNonEmptyStrings

protected java.lang.String concatenateNonEmptyStrings(java.lang.String separator,
                                                      java.lang.String... parts)

onErrorsExit

protected void onErrorsExit()

Report any errors and exit if there were some.

reportDiag

protected void reportDiag()

Report errors and warnings.