Interface TestFeature

All Superinterfaces:
DefaultFeature, io.micronaut.core.naming.Described, Feature, io.micronaut.core.naming.Named, io.micronaut.core.order.Ordered
All Known Subinterfaces:
All Known Implementing Classes:
Junit, KoTest, PicocliJunit, PicocliKoTest, PicocliSpock, Spock

public interface TestFeature extends DefaultFeature
  • Method Details

    • isVisible

      default boolean isVisible()
      Description copied from interface: Feature
      Some features should not be visible to the user because they are a common parent of other selectable features, or they should always be applied, or any other reason.
      Specified by:
      isVisible in interface Feature
      True if the feature should able to be selected by the user
    • getOrder

      default int getOrder()
      Description copied from interface: Feature
      The order of a feature controls the order in which it applies. The order of a feature is important to ensure that any previous work done by other features that may be required is done. See FeaturePhase for a list of phases to choose from.
      Specified by:
      getOrder in interface Feature
      Specified by:
      getOrder in interface io.micronaut.core.order.Ordered
      The order of the feature
    • apply

      default 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(ApplicationType, 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. This method can be implemented to modify the generated project. The feature can add templates by executing GeneratorContext.addTemplate(String, io.micronaut.starter.template.Template), modify configuration by modifying GeneratorContext.getConfiguration() or GeneratorContext.getBootstrapConfiguration(), or modify build properties through GeneratorContext.getBuildProperties().
      Specified by:
      apply in interface Feature
      generatorContext - THe generator context
    • doApply

      void doApply(GeneratorContext generatorContext)
    • getTestFramework

      TestFramework getTestFramework()
    • isJunit

      default boolean isJunit()
    • isSpock

      default boolean isSpock()
    • isKotlinTestFramework

      default boolean isKotlinTestFramework()
    • isKoTest

      default boolean isKoTest()
    • shouldApply

      default boolean shouldApply(ApplicationType applicationType, Options options, Set<Feature> selectedFeatures)
      Description copied from interface: DefaultFeature
      Determines if the feature should be applied to the project. Default features do not need to be concerned if the feature was already selected and therefore is already in the list of selected features. The addition to the set is based on the identity of the feature instance and all features are singletons.
      Specified by:
      shouldApply in interface DefaultFeature
      applicationType - The application type
      options - The options
      selectedFeatures - The features manually selected by the user
      True if the feature should apply
    • supports

      default boolean supports(ApplicationType applicationType)
      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
      applicationType - The application type
      True if the feature can be selected by the user