Class OrderedRealmCollectionSnapshot

On this page

io.realm

Method Summary
Inherited Methods
Method Detail
createSnapshot
deleteAllFromRealm
deleteFirstFromRealm
deleteFromRealm
deleteLastFromRealm
freeze
isFrozen
isLoaded
load
size
sort
where

Atlas Device SDKs are deprecated. Refer to the deprecation page for details.

io.realm

java.lang.Object

java.util.AbstractCollection

java.util.AbstractList

io.realm.OrderedRealmCollectionImpl

io.realm.OrderedRealmCollectionSnapshot

An OrderedRealmCollectionSnapshot is a special type of OrderedRealmCollection . It can be created by calling OrderedRealmCollection.createSnapshot() . Unlike RealmResults and RealmList , its size and order of elements will never be changed after creation.

OrderedRealmCollectionSnapshot is useful when making changes which may impact the size or order of the collection in simple loops. For example:

final RealmResults<Dog>  dogs = realm.where(Dog.class).findAll();
final OrderedRealmCollectionSnapshot<Dog> snapshot = dogs.createSnapshot();
final int dogsCount = snapshot.size(); // dogs.size() == snapshot.size() == 10
realm.executeTransaction(new Realm.Transaction() {
    /@Override
    public void execute(Realm realm) {
        for (int i = 0; i < dogsCount; i++) {
        // This won't work since RealmResults is always up-to-date, its size gets decreased by 1 after every loop. An
        // IndexOutOfBoundsException will be thrown after 5 loops.
        // dogs.deleteFromRealm(i);
        snapshot.deleteFromRealm(i); // Deletion on OrderedRealmCollectionSnapshot won't change the size of it.
        }
    }
});

Method Summary

Modifier and Type	Method and Description
public OrderedRealmCollectionSnapshot	createSnapshot () Creates a snapshot from this OrderedRealmCollection .
public boolean	deleteAllFromRealm () This deletes all objects in the collection from the underlying Realm.
public boolean	deleteFirstFromRealm () Deletes the first object from the Realm.
public void	deleteFromRealm ( int location ) Deletes the object at the given index from the Realm.
public boolean	deleteLastFromRealm () Deletes the last object from the Realm.
public OrderedRealmCollection	freeze ()
public boolean	isFrozen ()
public boolean	isLoaded () Checks if a collection has finished loading its data yet.
public boolean	load () Blocks the collection until all data are available.
public int	size () Returns the number of elements in this query result.
public RealmResults	sort ( java.lang.String[] fieldNames, io.realm.Sort[] sortOrders ) Not supported by OrderedRealmCollectionSnapshot .
public RealmResults	sort ( String fieldName1, Sort sortOrder1, String fieldName2, Sort sortOrder2 ) Not supported by OrderedRealmCollectionSnapshot .
public RealmResults	sort ( String fieldName, Sort sortOrder ) Not supported by OrderedRealmCollectionSnapshot .
public RealmResults	sort ( String fieldName ) Not supported by OrderedRealmCollectionSnapshot .
public RealmQuery	where () Not supported by OrderedRealmCollectionSnapshot .

Inherited Methods

Methods inherited from class java.lang.Object : getClass , hashCode , equals , clone , toString , notify , notifyAll , wait , wait , wait , finalize
Methods inherited from class java.util.AbstractCollection : iterator , size , isEmpty , contains , toArray , toArray , add , remove , containsAll , addAll , removeAll , retainAll , clear , toString
Methods inherited from class java.util.AbstractList : add , get , set , add , remove , indexOf , lastIndexOf , clear , addAll , iterator , listIterator , listIterator , subList , equals , hashCode , removeRange
Methods inherited from class io.realm.OrderedRealmCollectionImpl: isValid , isManaged , contains , get , first , first , last , last , deleteFromRealm , deleteAllFromRealm , iterator , listIterator , listIterator , sort , sort , sort , sort , size , min , minDate , max , maxDate , sum , average , remove , remove , removeAll , set , retainAll , deleteLastFromRealm , deleteFirstFromRealm , clear , add , add , addAll , addAll , createSnapshot , getRealm , getCollectionOperator

Method Detail

createSnapshot

public OrderedRealmCollectionSnapshot createSnapshot ()
Creates a snapshot from this OrderedRealmCollection . Returns the snapshot of this collection. Overrides `createSnapshot` in class OrderedRealmCollectionImpl

deleteAllFromRealm

public boolean deleteAllFromRealm ()

This deletes all objects in the collection from the underlying Realm. All objects in the collection snapshot will become invalid.

Returns

true if objects was deleted, false otherwise.

Throws

IllegalStateException - if the corresponding Realm is closed or in an incorrect thread.
java.lang.IllegalStateException - if the Realm has been closed or called from an incorrect thread.

Overrides

deleteAllFromRealm in class OrderedRealmCollectionImpl

deleteFirstFromRealm

public boolean deleteFirstFromRealm ()
Deletes the first object from the Realm. The first object will become invalid. Returns `true` if an object was deleted, `false` otherwise. Throws java.lang.IllegalStateException - if the Realm is closed or the method is called on the wrong thread. Overrides `deleteFirstFromRealm` in class OrderedRealmCollectionImpl

deleteFromRealm

public void deleteFromRealm (

int location

)

Deletes the object at the given index from the Realm. The object at the given index will become invalid. Just returns if the object is invalid already.

Parameters

location - the array index identifying the object to be removed.

Throws

IndexOutOfBoundsException - if location < 0 || location >= size() .
java.lang.IllegalStateException - if the Realm is closed or the method is called from the wrong thread.

Overrides

deleteFromRealm in class OrderedRealmCollectionImpl

deleteLastFromRealm

public boolean deleteLastFromRealm ()
Deletes the last object from the Realm. The last object will become invalid. Returns `true` if an object was deleted, `false` otherwise. Throws java.lang.IllegalStateException - if the Realm is closed or the method is called from the wrong thread. Overrides `deleteLastFromRealm` in class OrderedRealmCollectionImpl

freeze

public OrderedRealmCollection freeze ()

isFrozen

public boolean isFrozen ()

isLoaded

public boolean isLoaded ()
Checks if a collection has finished loading its data yet. Returns `true` if data has been loaded and is available, `false` if data is still being loaded.

load

public boolean load ()
Blocks the collection until all data are available. Returns `true` if the data could be successfully loaded, `false` otherwise.

size

public int size ()
Returns the number of elements in this query result. Returns the number of elements in this query result. Overrides `size` in class OrderedRealmCollectionImpl

sort

public RealmResults sort ( java.lang.String[] fieldNames, io.realm.Sort[] sortOrders )
Not supported by OrderedRealmCollectionSnapshot . Use 'sort()' on the original OrderedRealmCollection instead. Returns a new sorted RealmResults will be created and returned. The original collection stays unchanged. Throws UnsupportedOperationException - Overrides `sort` in class OrderedRealmCollectionImpl

public RealmResults sort ( String fieldName1, Sort sortOrder1, String fieldName2, Sort sortOrder2 )
Not supported by OrderedRealmCollectionSnapshot . Use 'sort()' on the original OrderedRealmCollection instead. Returns a new sorted RealmResults will be created and returned. The original collection stays unchanged. Throws UnsupportedOperationException - Overrides `sort` in class OrderedRealmCollectionImpl

public RealmResults sort ( String fieldName, Sort sortOrder )
Not supported by OrderedRealmCollectionSnapshot . Use 'sort()' on the original OrderedRealmCollection instead. Returns a new sorted RealmResults will be created and returned. The original collection stays unchanged. Throws UnsupportedOperationException - Overrides `sort` in class OrderedRealmCollectionImpl

public RealmResults sort ( String fieldName )
Not supported by OrderedRealmCollectionSnapshot . Use 'sort()' on the original OrderedRealmCollection instead. Returns a new sorted RealmResults will be created and returned. The original collection stays unchanged. Throws UnsupportedOperationException - Overrides `sort` in class OrderedRealmCollectionImpl

where

public RealmQuery where ()
Not supported by OrderedRealmCollectionSnapshot . Use 'where()' on the original OrderedRealmCollection instead. Returns a RealmQuery object. Throws UnsupportedOperationException -

Back

OrderedRealmCollectionChangeListener

ProxyState