org.eclipse.persistence.oxm.annotations.XmlPaths Maven / Gradle / Ivy

Go to download
/*
 * Copyright (c) 2011, 2020 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 v. 2.0 which is available at
 * http://www.eclipse.org/legal/epl-2.0,
 * or the Eclipse Distribution License v. 1.0 which is available at
 * http://www.eclipse.org/org/documents/edl-v10.php.
 *
 * SPDX-License-Identifier: EPL-2.0 OR BSD-3-Clause
 */

// Contributors:
//     Oracle = 2.2 - Initial contribution
package org.eclipse.persistence.oxm.annotations;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 *Purpose: This annotation is used in conjunction with an XmlElements annotation to
 * specify an XmlPath for each of the XmlElement annotations in the XmlElements.
 * The number of XmlPath annotations must be the same as the number of XmlElement annotations
 * and the order must be the same.
 *
 * 
Example:

 * 
 *  @XmlRootElement(name="customer")

 *  public class Customer {

 *     ...

 *     @XmlElements({@literal {@XmlElement(type=String.class), @XmlElement(type=Integer.class)}})

 *     @XmlPaths({@literal {@XmlPath("choice-element/string/text()"), @XmlPath("choice-element/integer/text()")}})

 *     public Object choice

 *     ...

 *  }


 * Will create the following Schema:

 *
 * 
 *    ...
 *    <xsd:choice>
 *       <xsd:element name="choice-element" minOccurs="0">
 *          <xsd:complexType>
 *             <xsd:choice>
 *                <xsd:element name="string" type="xsd:string" minOccurs="0"/>
 *                <xsd:element name="integer" type="xsd:int" minOccurs="0"/>
 *             </xsd:choice>
 *          </xsd:complexType>
 *       </xsd:element>
 *    </xsd:choice>
 *    ...
 * 
 */
@Target({ElementType.FIELD, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
public @interface XmlPaths {
    XmlPath[] value();
}