xerces/xercesImpl/2.12.0 : org/apache/xerces/dom3/as/ASNamedObjectMap.java

ASNamedObjectMap

https://xerces.apache.org/xerces2-j/: Xerces2 is the next generation of high performance, fully compliant XML parsers in the Apache Xerces family. This new version of Xerces introduces the Xerces Native Interface (XNI), a complete framework for building parser components and configurations that is extremely modular and easy to program. The Apache Xerces2 parser is the reference implementation of XNI but other parser components, configurations, and parsers can be written using the Xerces Native Interface. For complete design and implementation documents, refer to the XNI Manual. Xerces2 is a fully conforming XML Schema 1.0 processor. A partial experimental implementation of the XML Schema 1.1 Structures and Datatypes Working Drafts (December 2009) and an experimental implementation of the XML Schema Definition Language (XSD): Component Designators (SCD) Candidate Recommendation (January 2010) are provided for evaluation. For more information, refer to the XML Schema page. Xerces2 also provides a complete implementation of the Document Object Model Level 3 Core and Load/Save W3C Recommendations and provides a complete implementation of the XML Inclusions (XInclude) W3C Recommendation. It also provides support for OASIS XML Catalogs v1.1. Xerces2 is able to parse documents written according to the XML 1.1 Recommendation, except that it does not yet provide an option to enable normalization checking as described in section 2.13 of this specification. It also handles namespaces according to the XML Namespaces 1.1 Recommendation, and will correctly serialize XML 1.1 documents if the DOM level 3 load/save APIs are in use.

The Apache Software License, Version 2.0

Apache Software Foundation (Apache Software Foundation)

/*
 * Copyright (c) 2001 World Wide Web Consortium,
 * (Massachusetts Institute of Technology, Institut National de
 * Recherche en Informatique et en Automatique, Keio University). All
 * Rights Reserved. This program is distributed under the W3C's Software
 * Intellectual Property License. This program is distributed in the
 * hope that it will be useful, but WITHOUT ANY WARRANTY; without even
 * the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
 * PURPOSE.
 * See W3C License http://www.w3.org/Consortium/Legal/ for more details.
 */

package org.apache.xerces.dom3.as;

import org.w3c.dom.DOMException;

Deprecated: 
Objects implementing the ASNamedObjectMap interface are used 
to represent collections of abstract schema nodes that can be accessed by 
name. Note that ASNamedObjectMap does not inherit from 
ASObjectList; ASNamedObjectMaps are not 
maintained in any particular order. Objects contained in an object 
implementing ASNamedObjectMap may also be accessed by an 
ordinal index, but this is simply to allow convenient enumeration of the 
contents of a ASNamedObjectMap, and does not imply that the 
DOM specifies an order to these ASObjects. 
ASNamedObjectMap object in the DOM are live.
See also the Document Object Model (DOM) Level 3 Abstract Schemas and Load
and Save Specification./**
 * @deprecated

 * Objects implementing the <code>ASNamedObjectMap</code> interface are used 
 * to represent collections of abstract schema nodes that can be accessed by 
 * name. Note that <code>ASNamedObjectMap</code> does not inherit from 
 * <code>ASObjectList</code>; <code>ASNamedObjectMaps</code> are not 
 * maintained in any particular order. Objects contained in an object 
 * implementing <code>ASNamedObjectMap</code> may also be accessed by an 
 * ordinal index, but this is simply to allow convenient enumeration of the 
 * contents of a <code>ASNamedObjectMap</code>, and does not imply that the 
 * DOM specifies an order to these <code>ASObjects</code>. 
 * <p><code>ASNamedObjectMap</code> object in the DOM are live.
 * <p>See also the <a href='http://www.w3.org/TR/2001/WD-DOM-Level-3-ASLS-20011025'>Document Object Model (DOM) Level 3 Abstract Schemas and Load
and Save Specification</a>.
 */
public interface ASNamedObjectMap {
    The number of ASObjects in the ASObjectList. 
The range of valid child node indices is 0 to length-1 
inclusive.
/**
     * The number of <code>ASObjects</code> in the <code>ASObjectList</code>. 
     * The range of valid child node indices is 0 to <code>length-1</code> 
     * inclusive.
     */
    public int getLength();

    Retrieves an ASObject specified by name.
Params: name – The nodeName of an ASObject to 
  retrieve.
Returns: An ASObject with specified node name and 
  null if the map does not contain an element with the 
  given name./**
     * Retrieves an <code>ASObject</code> specified by name.
     * @param name The <code>nodeName</code> of an <code>ASObject</code> to 
     *   retrieve.
     * @return An <code>ASObject</code> with specified node name and 
     *   <code>null</code> if the map does not contain an element with the 
     *   given name.
     */
    public ASObject getNamedItem(String name);

    Retrieves an ASObject specified by local name and 
namespace URI.
Params: namespaceURI – The namespace URI of the ASObject to 
  retrieve.
localName – The local name of the ASObject to 
  retrieve.
Returns: A ASObject (of any type) with the specified local 
  name and namespace URI, or null if they do not 
  identify any ASObject in this map./**
     * Retrieves an <code>ASObject</code> specified by local name and 
     * namespace URI.
     * @param namespaceURI The namespace URI of the <code>ASObject</code> to 
     *   retrieve.
     * @param localName The local name of the <code>ASObject</code> to 
     *   retrieve.
     * @return A <code>ASObject</code> (of any type) with the specified local 
     *   name and namespace URI, or <code>null</code> if they do not 
     *   identify any <code>ASObject</code> in this map.
     */
    public ASObject getNamedItemNS(String namespaceURI, 
                                   String localName);

    Returns the indexth item in the map. The index starts at 
0. If index is greater than or equal to the 
number of nodes in the list, this returns null.
Params: index – The position in the map from which the item is to be 
  retrieved.
Returns: The ASObject at the indexth position 
  in the ASNamedObjectMap, or null if that 
  is not a valid index./**
     * Returns the <code>index</code>th item in the map. The index starts at 
     * <code>0</code>. If <code>index</code> is greater than or equal to the 
     * number of nodes in the list, this returns <code>null</code>.
     * @param index The position in the map from which the item is to be 
     *   retrieved.
     * @return The <code>ASObject</code> at the <code>index</code>th position 
     *   in the <code>ASNamedObjectMap</code>, or <code>null</code> if that 
     *   is not a valid index.
     */
    public ASObject item(int index);

    Removes an ASObject specified by a nodeName. 
Params: name – The nodeName of the ASObject to 
  be removed.
Throws: DOMException – 
  NOT_FOUND_ERR: Raised if there is no node named name in 
  this map.
  
NO_MODIFICATION_ALLOWED_ERR: Raised if this map is readonly.
Returns:  The ASObject removed from this map if an 
  ASObject with such a name exists./**
     * Removes an <code>ASObject</code> specified by a <code>nodeName</code>. 
     * @param name The <code>nodeName</code> of the <code>ASObject</code> to 
     *   be removed.
     * @return  The <code>ASObject</code> removed from this map if an 
     *   <code>ASObject</code> with such a name exists.
     * @exception DOMException
     *   NOT_FOUND_ERR: Raised if there is no node named <code>name</code> in 
     *   this map.
     *   <br>NO_MODIFICATION_ALLOWED_ERR: Raised if this map is readonly.
     */
    public ASObject removeNamedItem(String name)
                                    throws DOMException;

    Removes an ASObject specified by a namespace URI and a 
local name.
Params: namespaceURI – The namespace URI of the ASObject to 
  be removed.
localName – The local name of the ASObject to remove.
Throws: DOMException – 
  NOT_FOUND_ERR: Raised if there is no node with the specified 
  namespaceURI and localName in this map.
  
NO_MODIFICATION_ALLOWED_ERR: Raised if this map is readonly.
Returns: The ASObject removed from this map if an 
  ASObject with such a local name and namespace URI 
  exists./**
     * Removes an <code>ASObject</code> specified by a namespace URI and a 
     * local name.
     * @param namespaceURI The namespace URI of the <code>ASObject</code> to 
     *   be removed.
     * @param localName The local name of the <code>ASObject</code> to remove.
     * @return The <code>ASObject</code> removed from this map if an 
     *   <code>ASObject</code> with such a local name and namespace URI 
     *   exists.
     * @exception DOMException
     *   NOT_FOUND_ERR: Raised if there is no node with the specified 
     *   <code>namespaceURI</code> and <code>localName</code> in this map.
     *   <br>NO_MODIFICATION_ALLOWED_ERR: Raised if this map is readonly.
     */
    public ASObject removeNamedItemNS(String namespaceURI, 
                                      String localName)
                                      throws DOMException;

    Adds an ASObject using its nodeName 
attribute. If an ASObject with that name is already 
present in this map, it is replaced by the new one.
Params: newASObject – The ASObject to be inserted in the map 
  with its nodeName as the key.
Throws: DOMException – 
  WRONG_DOCUMENT_ERR: Raised if arg was created from a 
  different ASModel than the one that created this map.
  
NO_MODIFICATION_ALLOWED_ERR: Raised if this map is readonly.
  
HIERARCHY_REQUEST_ERR: Raised if an attempt is made to add a node 
  doesn't belong in this ASNamedObjectMap.
Returns: If the new node replaces an existing one, the replaced node is 
  returned, otherwise null./**
     * Adds an <code>ASObject</code> using its <code>nodeName</code> 
     * attribute. If an <code>ASObject</code> with that name is already 
     * present in this map, it is replaced by the new one.
     * @param newASObject The <code>ASObject</code> to be inserted in the map 
     *   with its <code>nodeName</code> as the key.
     * @return If the new node replaces an existing one, the replaced node is 
     *   returned, otherwise <code>null</code>.
     * @exception DOMException
     *   WRONG_DOCUMENT_ERR: Raised if <code>arg</code> was created from a 
     *   different <code>ASModel</code> than the one that created this map.
     *   <br>NO_MODIFICATION_ALLOWED_ERR: Raised if this map is readonly.
     *   <br>HIERARCHY_REQUEST_ERR: Raised if an attempt is made to add a node 
     *   doesn't belong in this <code>ASNamedObjectMap</code>.
     */
    public ASObject setNamedItem(ASObject newASObject)
                                 throws DOMException;

    Adds an ASObject using its namespaceURI and 
localName. If an ASObject with the same 
namespaceURI and localName is already 
present in this map, it is replaced by the new one.
Params: newASObject – The ASObject to be inserted in the 
  map.The ASObject will later be accessible using the 
  value of its namespaceURI and localName 
  attributes.
Throws: DOMException – 
  WRONG_DOCUMENT_ERR: Raised if arg was 
  created from a different ASModel than the one that 
  created this map.
  
NO_MODIFICATION_ALLOWED_ERR: Raised if this map is 
  readonly.
  
HIERARCHY_REQUEST_ERR: Raised if an attempt is made 
  to add a node doesn't belong in this ASNamedObjectMap.
Returns: If the new node replaces an existing one, the replaced node is 
  returned, otherwise null./**
     * Adds an <code>ASObject</code> using its <code>namespaceURI</code> and 
     * <code>localName</code>. If an <code>ASObject</code> with the same 
     * <code>namespaceURI</code> and <code>localName</code> is already 
     * present in this map, it is replaced by the new one.
     * @param newASObject The <code>ASObject</code> to be inserted in the 
     *   map.The <code>ASObject</code> will later be accessible using the 
     *   value of its <code>namespaceURI</code> and <code>localName</code> 
     *   attributes.
     * @return If the new node replaces an existing one, the replaced node is 
     *   returned, otherwise <code>null</code>.
     * @exception DOMException
     *   <code>WRONG_DOCUMENT_ERR</code>: Raised if <code>arg</code> was 
     *   created from a different <code>ASModel</code> than the one that 
     *   created this map.
     *   <br><code>NO_MODIFICATION_ALLOWED_ERR</code>: Raised if this map is 
     *   readonly.
     *   <br><code>HIERARCHY_REQUEST_ERR</code>: Raised if an attempt is made 
     *   to add a node doesn't belong in this <code>ASNamedObjectMap</code>.
     */
    public ASObject setNamedItemNS(ASObject newASObject)
                                   throws DOMException;

}

Params:	name – The `nodeName` of an `ASObject` to retrieve.
Returns:	An `ASObject` with specified node name and `null` if the map does not contain an element with the given name.

Params:	namespaceURI – The namespace URI of the `ASObject` to retrieve. localName – The local name of the `ASObject` to retrieve.
Returns:	A `ASObject` (of any type) with the specified local name and namespace URI, or `null` if they do not identify any `ASObject` in this map.

Params:	index – The position in the map from which the item is to be retrieved.
Returns:	The `ASObject` at the `index`th position in the `ASNamedObjectMap`, or `null` if that is not a valid index.

Params:	name – The `nodeName` of the `ASObject` to be removed.
Throws:	DOMException – NOT_FOUND_ERR: Raised if there is no node named `name` in this map. NO_MODIFICATION_ALLOWED_ERR: Raised if this map is readonly.
Returns:	The `ASObject` removed from this map if an `ASObject` with such a name exists.

Params:	newASObject – The `ASObject` to be inserted in the map with its `nodeName` as the key.
Throws:	DOMException – WRONG_DOCUMENT_ERR: Raised if `arg` was created from a different `ASModel` than the one that created this map. NO_MODIFICATION_ALLOWED_ERR: Raised if this map is readonly. HIERARCHY_REQUEST_ERR: Raised if an attempt is made to add a node doesn't belong in this `ASNamedObjectMap`.
Returns:	If the new node replaces an existing one, the replaced node is returned, otherwise `null`.

/

xerces/ xercesImpl/ 2.12.0/ org/apache/xerces/dom3/as/ASNamedObjectMap.java