Package io.micronaut.data.annotation

Annotation Interface MappedProperty

@Retention(RUNTIME) @Target({ANNOTATION_TYPE,FIELD,METHOD}) @Documented public @interface MappedProperty
Designates a method or field that is mapped as a persistent property. Typically not used directly but as a meta-annotation.
Since:
1.0
Author:
graemerocher

  • Field Details

    • ALIAS

      static final String ALIAS
      name of the meta-annotation member to store the mapped property (column) alias configuration.
      See Also:

  • Element Details

    • value

      String value
      The destination the property is persisted to. This could be the column name etc. or some external form.
      Returns:
      The destination
      Default:
      ""

    • type

      @AliasFor(annotation=TypeDef.class, member="type") DataType type
      Returns:
      The data type of the property.
      Default:
      OBJECT

    • converter

      @AliasFor(annotation=TypeDef.class, member="converter") Class<?> converter
      Returns:
      The converter of the property.
      Default:
      java.lang.Object.class

    • converterPersistedType

      Class<?> converterPersistedType
      Returns:
      The converter of the property.
      Default:
      java.lang.Object.class

    • definition

      String definition
      Used to define the mapping. For example in the case of SQL this would be the column definition. Example: BLOB NOT NULL.
      Returns:
      A string-based definition of the property type.
      Default:
      ""

    • alias

      String alias
      Returns:
      The column alias to use for the query
      Since:
      3.8.0
      Default:
      ""