001/*
002 * Copyright (c) 2008, 2009, 2011 Oracle, Inc. All rights reserved.
003 *
004 * This program and the accompanying materials are made available under the
005 * terms of the Eclipse Public License v1.0 and Eclipse Distribution License v. 1.0
006 * which accompanies this distribution.  The Eclipse Public License is available
007 * at http://www.eclipse.org/legal/epl-v10.html and the Eclipse Distribution License
008 * is available at http://www.eclipse.org/org/documents/edl-v10.php.
009 */
010package javax.persistence;
011
012import java.lang.annotation.Retention;
013import java.lang.annotation.Target;
014
015import static java.lang.annotation.ElementType.FIELD;
016import static java.lang.annotation.RetentionPolicy.RUNTIME;
017
018/**
019 * This annotation must be specified for persistent map keys of type {@link java.util.Date} and
020 * {@link java.util.Calendar}. It may only be specified for map keys of these types.
021 * <p>
022 * The <code>MapKeyTemporal</code> annotation can be applied to an element collection or relationship of type
023 * <code>java.util.Map</code> in conjunction with the <code>ElementCollection</code>, <code>OneToMany</code>,
024 * or <code>ManyToMany</code> annotation.
025 * <p>
026 * <pre>
027 *     Example:
028 *
029 *     &#064;OneToMany
030 *     &#064;MapKeyTemporal(DATE)
031 *     protected java.util.Map&#060;java.util.Date, Employee&#062; employees;
032 * </pre>
033 *
034 * @since Java Persistence 2.0
035 */
036@Target({FIELD})
037@Retention(RUNTIME)
038public @interface MapKeyTemporal {
039  /**
040   * (Required) The type used in mapping <code>java.util.Date</code> or <code>java.util.Calendar</code>.
041   *
042   * @return The type used
043   */
044  TemporalType value();
045}