Returns whether there exists at least one entry with a path matching path (following the semantics of path matching). Equivalent to containsPath(path).

containsEntry

abstract fun containsEntry(entryId: PathMultimapEntryId): Boolean

Returns whether there exists an entry identified by entryId in the multimap.

containsPath

open fun containsPath(path: String): Boolean

abstract fun containsPath(path: Path): Boolean

Returns whether there exists at least one entry with a path matching path (following the semantics of path matching).

containsValue

abstract fun containsValue(value: T): Boolean

Returns whether there exists at least one value equal to value in the multimap.

entries

open fun entries(path: String): Sequence<PathMultimapEntry<T>>

abstract fun entries(path: Path = AbsolutePath.MATCH_ALL): Sequence<PathMultimapEntry<T>>

Returns a sequence over all entries with a path matching path (following the semantics of path matching).

get

open operator fun get(entryId: PathMultimapEntryId): PathMultimapEntry<T>?

Returns the entry identified by entryId or null when no such entry exists. Equivalent to getEntry(entryId).

open operator fun get(path: String): Sequence<T>

abstract operator fun get(path: Path): Sequence<T>

Returns a sequence over all values with a path matching path (following the semantics of path matching).

getEntry

abstract fun getEntry(entryId: PathMultimapEntryId): PathMultimapEntry<T>?

Returns the entry identified by entryId or null when no such entry exists.

getOne

open fun getOne(path: String): T?

open fun getOne(path: Path): T?

Returns one value matching path or null when no such value exists. Equivalent to get(path).firstOrNull().

isEmpty

open fun isEmpty(): Boolean

Whether the multimap is empty.

put

open fun put(path: String, value: T): PathMultimapEntryId

abstract fun put(path: Path, value: T): PathMultimapEntryId

Inserts a new entry in the multimap with the given path and value and returns an identifier that identifies the inserted entry in the multimap.

putAll

open fun putAll(pathMultimap: PathMultimap<T>): List<PathMultimapEntryId>

Inserts all entries of pathMultimap into this multimap and returns a list with the identifiers of each inserted entry.

remove

open fun remove(path: String): List<PathMultimapEntry<T>>

abstract fun remove(path: Path): List<PathMultimapEntry<T>>

Removes all entries with a path contained by path (following the semantics of path containment) and returns a list of said entries.

removeEntry

abstract fun removeEntry(entryId: PathMultimapEntryId): PathMultimapEntry<T>?

Removes the entry identified by entryId and returns it or null when no such entry exists.

set

operator fun <T> MutablePathMultimap<T>.set(path: String, value: T): PathMultimapEntryId

operator fun <T> MutablePathMultimap<T>.set(path: Path, value: T): PathMultimapEntryId

Inserts a new entry in the multimap with the given path and value and returns an identifier that identifies the inserted entry in the multimap.

toMap

fun <T> PathMultimap<T>.toMap(): MutableMap<AbsolutePath, MutableList<T>>

Transforms the multimap into a mapping of paths to lists of values associated with them.