Package com.gtnewhorizons.gtnhgradle

Annotation Interface PropertiesConfiguration.Prop

Enclosing class:
PropertiesConfiguration
@Documented @Retention(RUNTIME) @Target(FIELD) public static @interface PropertiesConfiguration.Prop
Property metadata

  • Element Details

    • name

      @NotNull @NotNull String name
      Returns:
      Name of the property to search for

    • isSettings

      boolean isSettings
      Returns:
      Is the property is used globally across many projects from a settings.gradle context?
      Default:
      false

    • preferPopulated

      boolean preferPopulated
      Returns:
      Should the property's value be frozen in the properties file on plugin update?
      Default:
      true

    • required

      boolean required
      Returns:
      Should a missing value for this property raise an error?
      Default:
      false

    • hidden

      boolean hidden
      Returns:
      Should the property be hidden from properties if not already defined?
      Default:
      false

    • defaultInComment

      @NotNull @NotNull String defaultInComment
      Returns:
      The default value to put in a commented-out version of this property, default to actual default.
      Default:
      "!"

    • docComment

      @NotNull @NotNull String docComment
      Returns:
      User documentation for the property
      Default:
      ""