com.google.api.tools.framework.tools

Class ToolDriverBase

java.lang.Object

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

com.google.api.tools.framework.tools.ToolDriverBase

Direct Known Subclasses:

ConfigGeneratorFromProtoDescriptor

public abstract class ToolDriverBase
extends GenericToolDriverBase

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 Model	model

Fields inherited from class com.google.api.tools.framework.tools.GenericToolDriverBase

diags, options

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ToolDriverBase(ToolOptions options)

Method Summary

Modifier and Type	Method and Description
java.util.List<Diag>	getDiags() Returns diagnosis, including errors and warnings.
Model	getModel() Returns the model.
protected com.google.protobuf.ExtensionRegistry	getPlatformExtensions() Get the extension registry to use for processing service config.
boolean	hasErrors() Check if there are any errors.
protected void	onErrorsExit() Report any errors and exit if there were some.
protected abstract void	registerAspects() Registers aspects for this tool.
protected abstract void	registerProcessors() Registers processors for this tool.
int	run() Runs the tool.

Methods inherited from class com.google.api.tools.framework.tools.GenericToolDriverBase

concatenateNonEmptyStrings, getDataPath, getDiagCollector, getOptions, process, reportDiag, setDiagCollector

Methods inherited from class java.lang.Object

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

Field Detail

model

protected Model model

Constructor Detail

ToolDriverBase

protected ToolDriverBase(ToolOptions options)

Method Detail

getModel

@Nullable
public Model getModel()

Returns the model.

hasErrors

public boolean hasErrors()

Check if there are any errors.

getDiags

public java.util.List<Diag> getDiags()

Returns diagnosis, including errors and warnings.

getPlatformExtensions

protected com.google.protobuf.ExtensionRegistry getPlatformExtensions()

Get the extension registry to use for processing service config. By default, registers extensions from google/api/annotations.proto. Can be overridden by sub-classes.

registerProcessors

protected abstract void registerProcessors()

Registers processors for this tool.

registerAspects

protected abstract void registerAspects()

Registers aspects for this tool.

run

public int run()

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

Overrides:

run in class GenericToolDriverBase

onErrorsExit

protected void onErrorsExit()

Report any errors and exit if there were some.

Overrides:

onErrorsExit in class GenericToolDriverBase