org.eclipse.persistence.annotations

Annotation Type Property

@Target(value={METHOD,FIELD,TYPE})
 @Retention(value=RUNTIME)
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 Properties should 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 an 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:

Embeddable, Entity, Id, Basic, ManyToMany, ManyToOne, MappedSuperclass, OneToMany, OneToOne, BasicCollection, BasicMap, Properties, Transformation, VariableOneToOne

Author:

Andrei Ilitchev

Since:

EclipseLink 1.0

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
java.lang.String	name Property name.
java.lang.String	value String representation of Property value, converted to an instance of valueType.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
java.lang.Class	valueType Property value type.

Element Detail

name

public abstract java.lang.String name

Property name.

value

public abstract java.lang.String value

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

valueType

public abstract java.lang.Class valueType

Property value type. The value 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