YamlList class

A read-only List parsed from YAML.

Inheritance
Mixed-in types
Available extensions

Constructors

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

Properties

first ↔ dynamic
The first element.
getter/setter pairinherited
hashCode int
The hash code for this object.
no setterinherited
isEmpty bool
Whether this collection has no elements.
no setterinherited
isNotEmpty bool
Whether this collection has at least one element.
no setterinherited
iterator Iterator
A new Iterator that allows iterating the elements of this Iterable.
no setterinherited
last ↔ dynamic
The last element.
getter/setter pairinherited
length int
The number of objects in this list.
getter/setter pairoverride
nodes List<YamlNode>
final
reversed Iterable
An Iterable of the objects in this list in reverse order.
no setterinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
single → dynamic
Checks that this iterable has only one element, and returns that element.
no setterinherited
span → SourceSpan
The source span for this node.
no setterinherited
style CollectionStyle
The style used for the list in the original document.
final
value List
The inner value of this node.
no setteroverride

Methods

add(dynamic element) → void
Adds value to the end of this list, extending the length by one.
inherited
addAll(Iterable iterable) → void
Appends all objects of iterable to the end of this list.
inherited
any(bool test(dynamic element)) bool
Checks whether any element of this iterable satisfies test.
inherited
asMap() Map<int, dynamic>
An unmodifiable Map view of this list.
inherited
cast<R>() List<R>
Returns a view of this list as a list of R instances.
inherited
clear() → void
Removes all objects from this list; the length of the list becomes zero.
inherited
contains(Object? element) bool
Whether the collection contains an element equal to element.
inherited
elementAt(int index) → dynamic
Returns the indexth element.
inherited
every(bool test(dynamic element)) bool
Checks whether every element of this iterable satisfies test.
inherited
expand<T>(Iterable<T> f(dynamic element)) Iterable<T>
Expands each element of this Iterable into zero or more elements.
inherited
fillRange(int start, int end, [dynamic fill]) → void
Overwrites a range of elements with fillValue.
inherited
firstWhere(bool test(dynamic element), {dynamic orElse()?}) → dynamic
The first element that satisfies the given predicate test.
inherited
fold<T>(T initialValue, T combine(T previousValue, dynamic element)) → T
Reduces a collection to a single value by iteratively combining each element of the collection with an existing value
inherited
followedBy(Iterable other) Iterable
Creates the lazy concatenation of this iterable and other.
inherited
forEach(void action(dynamic element)) → void
Invokes action on each element of this iterable in iteration order.
inherited
getRange(int start, int end) Iterable
Creates an Iterable that iterates over a range of elements.
inherited
indexOf(Object? element, [int start = 0]) int
The first index of element in this list.
inherited
indexWhere(bool test(dynamic element), [int start = 0]) int
The first index in the list that satisfies the provided test.
inherited
insert(int index, dynamic element) → void
Inserts element at position index in this list.
inherited
insertAll(int index, Iterable iterable) → void
Inserts all objects of iterable at position index in this list.
inherited
join([String separator = ""]) String
Converts each element to a String and concatenates the strings.
inherited
lastIndexOf(Object? element, [int? start]) int
The last index of element in this list.
inherited
lastIndexWhere(bool test(dynamic element), [int? start]) int
The last index in the list that satisfies the provided test.
inherited
lastWhere(bool test(dynamic element), {dynamic orElse()?}) → dynamic
The last element that satisfies the given predicate test.
inherited
map<T>(T f(dynamic element)) Iterable<T>
The current elements of this iterable modified by toElement.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
reduce(dynamic combine(dynamic previousValue, dynamic element)) → dynamic
Reduces a collection to a single value by iteratively combining elements of the collection using the provided function.
inherited
remove(Object? element) bool
Removes the first occurrence of value from this list.
inherited
removeAt(int index) → dynamic
Removes the object at position index from this list.
inherited
removeLast() → dynamic
Removes and returns the last object in this list.
inherited
removeRange(int start, int end) → void
Removes a range of elements from the list.
inherited
removeWhere(bool test(dynamic element)) → void
Removes all objects from this list that satisfy test.
inherited
replaceRange(int start, int end, Iterable newContents) → void
Replaces a range of elements with the elements of replacements.
inherited
retainWhere(bool test(dynamic element)) → void
Removes all objects from this list that fail to satisfy test.
inherited
setAll(int index, Iterable iterable) → void
Overwrites elements with the objects of iterable.
inherited
setRange(int start, int end, Iterable iterable, [int skipCount = 0]) → void
Writes some elements of iterable into a range of this list.
inherited
shuffle([Random? random]) → void
Shuffles the elements of this list randomly.
inherited
singleWhere(bool test(dynamic element), {dynamic orElse()?}) → dynamic
The single element that satisfies test.
inherited
skip(int count) Iterable
Creates an Iterable that provides all but the first count elements.
inherited
skipWhile(bool test(dynamic element)) Iterable
Creates an Iterable that skips leading elements while test is satisfied.
inherited
sort([int compare(dynamic a, dynamic b)?]) → void
Sorts this list according to the order specified by the compare function.
inherited
sublist(int start, [int? end]) List
Returns a new list containing the elements between start and end.
inherited
take(int count) Iterable
Creates a lazy iterable of the count first elements of this iterable.
inherited
takeWhile(bool test(dynamic element)) Iterable
Creates a lazy iterable of the leading elements satisfying test.
inherited
toList({bool growable = true}) List
Creates a List containing the elements of this Iterable.
inherited
toSet() Set
Creates a Set containing the same elements as this iterable.
inherited
toString() String
A string representation of this object.
inherited
where(bool test(dynamic element)) Iterable
Creates a new lazy Iterable with all elements that satisfy the predicate test.
inherited
whereType<T>() Iterable<T>
Creates a new lazy Iterable with all elements that have type T.
inherited

Operators

operator +(List other) List
Returns the concatenation of this list and other.
inherited
operator ==(Object other) bool
The equality operator.
inherited
operator [](int index) → dynamic
The object at the given index in the list.
override
operator []=(int index, Object? value) → void
Sets the value at the given index in the list to value.
override