aoqi@0: /*
aoqi@0:  * Copyright (c) 1997, 2011, Oracle and/or its affiliates. All rights reserved.
aoqi@0:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
aoqi@0:  *
aoqi@0:  * This code is free software; you can redistribute it and/or modify it
aoqi@0:  * under the terms of the GNU General Public License version 2 only, as
aoqi@0:  * published by the Free Software Foundation.  Oracle designates this
aoqi@0:  * particular file as subject to the "Classpath" exception as provided
aoqi@0:  * by Oracle in the LICENSE file that accompanied this code.
aoqi@0:  *
aoqi@0:  * This code is distributed in the hope that it will be useful, but WITHOUT
aoqi@0:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
aoqi@0:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
aoqi@0:  * version 2 for more details (a copy is included in the LICENSE file that
aoqi@0:  * accompanied this code).
aoqi@0:  *
aoqi@0:  * You should have received a copy of the GNU General Public License version
aoqi@0:  * 2 along with this work; if not, write to the Free Software Foundation,
aoqi@0:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
aoqi@0:  *
aoqi@0:  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
aoqi@0:  * or visit www.oracle.com if you need additional information or have any
aoqi@0:  * questions.
aoqi@0:  */
aoqi@0: 
aoqi@0: package com.sun.xml.internal.bind.v2.runtime;
aoqi@0: 
aoqi@0: import javax.xml.namespace.NamespaceContext;
aoqi@0: 
aoqi@0: import com.sun.istack.internal.NotNull;
aoqi@0: 
aoqi@0: /**
aoqi@0:  * Maintains namespace<->prefix bindings.
aoqi@0:  *
aoqi@0:  * <p>
aoqi@0:  * This interface extends {@link NamespaceContext} and provides
aoqi@0:  * an additional functionality, which is necessary to declare
aoqi@0:  * namespaced attributes on elements. The added method is for
aoqi@0:  * self-consumption by the marshaller.
aoqi@0:  *
aoqi@0:  * This object is composed into a Serializer.
aoqi@0:  */
aoqi@0: public interface NamespaceContext2 extends NamespaceContext
aoqi@0: {
aoqi@0:     /**
aoqi@0:      * Declares a new namespace binding within the current context.
aoqi@0:      *
aoqi@0:      * <p>
aoqi@0:      * The prefix is automatically assigned by MarshallingContext. If
aoqi@0:      * a given namespace URI is already declared, nothing happens.
aoqi@0:      *
aoqi@0:      * <p>
aoqi@0:      * It is <b>NOT</b> an error to declare the same namespace URI
aoqi@0:      * more than once.
aoqi@0:      *
aoqi@0:      * <p>
aoqi@0:      * For marshalling to work correctly, all namespace bindings
aoqi@0:      * for an element must be declared between its startElement method and
aoqi@0:      * its endAttributes event. Calling the same method with the same
aoqi@0:      * parameter between the endAttributes and the endElement returns
aoqi@0:      * the same prefix.
aoqi@0:      *
aoqi@0:      * @param   requirePrefix
aoqi@0:      *      If this parameter is true, this method must assign a prefix
aoqi@0:      *      to this namespace, even if it's already bound to the default
aoqi@0:      *      namespace. IOW, this method will never return null if this
aoqi@0:      *      flag is true. This functionality is necessary to declare
aoqi@0:      *      namespace URI used for attribute names.
aoqi@0:      * @param   preferedPrefix
aoqi@0:      *      If the caller has any particular preference to the
aoqi@0:      *      prefix, pass that as a parameter. The callee will try
aoqi@0:      *      to honor it. Set null if there's no particular preference.
aoqi@0:      *
aoqi@0:      * @return
aoqi@0:      *      returns the assigned prefix. If the namespace is bound to
aoqi@0:      *      the default namespace, null is returned.
aoqi@0:      */
aoqi@0:     String declareNamespace( String namespaceUri, String preferedPrefix, boolean requirePrefix );
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Forcibly make a namespace declaration in effect.
aoqi@0:      *
aoqi@0:      * If the (prefix,uri) binding is already in-scope, this method
aoqi@0:      * simply returns the assigned prefix index. Otherwise a new
aoqi@0:      * declaration will be put.
aoqi@0:      */
aoqi@0:     int force(@NotNull String uri, @NotNull String prefix);
aoqi@0: }