Mercurial > jdk8-mips64-public > jaxws / annotate
src/share/jaxws_classes/com/sun/xml/internal/bind/v2/runtime/NamespaceContext2.java@e530533619ec (annotated)
src/share/jaxws_classes/com/sun/xml/internal/bind/v2/runtime/NamespaceContext2.java
Thu, 12 Oct 2017 19:44:07 +0800
- author
- aoqi
- date
- Thu, 12 Oct 2017 19:44:07 +0800
- changeset 760
- e530533619ec
- parent 0
- 373ffda63c9a
- permissions
- -rw-r--r--
merge
| aoqi@0 | 1 | /* |
| aoqi@0 | 2 | * Copyright (c) 1997, 2011, 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.bind.v2.runtime; |
| aoqi@0 | 27 | |
| aoqi@0 | 28 | import javax.xml.namespace.NamespaceContext; |
| aoqi@0 | 29 | |
| aoqi@0 | 30 | import com.sun.istack.internal.NotNull; |
| aoqi@0 | 31 | |
| aoqi@0 | 32 | /** |
| aoqi@0 | 33 | * Maintains namespace<->prefix bindings. |
| aoqi@0 | 34 | * |
| aoqi@0 | 35 | * <p> |
| aoqi@0 | 36 | * This interface extends {@link NamespaceContext} and provides |
| aoqi@0 | 37 | * an additional functionality, which is necessary to declare |
| aoqi@0 | 38 | * namespaced attributes on elements. The added method is for |
| aoqi@0 | 39 | * self-consumption by the marshaller. |
| aoqi@0 | 40 | * |
| aoqi@0 | 41 | * This object is composed into a Serializer. |
| aoqi@0 | 42 | */ |
| aoqi@0 | 43 | public interface NamespaceContext2 extends NamespaceContext |
| aoqi@0 | 44 | { |
| aoqi@0 | 45 | /** |
| aoqi@0 | 46 | * Declares a new namespace binding within the current context. |
| aoqi@0 | 47 | * |
| aoqi@0 | 48 | * <p> |
| aoqi@0 | 49 | * The prefix is automatically assigned by MarshallingContext. If |
| aoqi@0 | 50 | * a given namespace URI is already declared, nothing happens. |
| aoqi@0 | 51 | * |
| aoqi@0 | 52 | * <p> |
| aoqi@0 | 53 | * It is <b>NOT</b> an error to declare the same namespace URI |
| aoqi@0 | 54 | * more than once. |
| aoqi@0 | 55 | * |
| aoqi@0 | 56 | * <p> |
| aoqi@0 | 57 | * For marshalling to work correctly, all namespace bindings |
| aoqi@0 | 58 | * for an element must be declared between its startElement method and |
| aoqi@0 | 59 | * its endAttributes event. Calling the same method with the same |
| aoqi@0 | 60 | * parameter between the endAttributes and the endElement returns |
| aoqi@0 | 61 | * the same prefix. |
| aoqi@0 | 62 | * |
| aoqi@0 | 63 | * @param requirePrefix |
| aoqi@0 | 64 | * If this parameter is true, this method must assign a prefix |
| aoqi@0 | 65 | * to this namespace, even if it's already bound to the default |
| aoqi@0 | 66 | * namespace. IOW, this method will never return null if this |
| aoqi@0 | 67 | * flag is true. This functionality is necessary to declare |
| aoqi@0 | 68 | * namespace URI used for attribute names. |
| aoqi@0 | 69 | * @param preferedPrefix |
| aoqi@0 | 70 | * If the caller has any particular preference to the |
| aoqi@0 | 71 | * prefix, pass that as a parameter. The callee will try |
| aoqi@0 | 72 | * to honor it. Set null if there's no particular preference. |
| aoqi@0 | 73 | * |
| aoqi@0 | 74 | * @return |
| aoqi@0 | 75 | * returns the assigned prefix. If the namespace is bound to |
| aoqi@0 | 76 | * the default namespace, null is returned. |
| aoqi@0 | 77 | */ |
| aoqi@0 | 78 | String declareNamespace( String namespaceUri, String preferedPrefix, boolean requirePrefix ); |
| aoqi@0 | 79 | |
| aoqi@0 | 80 | /** |
| aoqi@0 | 81 | * Forcibly make a namespace declaration in effect. |
| aoqi@0 | 82 | * |
| aoqi@0 | 83 | * If the (prefix,uri) binding is already in-scope, this method |
| aoqi@0 | 84 | * simply returns the assigned prefix index. Otherwise a new |
| aoqi@0 | 85 | * declaration will be put. |
| aoqi@0 | 86 | */ |
| aoqi@0 | 87 | int force(@NotNull String uri, @NotNull String prefix); |
| aoqi@0 | 88 | } |
