zserio.extension.doc

Class DocExtension

java.lang.Object

zserio.extension.doc.DocExtension

All Implemented Interfaces:

Extension

public final class DocExtension
extends java.lang.Object
implements Extension

The documentation extension. It generates HTML documentation together with SVG collaboration diagrams converted from generated dot files.

Constructor Summary

Constructors

Constructor and Description
DocExtension()

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.

Methods inherited from class java.lang.Object

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

Constructor Detail

DocExtension

public DocExtension()

Method Detail

getName

public java.lang.String getName()

Description copied from interface: Extension

Gets name of the extension.

Specified by:

getName in interface Extension

Returns:

Name of this extension.

getExtensionVersion

public java.lang.String getExtensionVersion()

Description copied from interface: Extension

Returns the version of Zserio extension.

Specified by:

getExtensionVersion in interface Extension

Returns:

Version string of Zserio extension.

getZserioVersion

public java.lang.String getZserioVersion()

Description copied from interface: Extension

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).

Specified by:

getZserioVersion in interface Extension

Returns:

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

registerOptions

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

Description copied from interface: Extension

Registers all command line options that extension accepts.

Specified by:

registerOptions in interface Extension

Parameters:

options - Instance where the options should be registered.

isEnabled

public boolean isEnabled(ExtensionParameters parameters)

Description copied from interface: Extension

Calls to check if the extension is enabled or not.

Specified by:

isEnabled in interface Extension

Parameters:

parameters - The parameters to pass to extension.

Returns:

true if the extension is enabled, otherwise false.

check

public void check(Root rootNode,
                  ExtensionParameters parameters)
           throws ZserioExtensionException

Description copied from interface: Extension

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().

Specified by:

check in interface Extension

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

public void process(Root rootNode,
                    ExtensionParameters parameters)
             throws ZserioExtensionException

Description copied from interface: Extension

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

Specified by:

process in interface Extension

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.