Package org.spongepowered.api.util.annotation.eventgen

Annotation Interface PropertySettings

@Retention(RUNTIME) @Target(METHOD) public @interface PropertySettings
Used to specify the settings used when generating code for a property.

This annotation should always be placed on the getter method of a property.

  • Optional Element Summary Link icon

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    boolean
    generateMethods
    Indicates whether the annotated property should have methods generated for it.
    boolean
    requiredParameter
    Indicates whether the annotated property is required to be passed in to the generated constructor.

  • Element Details

    • requiredParameter Link icon

      boolean requiredParameter
      Indicates whether the annotated property is required to be passed in to the generated constructor.
      Returns:
      Whether the annotated property is required to be passed in to the generated constructor.
      Default:
      true

    • generateMethods Link icon

      boolean generateMethods
      Indicates whether the annotated property should have methods generated for it.

      If this value is set to true, requiredParameter() can only be set to false if the annotated property is a primitive.

      Returns:
      Whether the annotated property should have methods generated for it.
      Default:
      true