Package io.github.vitalforge.persistlib.persistannotations

Annotation Interface Parameter

@Target(PARAMETER) @Retention(RUNTIME) public @interface Parameter
This annotation is used to mark a parameter that should be provided by the persisted data.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    boolean
    required
    Whether the parameter is required to be present in the persisted data.
    String
    value
    The key to use for the parameter in the persisted data.

  • Element Details

    • value

      String value
      The key to use for the parameter in the persisted data. If the value is not set, the parameter name will be used for searching the persisted data.
      Returns:
      The key to use for the parameter in the persisted data.
      See Also:
      Default:
      ""

    • required

      boolean required
      Whether the parameter is required to be present in the persisted data. If the value is `true` and the parameter is not present in the persisted data, the method will throw an exception.
      Returns:
      Whether the parameter is required to be present in the persisted data.
      Default:
      false