/*******************************************************************************
* Copyright (c) 2011, 2015 Oracle and/or its affiliates. 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.
*
* Contributors:
* dmccann - November 29/2010 - 2.3 - Initial implementation
******************************************************************************/
package org.eclipse.persistence.oxm.annotations;
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;
/**
* XmlElementsJoinNodes is used in conjunction with {@code XmlElements} in order to specify the key references for the
* targets of the XmlElements annotation. There must be one XmlJoinNodes for each XmlElement This is similar to using {@code XmlIDREF}
* with {@code XmlElements} but allows customisation of the xpath for the source keys and allows for composite key
* relationships.
*
* <p><b>Example:</b></p>
* <pre>
* @XmlRootElement
* public class Client {
*
* ...
*
* @XmlElements({
* @XmlElement(name="mail", type=Address.class),
* @XmlElement(name="phone", type=PhoneNumber.class)
* })
* @XmlElementsJoinNodes({
* @XmlJoinNodes({
* @XmlJoinNode(xmlPath="mail/@id", referencedXmlPath="@aid"),
* @XmlJoinNode(xmlPath="mail/type/text()", referencedXmlPath="@type")
* }),
* @XmlJoinNodes({
* @XmlJoinNode(xmlPath="phone/@id", referencedXmlPath="@pid"),
* @XmlJoinNode(xmlPath="phone/type/text()", referencedXmlPath="@type")
* })
* })
* public Object preferredContactMethod;
* </pre>
*
* @see XmlJoinNodes
* @see XmlJoinNode
* @see javax.xml.bind.annotation.XmlElements XmlElements
* @see XmlKey
*/
@Target({METHOD, FIELD})
@Retention(RUNTIME)
public @interface XmlElementsJoinNodes {
XmlJoinNodes[] value();
}