javax.persistence.MapKeyTemporal Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ow2-jpa-2.0-spec Show documentation

JPA API of Java EE 6.0

The newest version!

/*
 * Copyright 2010 Bull S.A.S.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

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;

/**
 * The MapKeyTemporal annotation is used to specify the temporal type for a map key whose basic type is a temporal type. 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. If the map is specified using Java generics, the MapKeyClass
 * annotation and associated type need not be specified; otherwise they must be specified.
 * @see JPA 2.0 specification
 * @author Florent Benoit
 * @since JPA 2.0 version.
 */
@Target({ METHOD, FIELD })
@Retention(RUNTIME)
public @interface MapKeyTemporal {

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