01: /*
02: * Copyright 2006 Sun Microsystems, Inc. All Rights Reserved.
03: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
04: *
05: * This code is free software; you can redistribute it and/or modify it
06: * under the terms of the GNU General Public License version 2 only, as
07: * published by the Free Software Foundation. Sun designates this
08: * particular file as subject to the "Classpath" exception as provided
09: * by Sun 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 Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
22: * CA 95054 USA or visit www.sun.com if you need additional information or
23: * have any questions.
24: */
25: package com.sun.xml.internal.txw2.annotation;
26:
27: import com.sun.xml.internal.txw2.TypedXmlWriter;
28:
29: import java.lang.annotation.Retention;
30: import java.lang.annotation.Target;
31:
32: import static java.lang.annotation.ElementType.METHOD;
33: import static java.lang.annotation.RetentionPolicy.RUNTIME;
34:
35: /**
36: * Specifies that the invocation of the method will produce an attribute.
37: *
38: * <p>
39: * The method signature has to match the form <tt>R foo(DT1,DT2,..)</tt>
40: *
41: * <p>
42: * R is either <tt>void</tt> or the type to which the interface that declares
43: * this method is assignable. In the case of the latter, the method will return
44: * <tt>this</tt> object, allowing you to chain the multiple attribute method
45: * invocations like {@link StringBuffer}.
46: *
47: * <p>
48: * DTi must be datatype objects.
49: *
50: * <p>
51: * When this method is called, a new attribute is added to the current element,
52: * whose value is whitespace-separated text from each of the datatype objects.
53: *
54: * @author Kohsuke Kawaguchi
55: */
56: @Retention(RUNTIME)
57: @Target({METHOD})
58: public @interface XmlAttribute {
59: /**
60: * The local name of the attribute.
61: *
62: * <p>
63: * If left unspecified, the method name is used as the attribute name.
64: *
65: */
66: String value() default "";
67:
68: /**
69: * The namespace URI of the attribute.
70: */
71: String ns() default "";
72: }
|