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

Go to download

Show more of this group Show more artifacts with this name
Show all versions of eclipselink Show documentation

EclipseLink build based upon Git transaction f2b9fc5

There is a newer version: 5.0.0-B03

/*
 * 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:
// dmccann - September 14/2010 - 2.2 - 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;
/**
 * XmlKey is used to mark a property as a key, to be referenced using a key-based mapping via {@code XmlJoinNode}. This is
 * similar to the {@code XmlID} annotation, but doesn't require the property be bound to the schema type ID. XmlKey is
 * typically used in the composite key use case, since only 1 property can be annotated with the XmlID annotation.
 * 
 *
 * Example:
 * 
 * @XmlRootElement
 * @XmlAccessorType(XmlAccessType.FIELD)
 * public class Employee {
 *
 *     @XmlKey
 *     public String id;
 *
 *     @XmlKey
 *     public String department;
 *
 *     @XmlJoinNodes({
 *         @XmlJoinNode(xmlPath="manager/id/text()", referencedXmlPath="id/text()"),
 *         @XmlJoinNode(xmlPath="manager/dept/text()", referencedXmlPath="department/text()")
 *     })
 *     public Employee manager;
 * }
 * 
 *
 * @see XmlJoinNode
 * @see XmlJoinNodes
 */
@Target({METHOD, FIELD})
@Retention(RUNTIME)
public @interface XmlKey {}