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.ElementType.METHOD;
017import static java.lang.annotation.RetentionPolicy.RUNTIME;
018
019/**
020 * This annotation must be specified for persistent fields or properties of type <code>java.util.Date</code>
021 * and <code>java.util.Calendar</code>. It may only be specified for fields or properties of these types.
022 * <p>
023 * The <code>Temporal</code> annotation may be used in conjunction with the {@link Basic} annotation, the
024 * {@link Id} annotation, or the {@link ElementCollection} annotation (when the element collection value is of
025 * such a temporal type.
026 * <p>
027 * <pre>
028 *     Example:
029 *
030 *     &#064;Temporal(DATE)
031 *     protected java.util.Date endDate;
032 * </pre>
033 *
034 * @since Java Persistence 1.0
035 */
036@Target({METHOD, FIELD})
037@Retention(RUNTIME)
038public @interface Temporal {
039  /**
040   * The type used in mapping <code>java.util.Date</code> or <code>java.util.Calendar</code>.
041   *
042   * @return type
043   */
044  TemporalType value();
045}