Stay organized with collections
Save and categorize content based on your preferences.
DOMStringList
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.
Summary
Public methods |
abstract Boolean |
Test if a string is part of this DOMStringList .
|
abstract Int |
The number of DOMString s in the list.
|
abstract String! |
Returns the index th item in the collection.
|
Public methods
contains
abstract fun contains(str: String!): Boolean
Test if a string is part of this DOMStringList
.
Parameters |
str |
String!: The string to look for. |
Return |
Boolean |
true if the string has been found, false otherwise. |
getLength
abstract fun getLength(): Int
The number of DOMString
s in the list. The range of valid child node indices is 0 to length-1
inclusive.
item
abstract fun item(index: Int): String!
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
.
Parameters |
index |
Int: Index into the collection. |
Return |
String! |
The DOMString at the index th position in the DOMStringList , or null if that is not a valid index. |
Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
Last updated 2025-02-10 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-02-10 UTC."],[],[],null,["# DOMStringList\n\nAdded in [API level 8](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)\n\nDOMStringList\n=============\n\n```\ninterface DOMStringList\n```\n\n|--------------------------------|\n| [org.w3c.dom.DOMStringList](#) |\n\nThe `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.\n\nSee also the [Document Object Model (DOM) Level 3 Core Specification](http://www.w3.org/TR/2004/REC-DOM-Level-3-Core-20040407).\n\nSummary\n-------\n\n| Public methods ||\n|---------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| abstract [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | [contains](#contains(kotlin.String))`(`str:` `[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)!`)` Test if a string is part of this `DOMStringList`. |\n| abstract [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | [getLength](#getLength())`()` The number of `DOMString`s in the list. |\n| abstract [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)! | [item](#item(kotlin.Int))`(`index:` `[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`)` Returns the `index`th item in the collection. |\n\nPublic methods\n--------------\n\n### contains\n\nAdded in [API level 8](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) \n\n```\nabstract fun contains(str: String!): Boolean\n```\n\nTest if a string is part of this `DOMStringList`.\n\n| Parameters ||\n|-------|------------------------------------------------------------------------------------------------------------|\n| `str` | [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)!: The string to look for. |\n\n| Return ||\n|------------------------------------------------------------------------------------|---------------------------------------------------------|\n| [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | `true` if the string has been found, `false` otherwise. |\n\n### getLength\n\nAdded in [API level 8](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) \n\n```\nabstract fun getLength(): Int\n```\n\nThe number of `DOMString`s in the list. The range of valid child node indices is 0 to `length-1` inclusive. \n\n### item\n\nAdded in [API level 8](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) \n\n```\nabstract fun item(index: Int): String!\n```\n\nReturns 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`.\n\n| Parameters ||\n|---------|--------------------------------------------------------------------------------------------------------|\n| `index` | [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html): Index into the collection. |\n\n| Return ||\n|-----------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------|\n| [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)! | The `DOMString` at the `index`th position in the `DOMStringList`, or `null` if that is not a valid index. |"]]