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

/*
 * Copyright (C) 2005 by Quentin Anciaux
 *
 * This library is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Library General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or (at your
 * option) any later version.
 *
 * This library 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 the GNU Library General Public License
 * for more details.
 *
 * You should have received a copy of the GNU Library General Public License
 * along with this library; if not, write to the Free Software Foundation,
 * Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 *
 *	@author Quentin Anciaux
 */

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 index th item in the collection. If
     * index is greater than or equal to the number of
     * DOMString s in the list, this returns null.
     *
     * @param index Index into the collection.
     *
     * @return The DOMString at the index th position
     *         in the DOMStringList, or null if that
     *         is not a valid index.
     */
    public String item(int index);

    /**
     * The number of DOMString s in the list. The range of valid
     * child node indices is 0 to length-1 inclusive.
     *
     * @return DOCUMENT ME!
     */
    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);
}