StringMap

open class StringMap: MapBase

A map from key type string to value type string.

  • An immutable empty StringMap.

    Declaration

    Swift

    public static let empty: StringMap = StringMap(capacity: Int(Int32.min))

  • Construct a new map with size of zero and optional initial capacity. A map can expand in size beyond its initial capacity, but best performance will be obtained if the initial capacity is close to the map’s maximum size.

    Declaration

    Swift

    public init(capacity: Int = (16 as Int))

    Parameters

    capacity

    Optional initial capacity.

  • Declaration

    Swift

    open func containsValue(forKey key: String) -> Bool

    Parameters

    key

    Entry key.

    Return Value

    true if this map has an entry with the specified key, otherwise false.

  • Declaration

    Swift

    open func entries() -> StringMap.EntryList

    Return Value

    A list of the entries (key/value pairs) in this map.

  • Invert this map of keys to values to another map of values to keys.

    Declaration

    Swift

    open func inverse() -> StringMap

    Return Value

    New inverted map.

  • Declaration

    Swift

    open func keys() -> StringList

    Return Value

    A list of the entry keys in this map.

  • Delete the entry with the specified key (if found).

    Declaration

    Swift

    open func removeValue(forKey key: String) -> Bool

    Parameters

    key

    Entry key.

    Return Value

    true if an entry with the specified key was found (and deleted).

  • Throws

    MissingEntryException if no entry is found for the specified key.

    Declaration

    Swift

    open func requiredValue(forKey key: String) -> String

    Parameters

    key

    Entry key.

    Return Value

    The value from the entry with the specified key (if found).

  • The underlying untyped map of objects. Use with care, avoiding the addition of objects with an incorrect item type.

    Declaration

    Swift

    override open var untypedMap: UntypedMap

  • Add or replace an entry with the specified key and value.

    Declaration

    Swift

    open func updateValue(_ value: String, forKey key: String) -> Void

    Parameters

    value

    Entry value.
    key

    Entry key.

  • Declaration

    Swift

    open func value(forKey key: String) -> String?

    Parameters

    key

    Entry key.

    Return Value

    The value from the entry with the specified key (if found), otherwise nil.

  • Declaration

    Swift

    open func values() -> StringList

    Return Value

    A list of the entry values in this map.

  • A key/value pair for map entries.

    See more

    Declaration

    Swift

    open class Entry: ObjectBase

  • A list of item type StringMap$Entry.

    See more

    Declaration

    Swift

    open class EntryList: ListBase, Sequence