Class GeneratorContext

java.lang.Object
io.micronaut.projectgen.core.generator.GeneratorContext

public class GeneratorContext extends Object
A context object used when generating projects.
Since:
1.0.0
Author:
graemerocher
  • Field Details

  • Constructor Details

  • Method Details

    • getRootModule

      public ModuleContext getRootModule()
    • getModuleByName

      public ModuleContext getModuleByName(String name)
    • getLanguage

      @NonNull public @NonNull Language getLanguage()
      Returns:
      The language
    • getOptions

      @NonNull public @NonNull Options getOptions()
      Returns:
      Options
    • getBuildTool

      @Deprecated(forRemoval=true) @NonNull public @NonNull BuildTool getBuildTool()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Returns:
      The test framework
    • getTestFramework

      @NonNull public @NonNull TestFramework getTestFramework()
      Returns:
      The test framework
    • getProject

      @NonNull public @NonNull Project getProject()
      Returns:
      The project
    • getFeatures

      @NonNull public @NonNull Features getFeatures()
      Returns:
      The selected features
    • getJdkVersion

      @NonNull public @NonNull JdkVersion getJdkVersion()
      Returns:
      The JDK version
    • applyFeatures

      public void applyFeatures()
      Apply features.
    • isFeaturePresent

      public boolean isFeaturePresent(Class<? extends Feature> feature)
      Parameters:
      feature - Feature is present
      Returns:
      Whether the feature is present
    • isFeatureMissing

      public boolean isFeatureMissing(Class<? extends Feature> feature)
      Parameters:
      feature - Feature is present
      Returns:
      Whether the feature is missing
    • getFeature

      public <T extends Feature> Optional<T> getFeature(Class<T> feature)
      Type Parameters:
      T - feature Type
      Parameters:
      feature - Feature is present
      Returns:
      the feature
    • getRequiredFeature

      public <T extends Feature> T getRequiredFeature(Class<T> feature)
      Type Parameters:
      T - feature Type
      Parameters:
      feature - Feature is present
      Returns:
      the feature
    • getSourcePath

      public String getSourcePath(String path)
      Parameters:
      path - Path
      Returns:
      source path
    • getTestSourcePath

      public String getTestSourcePath(String path)
      Parameters:
      path - Path
      Returns:
      test path
    • resolveCoordinate

      public Coordinate resolveCoordinate(String artifactId)
      Parameters:
      artifactId - Artifact ID
      Returns:
      The coordinate
    • getModuleNames

      public Collection<String> getModuleNames()
      Returns:
      Module Names
    • hasFeature

      public <T extends Feature> boolean hasFeature(Class<T> featureClass)
      Type Parameters:
      T - feature Type
      Parameters:
      featureClass - Feature class
      Returns:
      Whether the feature is present
    • findFrameworkDocumentationByRecipeName

      public Optional<String> findFrameworkDocumentationByRecipeName(@NonNull @NonNull String recipeName)
      Parameters:
      recipeName - recipe Name
      Returns:
      documentation
    • findThirdPartyDocumentationByRecipeName

      public Optional<String> findThirdPartyDocumentationByRecipeName(@NonNull @NonNull String recipeName)
      Parameters:
      recipeName - recipe Name
      Returns:
      documentation