NameList

  • NameList is an interface representing an ordered collection of name and namespace pairs, accessible by index.

  • It provides methods to check for the presence of a specific name (contains) or a name/namespace pair (containsNS).

  • NameList allows retrieval of the total number of pairs (getLength), a name at a specific index (getName), and its corresponding namespace URI (getNamespaceURI).

  • The index for accessing elements in the NameList starts from 0.
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.

Public Method Summary

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

Public Methods

public abstract 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.

public abstract 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.

public abstract 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.

public abstract 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.

public abstract 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.