DOMStringList

  • DOMStringList is an interface representing an ordered collection of DOMString values, accessible by index starting from 0.

  • It provides methods to check if a string is in the list (contains), get the list's size (getLength), and retrieve an item by its index (item).

  • If an index provided to the item method is out of bounds, it will return null.
public interface DOMStringList

The DOMStringList interface provides the abstraction of an ordered collection of DOMString values, without defining or constraining how this collection is implemented. The items in the DOMStringList 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 string is part of this DOMStringList.
abstract int
getLength()
The number of DOMStrings in the list.
abstract String
item(int index)
Returns the indexth item in the collection.

Public Methods

public abstract boolean contains (String str)

Test if a string is part of this DOMStringList.

Parameters
str The string to look for.
Returns
  • true if the string has been found, false otherwise.

public abstract int getLength ()

The number of DOMStrings in the list. The range of valid child node indices is 0 to length-1 inclusive.

public abstract String item (int index)

Returns the indexth item in the collection. If index is greater than or equal to the number of DOMStrings in the list, this returns null.

Parameters
index Index into the collection.
Returns
  • The DOMString at the indexth position in the DOMStringList, or null if that is not a valid index.