com.sun.xml.stream.xerces.xni.NamespaceContext Maven / Gradle / Ivy
Show all versions of sjsxp Show documentation
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can obtain
* a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
* or glassfish/bootstrap/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
* Sun designates this particular file as subject to the "Classpath" exception
* as provided by Sun in the GPL Version 2 section of the License file that
* accompanied this code. If applicable, add the following below the License
* Header, with the fields enclosed by brackets [] replaced by your own
* identifying information: "Portions Copyrighted [year]
* [name of copyright owner]"
*
* Contributor(s):
*
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
/*
* The Apache Software License, Version 1.1
*
*
* Copyright (c) 2001, 2002 The Apache Software Foundation. All rights
* reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
* 3. The end-user documentation included with the redistribution,
* if any, must include the following acknowledgment:
* "This product includes software developed by the
* Apache Software Foundation (http://www.apache.org/)."
* Alternately, this acknowledgment may appear in the software itself,
* if and wherever such third-party acknowledgments normally appear.
*
* 4. The names "Xerces" and "Apache Software Foundation" must
* not be used to endorse or promote products derived from this
* software without prior written permission. For written
* permission, please contact [email protected].
*
* 5. Products derived from this software may not be called "Apache",
* nor may "Apache" appear in their name, without prior written
* permission of the Apache Software Foundation.
*
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
* ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
* USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
* ====================================================================
*
* This software consists of voluntary contributions made by many
* individuals on behalf of the Apache Software Foundation and was
* originally based on software copyright (c) 1999, International
* Business Machines, Inc., http://www.apache.org. For more
* information on the Apache Software Foundation, please see
*
* The prefix and namespace must be identical references for equal strings, thus
* each string should be internalized (@see String.intern())
* or added to the SymbolTable
*
* @see
* com.sun.xml.stream.xerces.util.SymbolTable
*
* @author Andy Clark, IBM
*
* @version $Id: NamespaceContext.java,v 1.3 2007-07-19 22:33:16 ofung Exp $
*/
public interface NamespaceContext {
//
// Constants
//
/**
* The XML Namespace ("http://www.w3.org/XML/1998/namespace"). This is
* the Namespace URI that is automatically mapped to the "xml" prefix.
*/
public final static String XML_URI = "http://www.w3.org/XML/1998/namespace".intern();
/**
* XML Information Set REC
* all namespace attributes (including those named xmlns,
* whose [prefix] property has no value) have a namespace URI of http://www.w3.org/2000/xmlns/
*/
public final static String XMLNS_URI = "http://www.w3.org/2000/xmlns/".intern();
//
// NamespaceContext methods
//
/**
* Start a new Namespace context.
*
* A new context should be pushed at the beginning
* of each XML element: the new context will automatically inherit
* the declarations of its parent context, but it will also keep
* track of which declarations were made within this context.
*
*
* @see #popContext
*/
public void pushContext();
/**
* Revert to the previous Namespace context.
*
* The context should be popped at the end of each
* XML element. After popping the context, all Namespace prefix
* mappings that were previously in force are restored.
*
* Users must not attempt to declare additional Namespace
* prefixes after popping a context, unless you push another
* context first.
*
* @see #pushContext
*/
public void popContext();
/**
* Declare a Namespace prefix.
*
* This method declares a prefix in the current Namespace
* context; the prefix will remain in force until this context
* is popped, unless it is shadowed in a descendant context.
*
* Note that to declare a default Namespace, use the empty string.
* The prefixes "xml" and "xmlns" can't be rebound.
*
* Note that you must not declare a prefix after
* you've pushed and popped another Namespace.
*
* @param prefix The prefix to declare, or null for the empty
* string.
* @param uri The Namespace URI to associate with the prefix.
*
* @return true if the prefix was legal, false otherwise
*
* @see #getURI
* @see #getDeclaredPrefixAt
*/
public boolean declarePrefix(String prefix, String uri);
/**
* Look up a prefix and get the currently-mapped Namespace URI.
*
* This method looks up the prefix in the current context. If no mapping
* is found, this methods will continue lookup in the parent context(s).
* Use the empty string ("") for the default Namespace.
*
* @param prefix The prefix to look up.
*
* @return The associated Namespace URI, or null if the prefix
* is undeclared in this context.
*/
public String getURI(String prefix);
/**
* Look up a namespace URI and get one of the mapped prefix.
*
* This method looks up the namespace URI in the current context.
* If more than one prefix is currently mapped to the same URI,
* this method will make an arbitrary selection
* If no mapping is found, this methods will continue lookup in the
* parent context(s).
*
* @param uri The namespace URI to look up.
*
* @return One of the associated prefixes, or null if the uri
* does not map to any prefix.
*
* @see #getPrefix
*/
public String getPrefix(String uri);
/**
* Return a count of locally declared prefixes, including
* the default prefix if bound.
*/
public int getDeclaredPrefixCount();
/**
* Returns the prefix at the specified index in the current context.
*/
public String getDeclaredPrefixAt(int index);
/**
* Return an enumeration of all prefixes whose declarations are active
* in the current context. This includes declarations from parent contexts
* that have not been overridden.
* @return Enumeration
*/
public Enumeration getAllPrefixes();
public Vector getPrefixes(String uri);
/**
* Reset this Namespace support object for reuse.
*
*
It is necessary to invoke this method before reusing the
* Namespace support object for a new session.
*
* Note that implementations of this method need to ensure that
* the declaration of the prefixes "xmlns" and "xml" are available.
*/
public void reset();
} // interface NamespaceContext