org.glassfish.hk2.xml.api.annotations.XmlIdentifier Maven / Gradle / Ivy
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2014 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, 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/CDDL+GPL_1_1.html
* or packager/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at packager/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package org.glassfish.hk2.xml.api.annotations;
import static java.lang.annotation.ElementType.METHOD;
import static java.lang.annotation.RetentionPolicy.RUNTIME;
import java.lang.annotation.Documented;
import java.lang.annotation.Retention;
import java.lang.annotation.Target;
/**
* This annotation denotes the single Xml attribute
* or element that should be used as the unique (within
* the xpath) identifier. The type of this Xml attribute
* or element must be String. There may only be one
* attribute or element in the Java bean that uses this
* annotation
*
* This annotation is very much like the standard
* JAXB annotation {@link javax.xml.bind.annotation.XmlID} except
* that the uniqueness of this field need only be per xpath from
* the root, and not over the entire tree. For example, consider
* a Java Bean such as a PropertyBean that is used all over the tree
* for those Beans that have a set of properties. The PropertyBean
* might have identical keys in two different xpaths from the root, and
* therefore could not use {@link javax.xml.bind.annotation.XmlID},
* since the {@link javax.xml.bind.annotation.XmlID} requires uniqueness
* over the entire tree, and not over just one xpath
*
* Furthermore, whereas {@link javax.xml.bind.annotation.XmlID} can be referred
* to with {@link javax.xml.bind.annotation.XmlIDREF} there is no corresponding
* automatic reference with this annotation. If both
* {@link javax.xml.bind.annotation.XmlID} and this annotation are found
* on different properties of this bean then this annotation will be used
* in preference over {@link javax.xml.bind.annotation.XmlID}
*
* @author jwells
*
*/
@Documented
@Retention(RUNTIME)
@Target(METHOD)
public @interface XmlIdentifier {
}