org.nuiton.jaxx.compiler.decorators

Class HelpRootCompiledObjectDecorator

java.lang.Object

org.nuiton.jaxx.compiler.decorators.DefaultCompiledObjectDecorator

org.nuiton.jaxx.compiler.decorators.HelpRootCompiledObjectDecorator

All Implemented Interfaces:

CompiledObjectDecorator

@AutoService(value=CompiledObjectDecorator.class)
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 Chemit - dev@tchemit.fr

Plexus component:

role-hint: "help" role: "org.nuiton.jaxx.compiler.CompiledObjectDecorator"

Field Summary

Fields

Modifier and Type	Field and Description
protected static Set<String>	helpIds the list of discovered helpId

Fields inherited from class org.nuiton.jaxx.compiler.decorators.DefaultCompiledObjectDecorator

log

Constructor Summary

Constructors

Constructor and Description
HelpRootCompiledObjectDecorator()

Method Summary

Modifier and Type	Method and Description
void	finalizeCompiler(JAXXCompiler compiler, CompiledObject root, CompiledObject object, JavaFile javaFile, String packageName, String className, String fullClassName) Finalize the given compiled object before any generation in the file.
protected String	getBrokerFQN(JAXXCompiler compiler)
protected String	getHelpId(CompiledObject o)
static Set<String>	getHelpIds()
String	getName()
protected boolean	isNeedInterface(JAXXCompiler compiler, Class<?> validatorInterface) Detects if the given compiler need the validatorInterface.

Methods inherited from class org.nuiton.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 final Set<String> helpIds

the list of discovered helpId

Constructor Detail

HelpRootCompiledObjectDecorator

public HelpRootCompiledObjectDecorator()

Method Detail

getName

public 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 String getBrokerFQN(JAXXCompiler compiler)

getHelpId

protected String getHelpId(CompiledObject o)

finalizeCompiler

public void finalizeCompiler(JAXXCompiler compiler,
                             CompiledObject root,
                             CompiledObject object,
                             JavaFile javaFile,
                             String packageName,
                             String className,
                             String fullClassName)
                      throws ClassNotFoundException

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

Throws:

ClassNotFoundException - if a class is not found

isNeedInterface

protected boolean isNeedInterface(JAXXCompiler compiler,
                                  Class<?> validatorInterface)
                           throws ClassNotFoundException

Detects if the given compiler need the validatorInterface. We need to test it deeply since the interface is added by the decorator and is not present on the symbol table of compiled objects.

Parameters:

compiler - the compiler to test

validatorInterface - the validator interface to seek for

Returns:

true if we need to add the interface, false otherwise

Throws:

ClassNotFoundException - if could not find a class

Since:

2.4

getHelpIds

public static Set<String> getHelpIds()