Package org.openrewrite.config

Class DeclarativeRecipe

  • public class DeclarativeRecipe
extends Recipe

    • Constructor Detail

      • DeclarativeRecipe

        public DeclarativeRecipe()

    • Method Detail

      • getDisplayName

        public java.lang.String getDisplayName()
        Description copied from class: Recipe
        A human-readable display name for the recipe, initial capped with no period. For example, "Find text". The display name can be assumed to be rendered in documentation and other places where markdown is understood, so it is possible to use stylistic markers like backticks to indicate types. For example, "Find uses of `java.util.List`".
        Specified by:
        getDisplayName in class Recipe
        Returns:
        The display name.

      • getDescription

        public java.lang.String getDescription()
        Description copied from class: Recipe
        A human-readable description for the recipe, consisting of one or more full sentences ending with a period.

        "Find methods by pattern." is an example. The description can be assumed to be rendered in documentation and other places where markdown is understood, so it is possible to use stylistic markers like backticks to indicate types. For example, "Find uses of `java.util.List`.".

        Overrides:
        getDescription in class Recipe
        Returns:
        The display name.

      • getTags

        public java.util.Set<java.lang.String> getTags()
        Description copied from class: Recipe
        A set of strings used for categorizing related recipes. For example "testing", "junit", "spring". Tags should not include information about the language(s) this recipe is applicable to. See Recipe.getLanguages() instead. Any individual tag should consist of a single word, all lowercase.
        Overrides:
        getTags in class Recipe
        Returns:
        The tags.

      • validate

        public Validated validate()
        Description copied from class: Recipe
        The default implementation of validate on the recipe will look for package and field level annotations that indicate a field is not-null. The annotations must have run-time retention and the simple name of the annotation must match one of the common names defined in NullUtils
        Overrides:
        validate in class Recipe
        Returns:
        A validated instance based using non-null/nullable annotations to determine which fields of the recipe are required.

      • getName

        public java.lang.String getName()
        Overrides:
        getName in class Recipe