javax.persistence.MapKeyTemporal Maven / Gradle / Ivy

Go to download
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;

/**
 * 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();
}