Module eclipselink
Package org.eclipse.persistence.annotations

Annotation Interface Property

@Target({METHOD,FIELD,TYPE}) @Retention(RUNTIME) @Repeatable(Properties.class) public @interface Property
Annotation for a user defined property. A single Property may be specified directly on a mapped attribute or its get/set method. Multiple occurrences of Property annotation can be wrapped into Properties annotation.

Property may be assigned to either a mapped attribute (or its get/set method) within Entity, MappedSuperclass and Embeddable class; or to Entity, MappedSuperclass and Embeddable class.

In case orm xml is used Property and Properties annotations specified on mapped attributes are ignored, specified on a class are merged with the ones specified in orm xml with the latter taking precedence in case of conflicts.

Properties defined in MappedSuperclass are passed to all inheriting Entities and MappedSuperclasses. In case of a conflict property value defined directly on a class always overrides the value passed from class's parent.

See Also:
Author:
Andrei Ilitchev

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    String
    name
    Property name.
    String
    value
    String representation of Property value, converted to an instance of valueType().

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    Class<?>
    valueType
    Property value type.

  • Element Details

    • name

      String name
      Property name.

    • value

      String value
      String representation of Property value, converted to an instance of valueType().

    • valueType

      Class<?> valueType
      Property value type. The value is converted to valueType by ConversionManager.

      If specified must be a simple type that could be handled by ConversionManager: numerical, boolean, temporal.

      Default:
      java.lang.String.class