1. /*
  2. * Copyright (c) 2004 World Wide Web Consortium,
  3. *
  4. * (Massachusetts Institute of Technology, European Research Consortium for
  5. * Informatics and Mathematics, Keio University). All Rights Reserved. This
  6. * work is distributed under the W3C(r) Software License [1] in the hope that
  7. * it will be useful, but WITHOUT ANY WARRANTY; without even the implied
  8. * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  9. *
  10. * [1] http://www.w3.org/Consortium/Legal/2002/copyright-software-20021231
  11. */
  12. package org.w3c.dom;
  13. /**
  14. * The <code>DOMStringList</code> interface provides the abstraction of an
  15. * ordered collection of <code>DOMString</code> values, without defining or
  16. * constraining how this collection is implemented. The items in the
  17. * <code>DOMStringList</code> are accessible via an integral index, starting
  18. * from 0.
  19. * <p>See also the <a href='http://www.w3.org/TR/2004/REC-DOM-Level-3-Core-20040407'>Document Object Model (DOM) Level 3 Core Specification</a>.
  20. * @since DOM Level 3
  21. */
  22. public interface DOMStringList {
  23. /**
  24. * Returns the <code>index</code>th item in the collection. If
  25. * <code>index</code> is greater than or equal to the number of
  26. * <code>DOMString</code>s in the list, this returns <code>null</code>.
  27. * @param index Index into the collection.
  28. * @return The <code>DOMString</code> at the <code>index</code>th
  29. * position in the <code>DOMStringList</code>, or <code>null</code> if
  30. * that is not a valid index.
  31. */
  32. public String item(int index);
  33. /**
  34. * The number of <code>DOMString</code>s in the list. The range of valid
  35. * child node indices is 0 to <code>length-1</code> inclusive.
  36. */
  37. public int getLength();
  38. /**
  39. * Test if a string is part of this <code>DOMStringList</code>.
  40. * @param str The string to look for.
  41. * @return <code>true</code> if the string has been found,
  42. * <code>false</code> otherwise.
  43. */
  44. public boolean contains(String str);
  45. }