RealmList

interface RealmList<E> : MutableList<E> , Deleteable

RealmList is used to model one-to-many relationships in a RealmObject or EmbeddedRealmObject.

A RealmList has two modes: managed and unmanaged. In managed mode all objects are persisted inside a Realm whereas in unmanaged mode it works as a normal MutableList.

Only Realm can create managed RealmLists. Managed RealmLists will automatically update their content whenever the underlying Realm is updated. Said content can only be accessed using the getter of a RealmObject or EmbeddedRealmObject.

Unmanaged RealmLists can be created by the user and can contain both managed and unmanaged RealmObjects or EmbeddedRealmObjects. This is useful when dealing with JSON deserializers like Gson or other frameworks that inject values into a class. Unmanaged elements in a list can be added to a Realm using the MutableRealm.copyToRealm method.

Deleting a list through MutableRealm.delete or DynamicMutableRealm.delete will delete any referenced objects from the realm and clear the list.

Parameters

the type of elements contained in the RealmList.

Functions

add

abstract override fun add(element: E): Boolean

abstract fun add(index: Int, element: E)

addAll

abstract override fun addAll(elements: Collection<E>): Boolean

abstract fun addAll(index: Int, elements: Collection<E>): Boolean

asFlow

abstract fun asFlow(): Flow<ListChange<E>>

Observes changes to the RealmList.

clear

abstract override fun clear()

contains

abstract operator override fun contains(element: E): Boolean

containsAll

abstract override fun containsAll(elements: Collection<E>): Boolean

get

abstract operator fun get(index: Int): E

indexOf

abstract fun indexOf(element: E): Int

isEmpty

abstract override fun isEmpty(): Boolean

iterator

abstract operator override fun iterator(): Iterator<E>

lastIndexOf

abstract fun lastIndexOf(element: E): Int

listIterator

abstract override fun listIterator(): MutableListIterator<E>

abstract override fun listIterator(index: Int): MutableListIterator<E>

remove

abstract override fun remove(element: E): Boolean

removeAll

abstract override fun removeAll(elements: Collection<E>): Boolean

removeAt

abstract fun removeAt(index: Int): E

retainAll

abstract override fun retainAll(elements: Collection<E>): Boolean

set

abstract operator override fun set(index: Int, element: E): E

Replaces the element at the specified position in this list with the specified element.

subList

abstract override fun subList(fromIndex: Int, toIndex: Int): MutableList<E>

Properties

size

abstract override val size: Int

Extensions

copyFromRealm

inline fun <T : TypedRealmObject> RealmList<T>.copyFromRealm(depth: UInt = UInt.MAX_VALUE): List<T>

Makes an unmanaged in-memory copy of the elements in a managed RealmList.

query

fun <T : BaseRealmObject> RealmList<T>.query(filter: String = TRUE_PREDICATE, vararg arguments: Any?): RealmQuery<T>

Query the objects in a list by filter and arguments.