s34k/org.veupathdb.lib.s3.s34k.fields/MutableTagMap

MutableTagMap

interface MutableTagMap : TagMap

Mutable map of Tag instances.

Implementations of this interface should be thread safe.

Author

Elizabeth Paige Harper https://github.com/Foxcapades

Since

v0.1.0

Functions

Link copied to clipboard
abstract fun add(vararg tags: Pair<String, String>)
abstract fun add(vararg tags: Tag)
abstract fun add(tags: Iterable<Tag>)
abstract fun add(tags: Map<String, String>)

Adds the given tags to this map.

abstract fun add(tag: Tag)

Adds the single given tag to this map.

abstract fun add(key: String, value: String)

Adds the given key/value pair as a tag to this map.

Link copied to clipboard
open fun forEach(p0: Consumer<in Tag>)
Link copied to clipboard
abstract operator fun get(key: String): String?

Gets the value for the tag with the given name (key).

Link copied to clipboard
abstract operator fun iterator(): Iterator<Tag>
Link copied to clipboard
abstract operator fun plusAssign(tag: Pair<String, String>)
abstract operator fun plusAssign(tag: Tag)

Appends the given value to this map.

abstract operator fun plusAssign(tags: Map<String, String>)

Appends the given values to this map.

Link copied to clipboard
open operator fun set(key: String, value: String)

Sets the given values as a tag in this map.

Link copied to clipboard
open fun spliterator(): Spliterator<Tag>
Link copied to clipboard
abstract fun stream(): Stream<Tag>

Returns a stream over the contents of this TagMap.

Link copied to clipboard
abstract fun toImmutable(): TagMap
Link copied to clipboard
abstract fun toList(): List<Tag>

Returns the contents of this TagMap as a list of Tag instances.

Link copied to clipboard
abstract fun toMap(): Map<String, String>

Returns the contents of this TagMap as a map of string key to string value.

Link copied to clipboard
abstract fun toSet(): Set<Tag>

Returns the contents of this TagMap as a set of Tag instances.

Properties

Link copied to clipboard
abstract val isEmpty: Boolean

Whether this MutableTagMap is empty.

Link copied to clipboard
abstract val isNotEmpty: Boolean

Whether this MutableTagMap is not empty.

Link copied to clipboard
abstract val size: Int

Number of tag pairs currently in this MutableTagMap