javax.persistence.Embedded Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of persistence-api Show documentation

The newest version!

package javax.persistence;

import static java.lang.annotation.ElementType.FIELD;
import static java.lang.annotation.ElementType.METHOD;
import static java.lang.annotation.RetentionPolicy.RUNTIME;

import java.lang.annotation.Retention;
import java.lang.annotation.Target;

/**
 * Specifies a persistent field or property of an entity whose value is an instance of an embeddable class. The embeddable class must be
 * annotated as {@link Embeddable}.
 * 
 * 
 * The AttributeOverride, AttributeOverrides, AssociationOverride, and
 * AssociationOverrides annotations may be used to override mappings declared or defaulted by the embeddable class.
 * 
 * 
 *   Example:
 * 
 *   @Embedded
 *   @AttributeOverrides({
 *       @AttributeOverride(name="startDate", column=@Column("EMP_START")),
 *       @AttributeOverride(name="endDate", column=@Column("EMP_END"))
 *   })
 *   public EmploymentPeriod getEmploymentPeriod() { ... }
 * 
 * 
 * @see Embeddable
 * @see AttributeOverride
 * @see AttributeOverrides
 * @see AssociationOverride
 * @see AssociationOverrides
 * 
 * @since Java Persistence 1.0
 */
@Target({ METHOD, FIELD })
@Retention(RUNTIME)
public @interface Embedded {}