javax.xml.bind.annotation.XmlAttribute Maven / Gradle / Ivy
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2004-2013 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
* http://glassfish.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 javax.xml.bind.annotation;
import java.lang.annotation.Retention;
import java.lang.annotation.Target;
import static java.lang.annotation.ElementType.*;
import static java.lang.annotation.RetentionPolicy.*;
/**
*
* Maps a JavaBean property to a XML attribute.
*
*
Usage
*
* The @XmlAttribute annotation can be used with the
* following program elements:
*
* - JavaBean property
* - field
*
*
* A static final field is mapped to a XML fixed attribute.
*
*
See "Package Specification" in javax.xml.bind.package javadoc for
* additional common information.
*
* The usage is subject to the following constraints:
*
* - If type of the field or the property is a collection
* type, then the collection item type must be mapped to schema
* simple type.
*
* // Examples
* @XmlAttribute List<Integer> items; //legal
* @XmlAttribute List<Bar> foo; // illegal if Bar does not map to a schema simple type
*
*
* - If the type of the field or the property is a non
* collection type, then the type of the property or field
* must map to a simple schema type.
*
* // Examples
* @XmlAttribute int foo; // legal
* @XmlAttribute Foo foo; // illegal if Foo does not map to a schema simple type
*
*
* - This annotation can be used with the following annotations:
* {@link XmlID},
* {@link XmlIDREF},
* {@link XmlList},
* {@link XmlSchemaType},
* {@link XmlValue},
* {@link XmlAttachmentRef},
* {@link XmlMimeType},
* {@link XmlInlineBinaryData},
* {@link javax.xml.bind.annotation.adapters.XmlJavaTypeAdapter}.
*
*
*
* Example 1: Map a JavaBean property to an XML attribute.
*
* //Example: Code fragment
* public class USPrice {
* @XmlAttribute
* public java.math.BigDecimal getPrice() {...} ;
* public void setPrice(java.math.BigDecimal ) {...};
* }
*
* <!-- Example: XML Schema fragment -->
* <xs:complexType name="USPrice">
* <xs:sequence>
* </xs:sequence>
* <xs:attribute name="price" type="xs:decimal"/>
* </xs:complexType>
*
*
* Example 2: Map a JavaBean property to an XML attribute with anonymous type.
* See Example 7 in @{@link XmlType}.
*
* Example 3: Map a JavaBean collection property to an XML attribute.
*
* // Example: Code fragment
* class Foo {
* ...
* @XmlAttribute List<Integer> items;
* }
*
* <!-- Example: XML Schema fragment -->
* <xs:complexType name="foo">
* ...
* <xs:attribute name="items">
* <xs:simpleType>
* <xs:list itemType="xs:int"/>
* </xs:simpleType>
* </xs:complexType>
*
*
* @author Sekhar Vajjhala, Sun Microsystems, Inc.
* @see XmlType
* @since JAXB2.0
*/
@Retention(RUNTIME) @Target({FIELD, METHOD})
public @interface XmlAttribute {
/**
* Name of the XML Schema attribute. By default, the XML Schema
* attribute name is derived from the JavaBean property name.
*
*/
String name() default "##default";
/**
* Specifies if the XML Schema attribute is optional or
* required. If true, then the JavaBean property is mapped to a
* XML Schema attribute that is required. Otherwise it is mapped
* to a XML Schema attribute that is optional.
*
*/
boolean required() default false;
/**
* Specifies the XML target namespace of the XML Schema
* attribute.
*
*/
String namespace() default "##default" ;
}