jakarta.persistence.Embedded Maven / Gradle / Ivy
/*
* Copyright (c) 2008, 2020 Oracle and/or its affiliates. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v. 2.0 which is available at
* http://www.eclipse.org/legal/epl-2.0,
* or the Eclipse Distribution License v. 1.0 which is available at
* http://www.eclipse.org/org/documents/edl-v10.php.
*
* SPDX-License-Identifier: EPL-2.0 OR BSD-3-Clause
*/
// Contributors:
// Linda DeMichiel - 2.1
// Linda DeMichiel - 2.0
package jakarta.persistence;
import java.lang.annotation.Target;
import java.lang.annotation.Retention;
import static java.lang.annotation.ElementType.FIELD;
import static java.lang.annotation.ElementType.METHOD;
import static java.lang.annotation.RetentionPolicy.RUNTIME;
/**
* 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 1.0
*/
@Target({METHOD, FIELD})
@Retention(RUNTIME)
public @interface Embedded {
}