1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/src/share/jaxws_classes/com/sun/xml/internal/bind/v2/runtime/NamespaceContext2.java Wed Apr 27 01:27:09 2016 +0800
1.3 @@ -0,0 +1,88 @@
1.4 +/*
1.5 + * Copyright (c) 1997, 2011, Oracle and/or its affiliates. All rights reserved.
1.6 + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
1.7 + *
1.8 + * This code is free software; you can redistribute it and/or modify it
1.9 + * under the terms of the GNU General Public License version 2 only, as
1.10 + * published by the Free Software Foundation. Oracle designates this
1.11 + * particular file as subject to the "Classpath" exception as provided
1.12 + * by Oracle in the LICENSE file that accompanied this code.
1.13 + *
1.14 + * This code is distributed in the hope that it will be useful, but WITHOUT
1.15 + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
1.16 + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
1.17 + * version 2 for more details (a copy is included in the LICENSE file that
1.18 + * accompanied this code).
1.19 + *
1.20 + * You should have received a copy of the GNU General Public License version
1.21 + * 2 along with this work; if not, write to the Free Software Foundation,
1.22 + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
1.23 + *
1.24 + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
1.25 + * or visit www.oracle.com if you need additional information or have any
1.26 + * questions.
1.27 + */
1.28 +
1.29 +package com.sun.xml.internal.bind.v2.runtime;
1.30 +
1.31 +import javax.xml.namespace.NamespaceContext;
1.32 +
1.33 +import com.sun.istack.internal.NotNull;
1.34 +
1.35 +/**
1.36 + * Maintains namespace<->prefix bindings.
1.37 + *
1.38 + * <p>
1.39 + * This interface extends {@link NamespaceContext} and provides
1.40 + * an additional functionality, which is necessary to declare
1.41 + * namespaced attributes on elements. The added method is for
1.42 + * self-consumption by the marshaller.
1.43 + *
1.44 + * This object is composed into a Serializer.
1.45 + */
1.46 +public interface NamespaceContext2 extends NamespaceContext
1.47 +{
1.48 + /**
1.49 + * Declares a new namespace binding within the current context.
1.50 + *
1.51 + * <p>
1.52 + * The prefix is automatically assigned by MarshallingContext. If
1.53 + * a given namespace URI is already declared, nothing happens.
1.54 + *
1.55 + * <p>
1.56 + * It is <b>NOT</b> an error to declare the same namespace URI
1.57 + * more than once.
1.58 + *
1.59 + * <p>
1.60 + * For marshalling to work correctly, all namespace bindings
1.61 + * for an element must be declared between its startElement method and
1.62 + * its endAttributes event. Calling the same method with the same
1.63 + * parameter between the endAttributes and the endElement returns
1.64 + * the same prefix.
1.65 + *
1.66 + * @param requirePrefix
1.67 + * If this parameter is true, this method must assign a prefix
1.68 + * to this namespace, even if it's already bound to the default
1.69 + * namespace. IOW, this method will never return null if this
1.70 + * flag is true. This functionality is necessary to declare
1.71 + * namespace URI used for attribute names.
1.72 + * @param preferedPrefix
1.73 + * If the caller has any particular preference to the
1.74 + * prefix, pass that as a parameter. The callee will try
1.75 + * to honor it. Set null if there's no particular preference.
1.76 + *
1.77 + * @return
1.78 + * returns the assigned prefix. If the namespace is bound to
1.79 + * the default namespace, null is returned.
1.80 + */
1.81 + String declareNamespace( String namespaceUri, String preferedPrefix, boolean requirePrefix );
1.82 +
1.83 + /**
1.84 + * Forcibly make a namespace declaration in effect.
1.85 + *
1.86 + * If the (prefix,uri) binding is already in-scope, this method
1.87 + * simply returns the assigned prefix index. Otherwise a new
1.88 + * declaration will be put.
1.89 + */
1.90 + int force(@NotNull String uri, @NotNull String prefix);
1.91 +}
