Package io.micronaut.sourcegen.generator.visitors

Record Class PluginUtils.ParameterConfig

java.lang.Object
java.lang.Record
io.micronaut.sourcegen.generator.visitors.PluginUtils.ParameterConfig
Record Components:
source - The source parameter
required - Whether it is required
defaultValue - The default value
internal - Whether it is internal
directory - Whether it is a directory
output - Whether it is an output and what output type
globalProperty - A global property
javadoc - The javadoc for property
type - The type to use for generated property
pathSensitivity - The path sensitivity
Enclosing class:
PluginUtils
public static record PluginUtils.ParameterConfig(@NonNull io.micronaut.inject.ast.PropertyElement source, boolean required, @Nullable String defaultValue, boolean internal, boolean directory, @NonNull PluginTaskParameter.OutputType output, @Nullable String globalProperty, @NonNull String javadoc, @NonNull io.micronaut.sourcegen.model.TypeDef type, @NonNull PluginTaskParameter.PathSensitivity pathSensitivity) extends Record
Configuration for a plugin parameter.

  • Constructor Details

    • ParameterConfig

      public ParameterConfig(@NonNull @NonNull io.micronaut.inject.ast.PropertyElement source, boolean required, @Nullable @Nullable String defaultValue, boolean internal, boolean directory, @NonNull @NonNull PluginTaskParameter.OutputType output, @Nullable @Nullable String globalProperty, @NonNull @NonNull String javadoc, @NonNull @NonNull io.micronaut.sourcegen.model.TypeDef type, @NonNull @NonNull PluginTaskParameter.PathSensitivity pathSensitivity)
      Creates an instance of a ParameterConfig record class.
      Parameters:
      source - the value for the source record component
      required - the value for the required record component
      defaultValue - the value for the defaultValue record component
      internal - the value for the internal record component
      directory - the value for the directory record component
      output - the value for the output record component
      globalProperty - the value for the globalProperty record component
      javadoc - the value for the javadoc record component
      type - the value for the type record component
      pathSensitivity - the value for the pathSensitivity record component

  • Method Details

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • source

      @NonNull public @NonNull io.micronaut.inject.ast.PropertyElement source()
      Returns the value of the source record component.
      Returns:
      the value of the source record component

    • required

      public boolean required()
      Returns the value of the required record component.
      Returns:
      the value of the required record component

    • defaultValue

      @Nullable public @Nullable String defaultValue()
      Returns the value of the defaultValue record component.
      Returns:
      the value of the defaultValue record component

    • internal

      public boolean internal()
      Returns the value of the internal record component.
      Returns:
      the value of the internal record component

    • directory

      public boolean directory()
      Returns the value of the directory record component.
      Returns:
      the value of the directory record component

    • output

      @NonNull public @NonNull PluginTaskParameter.OutputType output()
      Returns the value of the output record component.
      Returns:
      the value of the output record component

    • globalProperty

      @Nullable public @Nullable String globalProperty()
      Returns the value of the globalProperty record component.
      Returns:
      the value of the globalProperty record component

    • javadoc

      @NonNull public @NonNull String javadoc()
      Returns the value of the javadoc record component.
      Returns:
      the value of the javadoc record component

    • type

      @NonNull public @NonNull io.micronaut.sourcegen.model.TypeDef type()
      Returns the value of the type record component.
      Returns:
      the value of the type record component

    • pathSensitivity

      @NonNull public @NonNull PluginTaskParameter.PathSensitivity pathSensitivity()
      Returns the value of the pathSensitivity record component.
      Returns:
      the value of the pathSensitivity record component