org.w3c.dom

Interface NameList

public interface NameList

The NameList interface provides the abstraction of an ordered collection of parallel pairs of name and namespace values (which could be null values), without defining or constraining how this collection is implemented. The items in the NameList are accessible via an integral index, starting from 0.

See also the Document Object Model (DOM) Level 3 Core Specification.

Since:
DOM Level 3

Method Summary

boolean
contains(String str)
Test if a name is part of this NameList.
boolean
containsNS(String namespaceURI, String name)
Test if the pair namespaceURI/name is part of this NameList.
int
getLength()
The number of pairs (name and namespaceURI) in the list.
String
getName(int index)
Returns the indexth name item in the collection.
String
getNamespaceURI(int index)
Returns the indexth namespaceURI item in the collection.

Method Details

contains

public boolean contains(String str)
Test if a name is part of this NameList.
Parameters:
str - The name to look for.
Returns:
true if the name has been found, false otherwise.

containsNS

public boolean containsNS(String namespaceURI,
                          String name)
Test if the pair namespaceURI/name is part of this NameList.
Parameters:
namespaceURI - The namespace URI to look for.
name - The name to look for.
Returns:
true if the pair namespaceURI/name has been found, false otherwise.

getLength

public int getLength()
The number of pairs (name and namespaceURI) in the list. The range of valid child node indices is 0 to length-1 inclusive.

getName

public String getName(int index)
Returns the indexth name item in the collection.
Parameters:
index - Index into the collection.
Returns:
The name at the indexth position in the NameList, or null if there is no name for the specified index or if the index is out of range.

getNamespaceURI

public String getNamespaceURI(int index)
Returns the indexth namespaceURI item in the collection.
Parameters:
index - Index into the collection.
Returns:
The namespace URI at the indexth position in the NameList, or null if there is no name for the specified index or if the index is out of range.

* Copyright (c) 2004 World Wide Web Consortium, * * (Massachusetts Institute of Technology, European Research Consortium for * Informatics and Mathematics, Keio University). All Rights Reserved. This * work is distributed under the W3C(r) Software License [1] 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. * * [1] http://www.w3.org/Consortium/Legal/2002/copyright-software-20021231