RealmList

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

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.

Unmanaged RealmLists can be created by the user and can contain both managed and unmanaged RealmObjects. 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.

Functions

add

common

abstract override fun add(element: E): Boolean

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

addAll

common

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

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

clear

common

abstract override fun clear()

contains

common

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

containsAll

common

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

get

common

abstract operator fun get(index: Int): E

indexOf

common

abstract fun indexOf(element: E): Int

isEmpty

common

abstract override fun isEmpty(): Boolean

iterator

common

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

lastIndexOf

common

abstract fun lastIndexOf(element: E): Int

listIterator

common

abstract override fun listIterator(): MutableListIterator<E>

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

observe

common

abstract fun observe(): Flow<RealmList<E>>

remove

common

abstract override fun remove(element: E): Boolean

removeAll

common

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

removeAt

common

abstract fun removeAt(index: Int): E

retainAll

common

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

set

common

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

subList

common

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

Properties

size

common

abstract override val size: Int