javax.persistence.MapKeyTemporal 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: $
// EJB3 Specification Copyright 2004-2009 Sun Microsystems, Inc.
package javax.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;

/**
 * This annotation must be specified for persistent map keys of type
 * {@link java.util.Date} and {@link java.util.Calendar}. It may only be
 * specified for map keys of these types.
 *
 *  The MapKeyTemporal annotation can be applied to an
 * element collection or relationship of type java.util.Map
 * in conjunction with the ElementCollection,
 * OneToMany, or ManyToMany annotation.
 *
 * 
 *     Example:
 *
 *     @OneToMany
 *     @MapKeyTemporal(DATE)
 *     protected java.util.Map<java.util.Date, Employee> employees;
 * 
 *
 * @since Java Persistence 2.0
 */
@Target({METHOD, FIELD})
@Retention(RUNTIME)
public @interface MapKeyTemporal {

    /** (Required) The type used in mapping
     * java.util.Date or
     * java.util.Calendar.
     */
    TemporalType value();
}