javax.persistence.JoinColumns Maven / Gradle / Ivy
/*
* The contents of this file are subject to the terms
* of the Common Development and Distribution License
* (the License). You may not use this file except in
* compliance with the License.
*
* You can obtain a copy of the license at
* https://glassfish.dev.java.net/public/CDDLv1.0.html or
* glassfish/bootstrap/legal/CDDLv1.0.txt.
* See the License for the specific language governing
* permissions and limitations under the License.
*
* When distributing Covered Code, include this CDDL
* Header Notice in each file and include the License file
* at glassfish/bootstrap/legal/CDDLv1.0.txt.
* If applicable, add the following below the CDDL Header,
* with the fields enclosed by brackets [] replaced by
* you own identifying information:
* "Portions Copyrighted [year] [name of copyright owner]"
*
* Copyright 2006 Sun Microsystems, Inc. All rights reserved.
*/
package javax.persistence;
import java.lang.annotation.Target;
import java.lang.annotation.Retention;
import static java.lang.annotation.ElementType.FIELD;
import static java.lang.annotation.ElementType.METHOD;
import static java.lang.annotation.RetentionPolicy.RUNTIME;
/**
* Defines mapping for the composite foreign keys. This annotation
* groups {@link JoinColumn} annotations for the same relationship.
*
* When the JoinColumns
annotation is used,
* both the {@link JoinColumn#name name} and the {@link
* JoinColumn#referencedColumnName referencedColumnName} elements
* must be specified in each such {@link JoinColumn} annotation.
*
*
*
* Example:
* @ManyToOne
* @JoinColumns({
* @JoinColumn(name="ADDR_ID", referencedColumnName="ID"),
* @JoinColumn(name="ADDR_ZIP", referencedColumnName="ZIP")
* })
* public Address getAddress() { return address; }
*
*
* @since Java Persistence 1.0
*/
@Target({METHOD, FIELD})
@Retention(RUNTIME)
public @interface JoinColumns {
JoinColumn[] value();
}