All Downloads are FREE. Search and download functionalities are using the official Maven repository.

javax.xml.bind.annotation.XmlSchemaType Maven / Gradle / Ivy

There is a newer version: 4.0.3
Show newest version
/*
 * Copyright (c) 2005, 2018 Oracle and/or its affiliates. All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Distribution License v. 1.0, which is available at
 * http://www.eclipse.org/org/documents/edl-v10.php.
 *
 * SPDX-License-Identifier: BSD-3-Clause
 */

package javax.xml.bind.annotation;

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

import static java.lang.annotation.ElementType.FIELD;
import static java.lang.annotation.ElementType.METHOD;
import static java.lang.annotation.ElementType.PACKAGE;
import static java.lang.annotation.RetentionPolicy.RUNTIME;

/**
 * Maps a Java type to a simple schema built-in type.
 *
 * 

Usage

*

* {@code @XmlSchemaType} annotation can be used with the following program * elements: *

    *
  • a JavaBean property
  • *
  • field
  • *
  • package
  • *
* *

{@code @XmlSchemaType} annotation defined for Java type * applies to all references to the Java type from a property/field. * A {@code @XmlSchemaType} annotation specified on the * property/field overrides the {@code @XmlSchemaType} annotation * specified at the package level. * *

This annotation can be used with the following annotations: * {@link XmlElement}, {@link XmlAttribute}. *

* Example 1: Customize mapping of XMLGregorianCalendar on the * field. * *

 *     //Example: Code fragment
 *     public class USPrice {
 *         @XmlElement
 *         @XmlSchemaType(name="date")
 *         public XMLGregorianCalendar date;
 *     }
 * {@code
 * 
 *     
 *     
 *       
 *         
 *       
 *     
 * }
* *

Example 2: Customize mapping of XMLGregorianCalendar at package * level

*
 *     package foo;
 *     @javax.xml.bind.annotation.XmlSchemaType(
 *          name="date", type=javax.xml.datatype.XMLGregorianCalendar.class)
 *     }
 * 
* * @since 1.6, JAXB 2.0 */ @Retention(RUNTIME) @Target({FIELD,METHOD,PACKAGE}) public @interface XmlSchemaType { String name(); String namespace() default "http://www.w3.org/2001/XMLSchema"; /** * If this annotation is used at the package level, then value of * the type() must be specified. */ Class type() default DEFAULT.class; /** * Used in {@link XmlSchemaType#type()} to * signal that the type be inferred from the signature * of the property. */ static final class DEFAULT {} }




© 2015 - 2024 Weber Informatics LLC | Privacy Policy