Package org.gcube.informationsystem.types.annotations

Annotation Interface ISProperty

@Documented @Target(METHOD) @Retention(RUNTIME) public @interface ISProperty
It is used by TypeMapper to identify which getter method are related to and Entity PropertyDefinition. The name of the property is obtained by removing "get" or "is" from method name and lower casing the first letter.
Author:
Luca Frosini (ISTI - CNR)

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String
    defaultValue
    The default value of the property, as a string.
    String
    description
    A description of the property.
    boolean
    mandatory
    Whether the property is mandatory.
    int
    max
    The maximum value for a numeric property.
    int
    min
    The minimum value for a numeric property.
    String
    name
    The name of the property.
    boolean
    nullable
    Whether the property can be null.
    boolean
    readonly
    Whether the property is read-only.
    String
    regexpr
    A regular expression for validating a string property.
    Class<?>
    type
    The type of the property.

  • Element Details

    • name

      String name
      The name of the property.
      Returns:
      The name.
      Default:
      ""

    • type

      Class<?> type
      The type of the property.
      Returns:
      The type.
      Default:
      org.gcube.informationsystem.types.annotations.GetReturnType.class

    • description

      String description
      A description of the property.
      Returns:
      The description.
      Default:
      ""

    • mandatory

      boolean mandatory
      Whether the property is mandatory.
      Returns:
      true if mandatory.
      Default:
      false

    • readonly

      boolean readonly
      Whether the property is read-only.
      Returns:
      true if read-only.
      Default:
      false

    • nullable

      boolean nullable
      Whether the property can be null.
      Returns:
      true if nullable.
      Default:
      true

    • min

      int min
      The minimum value for a numeric property.
      Returns:
      The minimum value.
      Default:
      -1

    • max

      int max
      The maximum value for a numeric property.
      Returns:
      The maximum value.
      Default:
      -1

    • regexpr

      String regexpr
      A regular expression for validating a string property.
      Returns:
      The regular expression.
      Default:
      ""

    • defaultValue

      String defaultValue
      The default value of the property, as a string.
      Returns:
      The default value.
      Default:
      "null"