Package jaxx.compiler

Interface CompilerConfiguration

All Known Implementing Classes:
DefaultCompilerConfiguration
public interface CompilerConfiguration
Configuration of a compiler task.
Since:
2.0.0
Author:
Tony Chemit - chemit@codelutin.com

  • Field Details

    • DEFAULT_CSS_EXTENSION

      static final java.lang.String DEFAULT_CSS_EXTENSION
      Default css file extension.
      Since:
      2.28
      See Also:
      Constant Field Values

  • Method Details

    • getClassLoader

      java.lang.ClassLoader getClassLoader()
      Returns:
      the class loader used by compilers

    • getCompilerClass

      java.lang.Class<? extends JAXXCompiler> getCompilerClass()
      Returns:
      the type of compiler to use

    • getDefaultDecoratorClass

      java.lang.Class<? extends CompiledObjectDecorator> getDefaultDecoratorClass()
      Returns:
      the type of default decorator to use if none specified

    • getDefaultErrorUI

      java.lang.Class<?> getDefaultErrorUI()
      Returns:
      the type of the default error UI to use for validation

    • getExtraImports

      java.lang.String[] getExtraImports()
      Returns:
      extra imports to add on all generated jaxx object

    • getHelpBrokerFQN

      java.lang.String getHelpBrokerFQN()
      Returns:
      the FQN of the help broker (can not directly a type since the help broker should (may?) be inside the sources.

    • getValidatorFactoryFQN

      java.lang.String getValidatorFactoryFQN()
      Returns:
      the FQN of the validator factory used to instanciate new validators.
      Since:
      2.6

    • getJaxxContextClass

      java.lang.Class<? extends JAXXContext> getJaxxContextClass()
      Returns:
      the type of context to use in each generated jaxx object

    • getOptimize

      boolean getOptimize()
      Returns whether or not optimization should be performed.
      Returns:
      whether or not optimizations should be performed

    • isAutoRecurseInCss

      boolean isAutoRecurseInCss()
      Returns whether or not should recurse in css for existing JAXX Object. Note: This functionnality was here at the beginning of the project but offers nothing very usefull, will be remove probably in JAXX 3.0.
      Returns:
      true if a css file with same name as jaxx file should be included in jaxx file if found.
      Since:
      2.0.2

    • getTargetDirectory

      java.io.File getTargetDirectory()
      Returns the target directory.
      Returns:
      the target directory

    • isAddLogger

      boolean isAddLogger()
      Returns:
      true if a logger must add on each generated jaxx object

    • isGenerateHelp

      boolean isGenerateHelp()
      Returns:
      true if we are generating help

    • isI18nable

      boolean isI18nable()
      Returns:
      true if we use the i18n system

    • isOptimize

      boolean isOptimize()
      Returns:
      true to generate optimized code

    • isProfile

      boolean isProfile()
      Returns:
      true if a profile pass must be done

    • isResetAfterCompile

      boolean isResetAfterCompile()
      Returns:
      true if states must be reset after the compilation

    • isUseUIManagerForIcon

      boolean isUseUIManagerForIcon()
      Returns:
      true if UIManager is used to retrieve icons

    • isVerbose

      boolean isVerbose()
      Returns:
      true if compiler is verbose

    • isShowClassDescriptorLoading

      boolean isShowClassDescriptorLoading()
      Returns:
      true to trace the Class descriptor loading.
      Since:
      2.4

    • isAddAutoHandlerUI

      boolean isAddAutoHandlerUI()
      Returns:
      true to detect and add UIHandler if found in class-path.
      Since:
      2.6

    • setAddAutoHandlerUI

      void setAddAutoHandlerUI​(boolean addAutoHandlerUI)
      Parameters:
      addAutoHandlerUI - new value of the state
      Since:
      2.6

    • isGenerateMissingIdsAndStyleClassesInCss

      boolean isGenerateMissingIdsAndStyleClassesInCss()
      Returns:
      true to generate missing ids and style classes in the CSS files
      Since:
      2.29

    • setGenerateMissingIdsAndStyleClassesInCss

      void setGenerateMissingIdsAndStyleClassesInCss​(boolean generateMissingIdsAndStyleClassesInCss)
      Parameters:
      generateMissingIdsAndStyleClassesInCss - new value of the state
      Since:
      2.29

    • getEncoding

      java.lang.String getEncoding()
      Returns:
      the encoding to use to write files

    • getDecorators

      java.util.Map<java.lang.String,​CompiledObjectDecorator> getDecorators()

    • getFinalizers

      java.util.Map<java.lang.String,​JAXXCompilerFinalizer> getFinalizers()

    • getInitializers

      java.util.Map<java.lang.String,​Initializer> getInitializers()

    • getCommonCss

      java.io.File getCommonCss()
      Returns:
      the optional common css to inject in all JaxxCompiler.
      Since:
      2.13

    • getCssExtension

      java.lang.String getCssExtension()
      Returns:
      the extension of css files (by default use DEFAULT_CSS_EXTENSION as before).
      Since:
      2.28