Mercurial > jdk8-mips64-public > jaxws / annotate
src/share/jaxws_classes/com/sun/xml/internal/txw2/annotation/XmlElement.java@dffc222439a1 (annotated)
src/share/jaxws_classes/com/sun/xml/internal/txw2/annotation/XmlElement.java
Sun, 18 Jun 2017 23:18:45 +0100
- author
- aefimov
- date
- Sun, 18 Jun 2017 23:18:45 +0100
- changeset 1443
- dffc222439a1
- parent 0
- 373ffda63c9a
- permissions
- -rw-r--r--
8172297: In java 8, the marshalling with JAX-WS does not escape carriage return
Reviewed-by: lancea
| aoqi@0 | 1 | /* |
| aoqi@0 | 2 | * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved. |
| aoqi@0 | 3 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
| aoqi@0 | 4 | * |
| aoqi@0 | 5 | * This code is free software; you can redistribute it and/or modify it |
| aoqi@0 | 6 | * under the terms of the GNU General Public License version 2 only, as |
| aoqi@0 | 7 | * published by the Free Software Foundation. Oracle designates this |
| aoqi@0 | 8 | * particular file as subject to the "Classpath" exception as provided |
| aoqi@0 | 9 | * by Oracle in the LICENSE file that accompanied this code. |
| aoqi@0 | 10 | * |
| aoqi@0 | 11 | * This code is distributed in the hope that it will be useful, but WITHOUT |
| aoqi@0 | 12 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
| aoqi@0 | 13 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
| aoqi@0 | 14 | * version 2 for more details (a copy is included in the LICENSE file that |
| aoqi@0 | 15 | * accompanied this code). |
| aoqi@0 | 16 | * |
| aoqi@0 | 17 | * You should have received a copy of the GNU General Public License version |
| aoqi@0 | 18 | * 2 along with this work; if not, write to the Free Software Foundation, |
| aoqi@0 | 19 | * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
| aoqi@0 | 20 | * |
| aoqi@0 | 21 | * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
| aoqi@0 | 22 | * or visit www.oracle.com if you need additional information or have any |
| aoqi@0 | 23 | * questions. |
| aoqi@0 | 24 | */ |
| aoqi@0 | 25 | |
| aoqi@0 | 26 | package com.sun.xml.internal.txw2.annotation; |
| aoqi@0 | 27 | |
| aoqi@0 | 28 | import com.sun.xml.internal.txw2.TypedXmlWriter; |
| aoqi@0 | 29 | import com.sun.xml.internal.txw2.TXW; |
| aoqi@0 | 30 | import com.sun.xml.internal.txw2.output.XmlSerializer; |
| aoqi@0 | 31 | |
| aoqi@0 | 32 | import javax.xml.namespace.QName; |
| aoqi@0 | 33 | import java.lang.annotation.Retention; |
| aoqi@0 | 34 | import java.lang.annotation.Target; |
| aoqi@0 | 35 | |
| aoqi@0 | 36 | import static java.lang.annotation.ElementType.TYPE; |
| aoqi@0 | 37 | import static java.lang.annotation.RetentionPolicy.RUNTIME; |
| aoqi@0 | 38 | import static java.lang.annotation.ElementType.METHOD; |
| aoqi@0 | 39 | |
| aoqi@0 | 40 | /** |
| aoqi@0 | 41 | * Specifies the name of the XML element. |
| aoqi@0 | 42 | * |
| aoqi@0 | 43 | * <h2>Used on method</h2> |
| aoqi@0 | 44 | * <p> |
| aoqi@0 | 45 | * When used on methods declared on interfaces that derive |
| aoqi@0 | 46 | * from {@link TypedXmlWriter}, it specifies that the invocation |
| aoqi@0 | 47 | * of the method will produce an element of the specified name. |
| aoqi@0 | 48 | * |
| aoqi@0 | 49 | * <p> |
| aoqi@0 | 50 | * The method signature has to match one of the following patterns. |
| aoqi@0 | 51 | * |
| aoqi@0 | 52 | * <dl> |
| aoqi@0 | 53 | * <dt>Child writer: <tt>TW foo()</tt></dt> |
| aoqi@0 | 54 | * <dd>TW must be an interface derived from {@link TypedXmlWriter}. |
| aoqi@0 | 55 | * When this method is called, a new child element is started, |
| aoqi@0 | 56 | * and its content can be written by using the returned <tt>TW</tt> |
| aoqi@0 | 57 | * object. This child element will be ended when its _commit method |
| aoqi@0 | 58 | * is called. |
| aoqi@0 | 59 | * <dt>Leaf element: <tt>void foo(DT1,DT2,...)</tt></dt> |
| aoqi@0 | 60 | * <dd>DTi must be datatype objects. |
| aoqi@0 | 61 | * When this method is called, a new child element is started, |
| aoqi@0 | 62 | * followed by the whitespace-separated text data from each of |
| aoqi@0 | 63 | * the datatype objects, followed by the end tag. |
| aoqi@0 | 64 | * </dl> |
| aoqi@0 | 65 | * |
| aoqi@0 | 66 | * <h2>Used on interface</h2> |
| aoqi@0 | 67 | * <p> |
| aoqi@0 | 68 | * When used on interfaces that derive from {@link TypedXmlWriter}, |
| aoqi@0 | 69 | * it associates an element name with that interface. This name is |
| aoqi@0 | 70 | * used in a few places, such as in {@link TXW#create(Class,XmlSerializer)} |
| aoqi@0 | 71 | * and {@link TypedXmlWriter#_element(Class)}. |
| aoqi@0 | 72 | * |
| aoqi@0 | 73 | * |
| aoqi@0 | 74 | * @author Kohsuke Kawaguchi |
| aoqi@0 | 75 | */ |
| aoqi@0 | 76 | @Retention(RUNTIME) |
| aoqi@0 | 77 | @Target({METHOD,TYPE}) |
| aoqi@0 | 78 | public @interface XmlElement { |
| aoqi@0 | 79 | /** |
| aoqi@0 | 80 | * The local name of the element. |
| aoqi@0 | 81 | */ |
| aoqi@0 | 82 | String value() default ""; |
| aoqi@0 | 83 | |
| aoqi@0 | 84 | /** |
| aoqi@0 | 85 | * The namespace URI of this element. |
| aoqi@0 | 86 | * |
| aoqi@0 | 87 | * <p> |
| aoqi@0 | 88 | * If the annotation is on an interface and this paramter is left unspecified, |
| aoqi@0 | 89 | * then the namespace URI is taken from {@link XmlNamespace} annotation on |
| aoqi@0 | 90 | * the package that the interface is in. If {@link XmlNamespace} annotation |
| aoqi@0 | 91 | * doesn't exist, the namespace URI will be "". |
| aoqi@0 | 92 | * |
| aoqi@0 | 93 | * <p> |
| aoqi@0 | 94 | * If the annotation is on a method and this parameter is left unspecified, |
| aoqi@0 | 95 | * then the namespace URI is the same as the namespace URI of the writer interface. |
| aoqi@0 | 96 | */ |
| aoqi@0 | 97 | String ns() default "##default"; |
| aoqi@0 | 98 | } |
