/*

 * Copyright (c) 2004, 2015, Oracle and/or its affiliates. All rights reserved.

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

 *

 * This code is free software; you can redistribute it and/or modify it

 * under the terms of the GNU General Public License version 2 only, as

 * published by the Free Software Foundation.  Oracle designates this

 * particular file as subject to the "Classpath" exception as provided

 * by Oracle in the LICENSE file that accompanied this code.

 *

 * This code is distributed in the hope that it will be useful, but WITHOUT

 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or

 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License

 * version 2 for more details (a copy is included in the LICENSE file that

 * accompanied this code).

 *

 * You should have received a copy of the GNU General Public License version

 * 2 along with this work; if not, write to the Free Software Foundation,

 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

 *

 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA

 * or visit www.oracle.com if you need additional information or have any

 * questions.

 */

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.*;

/**

 * <p>

 * Maps a JavaBean property to a XML attribute.

 *

 * <p> <b>Usage</b> </p>

 * <p>

 * The <tt>@XmlAttribute</tt> annotation can be used with the

 * following program elements:

 * <ul>

 *   <li> JavaBean property </li>

 *   <li> field </li>

 * </ul>

 *

 * <p> A static final field is mapped to a XML fixed attribute.

 *

 * <p>See "Package Specification" in javax.xml.bind.package javadoc for

 * additional common information.</p>

 *

 * The usage is subject to the following constraints:

 * <ul>

 *   <li> If type of the field or the property is a collection

 *        type, then the collection item type must be mapped to schema

 *        simple type.

 * <pre>

 *     // Examples

 *     @XmlAttribute List<Integer> items; //legal

 *     @XmlAttribute List<Bar> foo; // illegal if Bar does not map to a schema simple type

 * </pre>

 *   </li>

 *   <li> 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.

 * <pre>

 *     // Examples

 *     @XmlAttribute int foo; // legal

 *     @XmlAttribute Foo foo; // illegal if Foo does not map to a schema simple type

 * </pre>

 *   </li>

 *   <li> 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}.</li>

 * </ul>

 *

 * <p> <b>Example 1: </b>Map a JavaBean property to an XML attribute.</p>

 * <pre>

 *     //Example: Code fragment

 *     public class USPrice {

 *         @XmlAttribute

 *         public java.math.BigDecimal getPrice() {...} ;

 *         public void setPrice(java.math.BigDecimal ) {...};

 *     }

 *

 *

 * <p> <b>Example 2: </b>Map a JavaBean property to an XML attribute with anonymous type.</p>

 * See Example 7 in @{@link XmlType}.

 *

 * <p> <b>Example 3: </b>Map a JavaBean collection property to an XML attribute.</p>

 * <pre>

 *     // Example: Code fragment

 *     class Foo {

 *         ...

 *         @XmlAttribute List<Integer> items;

 *     }

 *

 *       ...

 *

 * @author Sekhar Vajjhala, Sun Microsystems, Inc.

 * @see XmlType

 * @since 1.6, JAXB 2.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" ;

}