org.w3c.dom.DOMStringList Maven / Gradle / Ivy

/*
 * 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
 */

package org.w3c.dom;

/**
 *  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.
 * @since DOM Level 3
 */
public interface DOMStringList {
    /**
     *  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.
     * @param index Index into the collection.
     * @return  The DOMString at the indexth
     *   position in the DOMStringList, or null if
     *   that is not a valid index.
     */
    public String item(int index);

    /**
     * The number of DOMStrings in the list. The range of valid
     * child node indices is 0 to length-1 inclusive.
     */
    public int getLength();

    /**
     *  Test if a string is part of this DOMStringList.
     * @param str  The string to look for.
     * @return  true if the string has been found,
     *   false otherwise.
     */
    public boolean contains(String str);

}