Package io.micronaut.starter.feature.picocli.lang.java

Class PicocliJavaApplication

java.lang.Object
io.micronaut.starter.feature.picocli.lang.java.PicocliJavaApplication
All Implemented Interfaces:
io.micronaut.core.naming.Described, io.micronaut.core.naming.Named, io.micronaut.core.order.Ordered, ApplicationFeature, Feature, JavaApplicationFeature
@Requires(property="micronaut.starter.feature.picocli.java.application.enabled", value="true", defaultValue="true") @Singleton public class PicocliJavaApplication extends Object implements JavaApplicationFeature
Feature for generating a Java-based CLI application using Picocli.

Creates a Picocli command as the main application class and configures the Java project accordingly.

  • Constructor Details

    • PicocliJavaApplication

      public PicocliJavaApplication()

  • Method Details

    • mainClassName

      @Nullable public @Nullable String mainClassName(GeneratorContext generatorContext)
      Specified by:
      mainClassName in interface ApplicationFeature

    • getName

      public String getName()
      Description copied from interface: Feature
      The name of the feature. It must be unique.
      Specified by:
      getName in interface Feature
      Specified by:
      getName in interface io.micronaut.core.naming.Named
      Returns:
      the name of the feature

    • supports

      public boolean supports(Options options)
      Description copied from interface: Feature
      This method must be implemented to ensure it is only selectable for the desired application types. This method is not used for determining if a default feature should be applied.
      Specified by:
      supports in interface Feature
      Parameters:
      options - Options
      Returns:
      True if the feature can be selected by the user

    • apply

      public void apply(GeneratorContext generatorContext)
      Description copied from interface: Feature
      If this method is called for a given feature that means the feature was explicitly selected, included by default as a result of DefaultFeature.shouldApply(io.micronaut.starter.options.Options, java.util.Set), or added explicitly by another feature through FeatureContext.addFeature(Feature). At this point the feature list is set and cannot change.
      Specified by:
      apply in interface ApplicationFeature
      Specified by:
      apply in interface Feature
      Parameters:
      generatorContext - THe generator context

    • getTemplate

      public RockerTemplate getTemplate(Project project)
      Returns the RockerTemplate for generating the Picocli application source file.
      Parameters:
      project - The project metadata.
      Returns:
      The Rocker template used to render the application source.

    • getPath

      protected String getPath()
      Returns the file path for the generated Picocli application source file.

      The path is relative to the project root and includes placeholders for the package path and class name, which are replaced during template rendering.

      Returns:
      the file path for the generated application source file