com.sun.xml.txw2.annotation.XmlAttribute Maven / Gradle / Ivy
/*
* Copyright (c) 2005, 2021 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 java.lang.annotation.Retention;
import java.lang.annotation.Target;
import static java.lang.annotation.ElementType.METHOD;
import static java.lang.annotation.RetentionPolicy.RUNTIME;
/**
* Specifies that the invocation of the method will produce an attribute.
*
*
* The method signature has to match the form {@code R foo(DT1,DT2,..)}
*
*
* R is either {@code void} or the type to which the interface that declares
* this method is assignable. In the case of the latter, the method will return
* {@code this} object, allowing you to chain the multiple attribute method
* invocations like {@link StringBuffer}.
*
*
* DTi must be datatype objects.
*
*
* When this method is called, a new attribute is added to the current element,
* whose value is whitespace-separated text from each of the datatype objects.
*
* @author Kohsuke Kawaguchi
*/
@Retention(RUNTIME)
@Target({METHOD})
public @interface XmlAttribute {
/**
* The local name of the attribute.
*
*
* If left unspecified, the method name is used as the attribute name.
*
* @return the local name
*/
String value() default "";
/**
* The namespace URI of the attribute.
* @return the namespace URI
*/
String ns() default "";
}