RealmList<T extends Object?> class
abstract
Realm
Instances of this class are live collections and will update as new elements are either added to or deleted from the collection or from the Realm.
- Implemented types
-
- List<
T>
- List<
- Mixed-in types
- Available extensions
Properties
-
changes
→ Stream<
RealmListChanges< T> > -
Allows listening for changes when the contents of this collection changes.
no setter
- first ↔ T
-
The first element.
getter/setter pairinherited
- firstOrNull → T?
-
Available on Iterable<
The first element of this iterator, orT> , provided by the IterableExtensions extensionnull
if the iterable is empty.no setter - hashCode → int
-
The hash code for this object.
no setterinherited
-
indexed
→ Iterable<
(int, T)> -
Available on Iterable<
Pairs of elements of the indices and elements of this iterable.T> , provided by the IterableExtensions extensionno setter - isEmpty → bool
-
Whether this collection has no elements.
no setterinherited
- isFrozen → bool
-
True if the entity belongs to a frozen Realm.
no setterinherited
- isManaged → bool
-
True if the object belongs to a Realm.
no setterinherited
- isNotEmpty → bool
-
Whether this collection has at least one element.
no setterinherited
- isValid → bool
-
Gets a value indicating whether this collection is still valid to use.
no setter
-
iterator
→ Iterator<
T> -
A new
Iterator
that allows iterating the elements of thisIterable
.no setterinherited - last ↔ T
-
The last element.
getter/setter pairinherited
- lastOrNull → T?
-
Available on Iterable<
The last element of this iterable, orT> , provided by the IterableExtensions extensionnull
if the iterable is empty.no setter - length ↔ int
-
The number of objects in this list.
getter/setter pairinherited
-
nonNulls
→ Iterable<
T> -
Available on Iterable<
The non-T?> , provided by the NullableIterableExtensions extensionnull
elements of this iterable.no setter - realm → Realm
-
The Realm instance this object belongs to.
no setterinherited
-
reversed
→ Iterable<
T> -
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 → T
-
Checks that this iterable has only one element, and returns that element.
no setterinherited
- singleOrNull → T?
-
Available on Iterable<
The single element of this iterator, orT> , provided by the IterableExtensions extensionnull
.no setter -
toJS
→ JSArray<
T> -
Available on List<
Converts this List to a JSArray by either casting, unwrapping, or cloning the List.T> , provided by the ListToJSArray extensionno setter -
toJSProxyOrRef
→ JSArray<
T> -
Available on List<
Converts this List to a JSArray by either casting, unwrapping, or proxying the List.T> , provided by the ListToJSArray extensionno setter -
wait
→ Future<
List< T> > -
Available on Iterable<
Waits for futures in parallel.Future< , provided by the FutureIterable extensionT> >no setter
Methods
-
add(
T value) → void -
Adds
value
to the end of this list, extending the length by one.inherited -
addAll(
Iterable< T> iterable) → void -
Appends all objects of
iterable
to the end of this list.inherited -
any(
bool test(T element)) → bool -
Checks whether any element of this iterable satisfies
test
.inherited -
asMap(
) → Map< int, T> -
An unmodifiable Map view of this list.
inherited
-
asNameMap(
) → Map< String, T> -
Available on Iterable<
Creates a map from the names of enum values to the values.T> , provided by the EnumByName extension -
asResults(
) → RealmResults< T> - Converts this List to a RealmResults.
-
byName(
String name) → T -
Available on Iterable<
Finds the enum value in this list with nameT> , provided by the EnumByName extensionname
. -
cast<
R> () → List< R> -
Returns a view of this list as a list of
R
instances.inherited -
changesFor(
[List< String> ? keyPaths]) → Stream<RealmListChanges< T> > -
Available on RealmList<
Allows listening for changes when the contents of this collection changes on one of the providedT> , provided by the RealmListOfObject extensionkeyPaths
. IfkeyPaths
is null, default notifications will be raised (same asRealmList.change
). IfkeyPaths
is an empty list, only notifications related to the collection itself will be raised (such as adding or removing elements). -
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) → T -
Returns the
index
th element.inherited -
elementAtOrNull(
int index) → T? -
Available on Iterable<
The element at positionT> , provided by the IterableExtensions extensionindex
of this iterable, ornull
. -
every(
bool test(T element)) → bool -
Checks whether every element of this iterable satisfies
test
.inherited -
expand<
T> (Iterable< T> toElements(T element)) → Iterable<T> -
Expands each element of this Iterable into zero or more elements.
inherited
-
fillRange(
int start, int end, [T? fillValue]) → void -
Overwrites a range of elements with
fillValue
.inherited -
firstWhere(
bool test(T element), {T orElse()?}) → T -
The first element that satisfies the given predicate
test
.inherited -
fold<
T> (T initialValue, T combine(T previousValue, T element)) → T -
Reduces a collection to a single value by iteratively combining each
element of the collection with an existing value
inherited
-
followedBy(
Iterable< T> other) → Iterable<T> -
Creates the lazy concatenation of this iterable and
other
.inherited -
forEach(
void action(T element)) → void -
Invokes
action
on each element of this iterable in iteration order.inherited -
freeze(
) → RealmList< T> -
Creates a frozen snapshot of this
RealmList
. -
getRange(
int start, int end) → Iterable< T> -
Creates an Iterable that iterates over a range of elements.
inherited
-
indexOf(
T element, [int start = 0]) → int -
The first index of
element
in this list.inherited -
indexWhere(
bool test(T element), [int start = 0]) → int -
The first index in the list that satisfies the provided
test
.inherited -
insert(
int index, T element) → void -
Inserts
element
at positionindex
in this list.inherited -
insertAll(
int index, Iterable< T> iterable) → void -
Inserts all objects of
iterable
at positionindex
in this list.inherited -
join(
[String separator = ""]) → String -
Converts each element to a String and concatenates the strings.
inherited
-
lastIndexOf(
T element, [int? start]) → int -
The last index of
element
in this list.inherited -
lastIndexWhere(
bool test(T element), [int? start]) → int -
The last index in the list that satisfies the provided
test
.inherited -
lastWhere(
bool test(T element), {T orElse()?}) → T -
The last element that satisfies the given predicate
test
.inherited -
map<
T> (T toElement(T e)) → Iterable< T> -
The current elements of this iterable modified by
toElement
.inherited -
move(
int from, int to) → void -
Available on List<
Move the element at indexT> , provided by the ListExtension extensionfrom
to indexto
. -
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
query(
String query, [List< Object?> arguments = const []]) → RealmResults<T> -
Available on RealmList<
Filters the list and returns a new RealmResults according to the providedT> , provided by the RealmListOfObject extensionquery
(with optionalarguments
). -
reduce(
T combine(T value, T element)) → T -
Reduces a collection to a single value by iteratively combining elements
of the collection using the provided function.
inherited
-
remove(
Object? value) → bool -
Removes the first occurrence of
value
from this list.inherited -
removeAt(
int index) → T -
Removes the object at position
index
from this list.inherited -
removeLast(
) → T -
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(T element)) → void -
Removes all objects from this list that satisfy
test
.inherited -
replaceRange(
int start, int end, Iterable< T> replacements) → void -
Replaces a range of elements with the elements of
replacements
.inherited -
retainWhere(
bool test(T element)) → void -
Removes all objects from this list that fail to satisfy
test
.inherited -
setAll(
int index, Iterable< T> iterable) → void -
Overwrites elements with the objects of
iterable
.inherited -
setRange(
int start, int end, Iterable< T> 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(T element), {T orElse()?}) → T -
The single element that satisfies
test
.inherited -
skip(
int count) → Iterable< T> -
Creates an Iterable that provides all but the first
count
elements.inherited -
skipWhile(
bool test(T value)) → Iterable< T> -
Creates an
Iterable
that skips leading elements whiletest
is satisfied.inherited -
sort(
[int compare(T a, T b)?]) → void -
Sorts this list according to the order specified by the
compare
function.inherited -
sublist(
int start, [int? end]) → List< T> -
Returns a new list containing the elements between
start
andend
.inherited -
take(
int count) → Iterable< T> -
Creates a lazy iterable of the
count
first elements of this iterable.inherited -
takeWhile(
bool test(T value)) → Iterable< T> -
Creates a lazy iterable of the leading elements satisfying
test
.inherited -
toEJson(
) → EJsonValue? -
Available on List<
Converts this List to EJsonObject?> , provided by the ListEJsonEncoderExtension extension -
toList(
{bool growable = true}) → List< T> -
Creates a List containing the elements of this Iterable.
inherited
-
toSet(
) → Set< T> -
Creates a Set containing the same elements as this iterable.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
-
where(
bool test(T element)) → Iterable< T> -
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< T> other) → List<T> -
Returns the concatenation of this list and
other
.inherited -
operator ==(
Object other) → bool -
The equality operator.
inherited
-
operator [](
int index) → T -
The object at the given
index
in the list.inherited -
operator []=(
int index, T value) → void -
Sets the value at the given
index
in the list tovalue
.inherited