Module io.helidon.pico.tools
Package io.helidon.pico.tools

Interface GeneralCreatorRequest

All Superinterfaces:
GeneralCodeGenNames
All Known Subinterfaces:
ActivatorCreatorRequest, ApplicationCreatorRequest, ExternalModuleCreatorRequest
public interface GeneralCreatorRequest extends GeneralCodeGenNames
Base interface codegen-related requests.

  • Method Details

    • analysisOnly

      boolean analysisOnly()
      Set to true to avoid code-generating, and instead provide the plan for what would be built.
      Returns:
      if set to true then no codegen will occur on disk

    • codeGenPaths

      CodeGenPaths codeGenPaths()
      Where codegen should be read and written.
      Returns:
      the code paths to use for reading and writing artifacts

    • compilerOptions

      Optional<CompilerOptions> compilerOptions()
      Optionally, any compiler options to pass explicitly to the java compiler. Not applicable during annotation processing.
      Returns:
      explicit compiler options

    • serviceTypeNames

      List<TypeName> serviceTypeNames()
      The target fully qualified class name for the service implementation to be built or analyzed.

      Assumptions:

      • The service type is available for reflection/introspection at creator invocation time (typically at compile time).
      Returns:
      the collection of service type names to generate

    • throwIfError

      boolean throwIfError()
      Should exceptions be thrown, or else captured in the response under GeneralCreatorResponse.error(). The default is true.
      Returns:
      true if the creator should fail, otherwise the response will show the error

    • generator

      Optional<String> generator()
      Provides the generator (used to append to code generated artifacts in javax.annotation.processing.Generated annotations).
      Returns:
      the generator name

    • filer

      CodeGenFiler filer()
      The code gen filer to use.
      Returns:
      the code gen filer