javax.persistence.Embeddable Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of hibernate-jpa-2.0-api Show documentation

Hibernate definition of the Java Persistence 2.0 (JSR 317) API.

There is a newer version: 1.0.1.Final

Show newest version

// $Id: Embeddable.java 17752 2009-10-15 01:19:21Z [email protected] $
// EJB3 Specification Copyright 2004-2009 Sun Microsystems, Inc.
package javax.persistence;

import java.lang.annotation.Target;
import java.lang.annotation.Retention;
import java.lang.annotation.Documented;
import static java.lang.annotation.ElementType.TYPE;
import static java.lang.annotation.RetentionPolicy.RUNTIME;

/**
 * Defines a class whose instances are stored as an intrinsic
 * part of an owning entity and share the identity of the entity.
 * Each of the persistent properties or fields of the embedded
 * object is mapped to the database table for the entity.
 *
 *  Note that the {@link Transient} annotation may be used to
 * designate the non-persistent state of an embeddable class.
 *
 * 
 *
 *    Example 1:
 *
 *    @Embeddable public class EmploymentPeriod {
 *       @Temporal(DATE) java.util.Date startDate;
 *       @Temporal(DATE) java.util.Date endDate;
 *      ...
 *    }
 *
 *    Example 2:
 *
 *    @Embeddable public class PhoneNumber {
 *        protected String areaCode;
 *        protected String localNumber;
 *        @ManyToOne PhoneServiceProvider provider;
 *        ...
 *     }
 *
 *    @Entity public class PhoneServiceProvider {
 *        @Id protected String name;
 *         ...
 *     }
 *
 *    Example 3:
 *
 *    @Embeddable public class Address {
 *       protected String street;
 *       protected String city;
 *       protected String state;
 *       @Embedded protected Zipcode zipcode;
 *    }
 *
 *    @Embeddable public class Zipcode {
 *       protected String zip;
 *       protected String plusFour;
 *     }


 * 
 *
 * @since Java Persistence 1.0
 */
@Documented
@Target({TYPE})
@Retention(RUNTIME)
public @interface Embeddable {
}