You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
64 lines
2.1 KiB
64 lines
2.1 KiB
7 years ago
|
/*
|
||
|
|
* Copyright (c) 2008, 2009, 2011 Oracle, Inc. All rights reserved.
|
||
|
|
*
|
||
|
|
* This program and the accompanying materials are made available under the
|
||
|
|
* terms of the Eclipse Public License v1.0 and Eclipse Distribution License v. 1.0
|
||
|
|
* which accompanies this distribution. The Eclipse Public License is available
|
||
|
|
* at http://www.eclipse.org/legal/epl-v10.html and the Eclipse Distribution License
|
||
|
|
* is available at http://www.eclipse.org/org/documents/edl-v10.php.
|
||
|
|
*/
|
||
|
|
|
||
|
|
// $Id: $
|
||
|
|
|
||
|
|
package com.fr.third.javax.persistence;
|
||
|
|
|
||
|
|
import java.lang.annotation.Retention;
|
||
|
|
import java.lang.annotation.Target;
|
||
|
|
|
||
|
|
import static java.lang.annotation.ElementType.FIELD;
|
||
|
|
import static java.lang.annotation.ElementType.METHOD;
|
||
|
|
import static java.lang.annotation.RetentionPolicy.RUNTIME;
|
||
|
|
import static com.fr.third.javax.persistence.EnumType.ORDINAL;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Specifies the enum type for a map key whose basic type is an enumerated type.
|
||
|
|
*
|
||
|
|
* The <code>MapKeyEnumerated</code> annotation can be applied to an
|
||
|
|
* element collection or relationship of type <code>java.util.Map</code>, in
|
||
|
|
* conjunction with the <code>ElementCollection</code>, <code>OneToMany</code>, or
|
||
|
|
* <code>ManyToMany</code> annotation.
|
||
|
|
* If the enumerated type is not specified or the <code>MapKeyEnumerated</code>
|
||
|
|
* annotation is not used, the enumerated type is assumed to be
|
||
|
|
* <code>ORDINAL</code>.
|
||
|
|
*
|
||
|
|
* <pre>
|
||
|
|
* Example:
|
||
|
|
*
|
||
|
|
* public enum ProjectStatus {COMPLETE, DELAYED, CANCELLED, IN_PROGRESS}
|
||
|
|
*
|
||
|
|
* public enum SalaryRate {JUNIOR, SENIOR, MANAGER, EXECUTIVE}
|
||
|
|
*
|
||
|
|
* @Entity public class Employee {
|
||
|
|
* @ManyToMany
|
||
|
|
* public Projects<ProjectStatus, Project> getProjects() {...}
|
||
|
|
*
|
||
|
|
* @OneToMany
|
||
|
|
* @MapKeyEnumerated(STRING)
|
||
|
|
* public Map<SalaryRate, Employee> getEmployees() {...}
|
||
|
|
* ...
|
||
|
|
* }
|
||
|
|
* </pre>
|
||
|
|
*
|
||
|
|
* @see ElementCollection
|
||
|
|
* @see OneToMany
|
||
|
|
* @see ManyToMany
|
||
|
|
*
|
||
|
|
* @since Java Persistence 2.0
|
||
|
|
*/
|
||
|
|
@Target({METHOD, FIELD}) @Retention(RUNTIME)
|
||
|
|
public @interface MapKeyEnumerated {
|
||
|
|
|
||
|
|
/** (Optional) The type used in mapping a map key enum type. */
|
||
|
|
EnumType value() default ORDINAL;
|
||
|
|
}
|