Target filter
Search Kotlin docs
  • Platforms
  • Tealium Prism Kotlin
core/com.tealium.prism.core.api.data/JsonPath/Companion/parseJsonListPath

parseJsonListPath

@JvmStatic
fun parseJsonListPath(path: String): JsonListPath

Attempts to parse the given path as a JsonPath, where the root component is applicable to a JSON array and therefore extractable via an index.

Calling this method with a path not starting with an array index, e.g. object.key, is an error, and will throw JsonPathParseException.

See parse for explanation of accepted path format

Parameters

path

The string representing the JsonPath to be parsed

See also

JsonPath
JsonPath.Companion.parse

Throws

JsonPathParseException

when the path is syntactically invalid, or the root component of the path is not an array index

Generated by Dokka
(c) Tealium 2026