javax.persistence.Temporal Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of persistence-api Show documentation

The newest version!

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 fields or properties of type java.util.Date and
 * java.util.Calendar. It may only be specified for fields or properties of these types.
 * 
 * The Temporal annotation may be used in conjunction with the {@link Basic} annotation, the {@link Id} annotation, or the
 * {@link ElementCollection} annotation (when the element collection value is of such a temporal type.
 * 
 * 
 *     Example:
 * 
 *     @Temporal(DATE)
 *     protected java.util.Date endDate;
 * 
 * 
 * @since Java Persistence 1.0
 */
@Target({ METHOD, FIELD })
@Retention(RUNTIME)
public @interface Temporal {

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