1 /*
   2  * Copyright (c) 1997, 2013, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.  Oracle designates this
   8  * particular file as subject to the "Classpath" exception as provided
   9  * by Oracle in the LICENSE file that accompanied this code.
  10  *
  11  * This code is distributed in the hope that it will be useful, but WITHOUT
  12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14  * version 2 for more details (a copy is included in the LICENSE file that
  15  * accompanied this code).
  16  *
  17  * You should have received a copy of the GNU General Public License version
  18  * 2 along with this work; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any
  23  * questions.
  24  */
  25 
  26 package com.sun.tools.internal.ws.api.wsdl;
  27 
  28 import org.w3c.dom.Element;
  29 import org.xml.sax.Locator;
  30 
  31 /**
  32  * Provides WSDL parsing context. It should be used by the WSDL extension handlers to register their namespaces so that
  33  * it can be latter used by other extensions to resolve the namespaces.
  34  *
  35  * @author Vivek Pandey
  36  * @deprecated This interface is deprecated, will be removed in JAX-WS 2.2 RI.
  37  */
  38 public interface TWSDLParserContext {
  39 
  40     /**
  41      * Pushes the parsing context
  42      */
  43     void push();
  44 
  45     /**
  46      * pops the parsing context
  47      */
  48     void pop();
  49 
  50     /**
  51      * Gives the namespace URI for a given prefix
  52      *
  53      * @param prefix non-null prefix
  54      * @return null of the prefix is not found
  55      */
  56     String getNamespaceURI(String prefix);
  57 
  58     /**
  59      * Gives the prefixes in the current context
  60      */
  61     Iterable<String> getPrefixes();
  62 
  63     /**
  64      * Gives default namespace
  65      *
  66      * @return null if there is no default namespace declaration found
  67      */
  68     String getDefaultNamespaceURI();
  69 
  70     /**
  71      * Registers naemespace declarations of a given {@link Element} found in the WSDL
  72      *
  73      * @param e {@link Element} whose namespace declarations need to be registered
  74      */
  75     void registerNamespaces(Element e);
  76 
  77     /**
  78      * gives the location information for the given Element.
  79      */
  80     Locator getLocation(Element e);
  81 
  82 }