jaxx.compiler.decorators
Class HelpRootCompiledObjectDecorator

java.lang.Object
  jaxx.compiler.decorators.DefaultCompiledObjectDecorator
      jaxx.compiler.decorators.HelpRootCompiledObjectDecorator

All Implemented Interfaces:

CompiledObjectDecorator

public class HelpRootCompiledObjectDecorator
extends DefaultCompiledObjectDecorator

A decorator to place on a root compiled object to process javaHelp on the file.

Since:

1.2

Author:

tony

Field Summary

protected static java.util.Set<java.lang.String>

helpIds the list of discovered helpId

Constructor Summary

HelpRootCompiledObjectDecorator()

Method Summary

void	finalizeCompiler(JAXXCompiler compiler, CompiledObject root, CompiledObject object, JavaFile javaFile, java.lang.String packageName, java.lang.String className, java.lang.String fullClassName) Finalize the given compiled object before any generation in the file.
protected java.lang.String	getBrokerFQN(JAXXCompiler compiler)
protected java.lang.String	getHelpId(CompiledObject o)
static java.util.Set<java.lang.String>	getHelpIds()
java.lang.String	getName()

Methods inherited from class jaxx.compiler.decorators.DefaultCompiledObjectDecorator

addClientProperties, createCompleteSetupMethod, createInitializer, getCreationCode

Methods inherited from class java.lang.Object

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

Field Detail

helpIds

protected static java.util.Set<java.lang.String> helpIds

the list of discovered helpId

Constructor Detail

HelpRootCompiledObjectDecorator

public HelpRootCompiledObjectDecorator()

Method Detail

getName

public java.lang.String getName()

Specified by:

getName in interface CompiledObjectDecorator

Overrides:

getName in class DefaultCompiledObjectDecorator

Returns:

the name of the decorator (match the content of a decorator attribute value in a JAXX file)

getBrokerFQN

protected java.lang.String getBrokerFQN(JAXXCompiler compiler)

getHelpId

protected java.lang.String getHelpId(CompiledObject o)

finalizeCompiler

public void finalizeCompiler(JAXXCompiler compiler,
                             CompiledObject root,
                             CompiledObject object,
                             JavaFile javaFile,
                             java.lang.String packageName,
                             java.lang.String className,
                             java.lang.String fullClassName)

Description copied from interface: CompiledObjectDecorator

Finalize the given compiled object before any generation in the file.

Specified by:

finalizeCompiler in interface CompiledObjectDecorator

Overrides:

finalizeCompiler in class DefaultCompiledObjectDecorator

Parameters:

compiler - the compiler to use

root - the root compiled object of the jaxx file

object - the compiled object to treate

javaFile - the file to treate

packageName - the package name

className - the (simple ?) class name

fullClassName - the fully class name

getHelpIds

public static java.util.Set<java.lang.String> getHelpIds()