Package jaxx.compiler.decorators

Class HelpRootCompiledObjectDecorator

java.lang.Object
jaxx.compiler.decorators.DefaultCompiledObjectDecorator
jaxx.compiler.decorators.HelpRootCompiledObjectDecorator
All Implemented Interfaces:
CompiledObjectDecorator
@Component(role=CompiledObjectDecorator.class,
           hint="help")
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 - chemit@codelutin.com

  • Field Details

    • helpIds

      protected static java.util.Set<java.lang.String> helpIds
      the list of discovered helpId

  • Constructor Details

    • HelpRootCompiledObjectDecorator

      public HelpRootCompiledObjectDecorator()

  • Method Details

    • 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) throws java.lang.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:
      java.lang.ClassNotFoundException - if a class is not found

    • isNeedInterface

      protected boolean isNeedInterface​(JAXXCompiler compiler, java.lang.Class<?> validatorInterface) throws java.lang.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:
      java.lang.ClassNotFoundException - if could not find a class
      Since:
      2.4

    • getHelpIds

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