zserio.tools

Interface Extension

All Known Implementing Classes:

CppExtension, DocExtension, JavaExtension, PythonExtension, XmlExtension

public interface Extension

The basic interface for all Zserio extensions.

Method Summary

Modifier and Type	Method and Description
void	check(Root rootNode, ExtensionParameters parameters) Calls the extension to check Zserio tree.
java.lang.String	getExtensionVersion() Returns the version of Zserio extension.
java.lang.String	getName() Gets name of the extension.
java.lang.String	getZserioVersion() Returns the version of Zserio core which is expected by the extension.
boolean	isEnabled(ExtensionParameters parameters) Calls to check if the extension is enabled or not.
void	process(Root rootNode, ExtensionParameters parameters) Calls the extension to process Zserio tree.
void	registerOptions(org.apache.commons.cli.Options options) Registers all command line options that extension accepts.

Method Detail

getName

java.lang.String getName()

Gets name of the extension.

Returns:

Name of this extension.

getZserioVersion

java.lang.String getZserioVersion()

Returns the version of Zserio core which is expected by the extension. Zserio core checks if the current version can satisfy the extension (i.e. if the AST and common interfaces are compatible).

Returns:

Version string of Zserio core which is expected by the extension.

getExtensionVersion

java.lang.String getExtensionVersion()

Returns the version of Zserio extension.

Returns:

Version string of Zserio extension.

registerOptions

void registerOptions(org.apache.commons.cli.Options options)

Registers all command line options that extension accepts.

Parameters:

options - Instance where the options should be registered.

isEnabled

boolean isEnabled(ExtensionParameters parameters)

Calls to check if the extension is enabled or not.

Parameters:

parameters - The parameters to pass to extension.

Returns:

true if the extension is enabled, otherwise false.

check

void check(Root rootNode,
           ExtensionParameters parameters)
    throws ZserioExtensionException

Calls the extension to check Zserio tree. Extension does its basic checks on Zserio AST. Extensions which generate code should verify that it will be possible to generate the given schema correctly (e.g. checks reserved keywords, etc.). The caller (i.e. Zserio core) is responsible for calling the check() phase before process().

Parameters:

rootNode - The root node of Zserio tree to check.

parameters - The parameters to pass to extension.

Throws:

ZserioExtensionException - In case of any error in extension.

process

void process(Root rootNode,
             ExtensionParameters parameters)
      throws ZserioExtensionException

Calls the extension to process Zserio tree. The caller (i.e. Zserio core) is responsible for calling the check() phase before process().

Parameters:

rootNode - The root node of Zserio tree to process.

parameters - The parameters to pass to extension.

Throws:

ZserioExtensionException - In case of any error in extension.