YamlMap class - _common library

Constructors

YamlMap({Object? sourceUrl}): Creates an empty YamlMap.
factory
YamlMap.internal(Map<dynamic, YamlNode> nodes, SourceSpan span, CollectionStyle style): Users of the library should not use this constructor.
YamlMap.wrap(Map dartMap, {Object? sourceUrl, CollectionStyle style = CollectionStyle.ANY}): Wraps a Dart map so that it can be accessed (recursively) like a YamlMap.
factory

Properties

entries → Iterable<MapEntry>: The map entries of this Map.
no setterinherited
first ← dynamic: Throws an UnsupportedError; operations that change the map are disallowed.
no getterinherited
genericTypeKey → Type: Available on Map<K, V>, provided by the GenericTypeOnMapExtension extension
Returns the generic type of the map's keys.
no setter
genericTypeValue → Type: Available on Map<K, V>, provided by the GenericTypeOnMapExtension extension
Returns the generic type of the map's values.
no setter
hashCode → int: The hash code for this object.
no setterinherited
isEmpty → bool: Whether there is no key/value pair in the map.
no setterinherited
isNotEmpty → bool: Whether there is at least one key/value pair in the map.
no setterinherited
keys → Iterable: The keys of this Map.
no setteroverride
last ← dynamic: Throws an UnsupportedError; operations that change the map are disallowed.
no getterinherited
length → int: The number of key/value pairs in the map.
no setterinherited
nodes → Map<dynamic, YamlNode>: A view of this where the keys and values are guaranteed to be YamlNodes.
final
nonNullKeys → Map<K, V>: Available on Map<K?, V>, provided by the NonNullKeysOnMapExtension extension
Returns a new map with all non-null keys and values.
no setter
nonNulls → Map<K, V>: Available on Map<K?, V?>, provided by the NonNullsOnMapExtension extension
Returns a new map with all non-null keys and values.
no setter
nonNullValues → Map<K, V>: Available on Map<K, V?>, provided by the NonNullValuesOnMapExtension extension
Returns a new map with all non-null keys and values.
no setter
nullIfEmpty → Map<T1, T2>?: Available on Map<T1, T2>, provided by the NullIfEmptyOnMapExtension extension
Returns null if the Map is empty, otherwise returns the Map.
no setter
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
span → SourceSpan: The source span for this node.
no setterinherited
style → CollectionStyle: The style used for the map in the original document.
final
value → Map: The inner value of this node.
no setteroverride
values → Iterable: The values of this Map.
no setterinherited

Methods

addAll(Map other) → void: Throws an UnsupportedError; operations that change the map are disallowed.
inherited
addEntries(Iterable<MapEntry> newEntries) → void: Adds all key/value pairs of newEntries to this map.
inherited
cast<RK, RV>() → Map<RK, RV>: Provides a view of this map as having RK keys and RV instances, if necessary.
inherited
clear() → void: Throws an UnsupportedError; operations that change the map are disallowed.
inherited
containsKey(Object? key) → bool: Whether this map contains the given key.
inherited
containsValue(Object? value) → bool: Whether this map contains the given value.
inherited
filterByExcludedKeys(List<K> excludedKeys) → Map<K, V>: Available on Map<K, V>, provided by the MapWithDefaultOnMapExtension extension
Filters the map's entries based on a list of excluded keys. Returns a new map excluding the key-value pairs where the key is found within the excludedKeys.
filterByExcludedValues(List<V> excludedValues) → Map<K, V>: Available on Map<K, V>, provided by the MapWithDefaultOnMapExtension extension
Filters the map's entries based on a list of excluded values. Returns a new map excluding the key-value pairs where the value is found within the excludedValues.
filterByIncludedKeys(List<K> includedKeys) → Map<K, V>: Available on Map<K, V>, provided by the MapWithDefaultOnMapExtension extension
Filters the map's entries based on a list of included keys. Returns a new map containing only the key-value pairs where the key is found within the includedKeys.
filterByIncludedValues(List<V> includedValues) → Map<K, V>: Available on Map<K, V>, provided by the MapWithDefaultOnMapExtension extension
Filters the map's entries based on a list of included values. Returns a new map containing only the key-value pairs where the value is found within the includedValues.
firstWhereOrNull(bool test(MapEntry<K, V>)) → MapEntry<K, V>?: Available on Map<K, V>, provided by the FirstWhereOrNullOnMapExtension extension
Returns the first entry that satisfies the given predicate test, or null if there are none.
forEach(void action(dynamic key, dynamic value)) → void: Applies action to each key/value pair of the map.
inherited
map<K2, V2>(MapEntry<K2, V2> transform(dynamic key, dynamic value)) → Map<K2, V2>: Returns a new map where all entries of this map are transformed by the given convert function.
inherited
mapi<B1, B2, C>(MapEntry<B1, B2> mapper(A1 e1, A2 e2, int index, C? option), {List<C> options = const []}) → Map<B1, B2>: Available on Map<A1, A2>, provided by the MapIOnMapExtension extension
Maps a map with an index and an optional option.
mapKeys<K2>(K2 mapper(K1 key)) → Map<K2, V1>: Available on Map<K1, V1>, provided by the MapKeysAndValyesOnMapExtension extension
Returns a new map with new keys and the same values.
mapValues<V2>(V2 mapper(V1 value)) → Map<K1, V2>: Available on Map<K1, V1>, provided by the MapKeysAndValyesOnMapExtension extension
Returns a new map with the same keys and new values.
mapWithDefault(dynamic defaultValue) → Map<K, dynamic>: Available on Map<K, V>, provided by the MapWithDefaultOnMapExtension extension
Returns a new map with the same keys as this map but with the specified defaultValue for all values that are null. If defaultValue is null, it simply returns a copy of the original map.
maybeAdd(Map<T1, T2>? add) → Map<T1, T2>: Available on Map<T1, T2>, provided by the MaybeAddToMapExtension extension
Adds add to this its not null.
noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
putIfAbsent(dynamic key, dynamic ifAbsent()) → dynamic: Throws an UnsupportedError; operations that change the map are disallowed.
inherited
remove(Object? key) → dynamic: Throws an UnsupportedError; operations that change the map are disallowed.
inherited
removeWhere(bool test(dynamic key, dynamic value)) → void: Removes all entries of this map that satisfy the given test.
inherited
setNestedValue(List keyPath, dynamic value) → void: Available on Map, provided by the SetNestedValueOnMapExtension extension
Sets a value in a nested map structure, creating intermediate maps as needed.
toString() → String: A string representation of this object.
inherited
update(dynamic key, dynamic update(dynamic value), {dynamic ifAbsent()?}) → dynamic: Updates the value for the provided key.
inherited
updateAll(dynamic update(dynamic key, dynamic value)) → void: Updates all values.
inherited

Operators

operator ==(Object other) → bool: The equality operator.
inherited
operator [](Object? key) → dynamic: The value for the given key, or null if key is not in the map.
override
operator []=(dynamic key, dynamic value) → void: Throws an UnsupportedError; operations that change the map are disallowed.
inherited