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

com.sun.xml.txw2.annotation.XmlElement 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 com.sun.xml.txw2.annotation;

import com.sun.xml.txw2.TypedXmlWriter;
import com.sun.xml.txw2.TXW;
import com.sun.xml.txw2.output.XmlSerializer;

import javax.xml.namespace.QName;
import java.lang.annotation.Retention;
import java.lang.annotation.Target;

import static java.lang.annotation.ElementType.TYPE;
import static java.lang.annotation.RetentionPolicy.RUNTIME;
import static java.lang.annotation.ElementType.METHOD;

/**
 * Specifies the name of the XML element.
 *
 * 

Used on method

*

* When used on methods declared on interfaces that derive * from {@link TypedXmlWriter}, it specifies that the invocation * of the method will produce an element of the specified name. * *

* The method signature has to match one of the following patterns. * *

*
Child writer: {@code TW foo()}
*
TW must be an interface derived from {@link TypedXmlWriter}. * When this method is called, a new child element is started, * and its content can be written by using the returned {@code TW} * object. This child element will be ended when its _commit method * is called. *
Leaf element: {@code void foo(DT1,DT2,...)}
*
DTi must be datatype objects. * When this method is called, a new child element is started, * followed by the whitespace-separated text data from each of * the datatype objects, followed by the end tag. *
* *

Used on interface

*

* When used on interfaces that derive from {@link TypedXmlWriter}, * it associates an element name with that interface. This name is * used in a few places, such as in {@link TXW#create(Class,XmlSerializer)} * and {@link TypedXmlWriter#_element(Class)}. * * * @author Kohsuke Kawaguchi */ @Retention(RUNTIME) @Target({METHOD,TYPE}) public @interface XmlElement { /** * The local name of the element. */ String value() default ""; /** * The namespace URI of this element. * *

* If the annotation is on an interface and this paramter is left unspecified, * then the namespace URI is taken from {@link XmlNamespace} annotation on * the package that the interface is in. If {@link XmlNamespace} annotation * doesn't exist, the namespace URI will be "". * *

* If the annotation is on a method and this parameter is left unspecified, * then the namespace URI is the same as the namespace URI of the writer interface. */ String ns() default "##default"; }





© 2015 - 2024 Weber Informatics LLC | Privacy Policy