1 /*
   2  * Copyright (c) 2005, 2012, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.  Oracle designates this
   8  * particular file as subject to the "Classpath" exception as provided
   9  * by Oracle in the LICENSE file that accompanied this code.
  10  *
  11  * This code is distributed in the hope that it will be useful, but WITHOUT
  12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14  * version 2 for more details (a copy is included in the LICENSE file that
  15  * accompanied this code).
  16  *
  17  * You should have received a copy of the GNU General Public License version
  18  * 2 along with this work; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any
  23  * questions.
  24  */
  25 
  26 package com.sun.xml.internal.txw2.annotation;
  27 
  28 import com.sun.xml.internal.txw2.TypedXmlWriter;
  29 
  30 import java.lang.annotation.Retention;
  31 import java.lang.annotation.Target;
  32 
  33 import static java.lang.annotation.ElementType.METHOD;
  34 import static java.lang.annotation.RetentionPolicy.RUNTIME;
  35 
  36 /**
  37  * Specifies that the invocation of the method will produce an attribute.
  38  *
  39  * <p>
  40  * The method signature has to match the form <tt>R foo(DT1,DT2,..)</tt>
  41  *
  42  * <p>
  43  * R is either <tt>void</tt> or the type to which the interface that declares
  44  * this method is assignable. In the case of the latter, the method will return
  45  * <tt>this</tt> object, allowing you to chain the multiple attribute method
  46  * invocations like {@link StringBuffer}.
  47  *
  48  * <p>
  49  * DTi must be datatype objects.
  50  *
  51  * <p>
  52  * When this method is called, a new attribute is added to the current element,
  53  * whose value is whitespace-separated text from each of the datatype objects.
  54  *
  55  * @author Kohsuke Kawaguchi
  56  */
  57 @Retention(RUNTIME)
  58 @Target({METHOD})
  59 public @interface XmlAttribute {
  60     /**
  61      * The local name of the attribute.
  62      *
  63      * <p>
  64      * If left unspecified, the method name is used as the attribute name.
  65      *
  66      */
  67     String value() default "";
  68 
  69     /**
  70      * The namespace URI of the attribute.
  71      */
  72     String ns() default "";
  73 }