OrderedRealmCollectionSnapshot (Realm 3.5.0)

java.lang.Object
- java.util.AbstractCollection<E>
- - java.util.AbstractList<E>
  - - io.realm.OrderedRealmCollectionSnapshot<E>

All Implemented Interfaces:: OrderedRealmCollection<E>, RealmCollection<E>, Iterable<E>, Collection<E>, List<E>

public class OrderedRealmCollectionSnapshot<E extends RealmModel>
extends AbstractList<E>

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

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`add(E element)` Deprecated.
`void`	`add(int index, E element)` Deprecated.
`boolean`	`addAll(Collection<? extends E> collection)` Deprecated.
`boolean`	`addAll(int location, Collection<? extends E> collection)` Deprecated.
`double`	`average(String fieldName)` Returns the average of a given field.
`void`	`clear()` Deprecated.
`boolean`	`contains(Object object)` Searches this `OrderedRealmCollection` for the specified object.
`OrderedRealmCollectionSnapshot<E>`	`createSnapshot()` Creates a snapshot from this `OrderedRealmCollection`.
`boolean`	`deleteAllFromRealm()` This deletes all objects in the collection from the underlying Realm.
`boolean`	`deleteFirstFromRealm()` Deletes the first object from the Realm.
`void`	`deleteFromRealm(int location)` Deletes the object at the given index from the Realm.
`boolean`	`deleteLastFromRealm()` Deletes the last object from the Realm.
`E`	`first()` Gets the first object from the collection.
`E`	`first(E defaultValue)` Gets the first object from the collection.
`E`	`get(int location)` Returns the element at the specified location in this list.
`boolean`	`isLoaded()` Checks if a collection has finished loading its data yet.
`boolean`	`isManaged()` A `RealmResults` or a `OrderedRealmCollectionSnapshot` is always a managed collection.
`boolean`	`isValid()` Checks if the collection is still valid to use, i.e., the `Realm` instance hasn't been closed.
`Iterator<E>`	`iterator()` Returns an iterator for the results of a query.
`E`	`last()` Gets the last object from the collection.
`E`	`last(E defaultValue)` Gets the last object from the collection.
`ListIterator<E>`	`listIterator()` Returns a list iterator for the results of a query.
`ListIterator<E>`	`listIterator(int location)` Returns a list iterator on the results of a query.
`boolean`	`load()` Blocks the collection until all data are available.
`Number`	`max(String fieldName)` Finds the maximum value of a field.
`Date`	`maxDate(String fieldName)` Finds the maximum date.
`Number`	`min(String fieldName)` Finds the minimum value of a field.
`Date`	`minDate(String fieldName)` Finds the minimum date.
`E`	`remove(int index)` Deprecated.
`boolean`	`remove(Object object)` Deprecated.
`boolean`	`removeAll(Collection<?> collection)` Deprecated.
`boolean`	`retainAll(Collection<?> collection)` Deprecated.
`E`	`set(int location, E object)` Deprecated.
`int`	`size()` Returns the number of elements in this query result.
`RealmResults<E>`	`sort(String fieldName)` Not supported by `OrderedRealmCollectionSnapshot`.
`RealmResults<E>`	`sort(String[] fieldNames, Sort[] sortOrders)` Not supported by `OrderedRealmCollectionSnapshot`.
`RealmResults<E>`	`sort(String fieldName, Sort sortOrder)` Not supported by `OrderedRealmCollectionSnapshot`.
`RealmResults<E>`	`sort(String fieldName1, Sort sortOrder1, String fieldName2, Sort sortOrder2)` Not supported by `OrderedRealmCollectionSnapshot`.
`Number`	`sum(String fieldName)` Calculates the sum of a given field.
`RealmQuery<E>`	`where()` Deprecated.

Methods inherited from class java.util.AbstractList
equals, hashCode, indexOf, lastIndexOf, subList

Methods inherited from class java.util.AbstractCollection
containsAll, isEmpty, toArray, toArray, toString

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.List
containsAll, equals, hashCode, indexOf, isEmpty, lastIndexOf, replaceAll, sort, spliterator, subList, toArray, toArray

Methods inherited from interface java.util.Collection
parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable
forEach

- Method Detail
  - size
```
public int size()
```
    Returns the number of elements in this query result.
    
    Specified by:
    
    size in interface Collection<E extends RealmModel>
    
    Specified by:
    
    size in interface List<E extends RealmModel>
    
    Returns:
    
    the number of elements in this query result.
  - sort
```
public RealmResults<E> sort(String fieldName)
```
    Not supported by OrderedRealmCollectionSnapshot. Use 'sort()' on the original OrderedRealmCollection instead.
    
    Specified by:
    
    sort in interface OrderedRealmCollection<E extends RealmModel>
    
    Parameters:
    
    fieldName - the field name to sort by. Only fields of type boolean, short, int, long, float, double, Date, and String are supported.
    
    Returns:
    
    a new sorted RealmResults will be created and returned. The original collection stays unchanged.
    
    Throws:
    
    UnsupportedOperationException
  - sort
```
public RealmResults<E> sort(String fieldName,
                            Sort sortOrder)
```
    Not supported by OrderedRealmCollectionSnapshot. Use 'sort()' on the original OrderedRealmCollection instead.
    
    Specified by:
    
    sort in interface OrderedRealmCollection<E extends RealmModel>
    
    Parameters:
    
    fieldName - the field name to sort by. Only fields of type boolean, short, int, long, float, double, Date, and String are supported.
    
    sortOrder - the direction to sort by.
    
    Returns:
    
    a new sorted RealmResults will be created and returned. The original collection stays unchanged.
    
    Throws:
    
    UnsupportedOperationException
  - sort
```
public RealmResults<E> sort(String fieldName1,
                            Sort sortOrder1,
                            String fieldName2,
                            Sort sortOrder2)
```
    Not supported by OrderedRealmCollectionSnapshot. Use 'sort()' on the original OrderedRealmCollection instead.
    
    Specified by:
    
    sort in interface OrderedRealmCollection<E extends RealmModel>
    
    Parameters:
    
    fieldName1 - first field name. Only fields of type boolean, short, int, long, float, double, Date, and String are supported.
    
    sortOrder1 - sort order for first field.
    
    fieldName2 - second field name. Only fields of type boolean, short, int, long, float, double, Date, and String are supported.
    
    sortOrder2 - sort order for second field.
    
    Returns:
    
    a new sorted RealmResults will be created and returned. The original collection stays unchanged.
    
    Throws:
    
    UnsupportedOperationException
  - sort
```
public RealmResults<E> sort(String[] fieldNames,
                            Sort[] sortOrders)
```
    Not supported by OrderedRealmCollectionSnapshot. Use 'sort()' on the original OrderedRealmCollection instead.
    
    Specified by:
    
    sort in interface OrderedRealmCollection<E extends RealmModel>
    
    Parameters:
    
    fieldNames - an array of field names to sort by. Only fields of type boolean, short, int, long, float, double, Date, and String are supported.
    
    sortOrders - the directions to sort by.
    
    Returns:
    
    a new sorted RealmResults will be created and returned. The original collection stays unchanged.
    
    Throws:
    
    UnsupportedOperationException
  - where
```
@Deprecated
public RealmQuery<E> where()
```
    Deprecated.
    
    Not supported by OrderedRealmCollectionSnapshot. Use 'where()' on the original OrderedRealmCollection instead.
    
    Returns:
    
    a RealmQuery object.
    
    Throws:
    
    UnsupportedOperationException
    
    See Also:
    
    RealmQuery
  - 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.
  - createSnapshot
```
public OrderedRealmCollectionSnapshot<E> createSnapshot()
```
    Creates a snapshot from this OrderedRealmCollection.
    
    Specified by:
    
    createSnapshot in interface OrderedRealmCollection<E extends RealmModel>
    
    Returns:
    
    the snapshot of this collection.
    
    See Also:
    
    OrderedRealmCollectionSnapshot
  - 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.
    
    Specified by:
    
    deleteFromRealm in interface OrderedRealmCollection<E extends RealmModel>
    
    Parameters:
    
    location - the array index identifying the object to be removed.
    
    Throws:
    
    IndexOutOfBoundsException - if location < 0 || location >= size().
    
    IllegalStateException - if the Realm is closed or the method is called from the wrong thread.
  - deleteFirstFromRealm
```
public boolean deleteFirstFromRealm()
```
    Deletes the first object from the Realm. The first object will become invalid.
    
    Specified by:
    
    deleteFirstFromRealm in interface OrderedRealmCollection<E extends RealmModel>
    
    Returns:
    
    true if an object was deleted, false otherwise.
    
    Throws:
    
    IllegalStateException - if the Realm is closed or the method is called on the wrong thread.
  - deleteLastFromRealm
```
public boolean deleteLastFromRealm()
```
    Deletes the last object from the Realm. The last object will become invalid.
    
    Specified by:
    
    deleteLastFromRealm in interface OrderedRealmCollection<E extends RealmModel>
    
    Returns:
    
    true if an object was deleted, false otherwise.
    
    Throws:
    
    IllegalStateException - if the Realm is closed or the method is called from the wrong thread.
  - deleteAllFromRealm
```
public boolean deleteAllFromRealm()
```
    This deletes all objects in the collection from the underlying Realm. All objects in the collection snapshot will become invalid.
    
    Specified by:
    
    deleteAllFromRealm in interface RealmCollection<E extends RealmModel>
    
    Returns:
    
    true if objects was deleted, false otherwise.
    
    Throws:
    
    IllegalStateException - if the corresponding Realm is closed or in an incorrect thread.
    
    IllegalStateException - if the Realm has been closed or called from an incorrect thread.
  - isValid
```
public boolean isValid()
```
    Checks if the collection is still valid to use, i.e., the Realm instance hasn't been closed. It will always return true for an unmanaged collection.
    
    Specified by:
    
    isValid in interface RealmCollection<E extends RealmModel>
    
    Returns:
    
    true if it is still valid to use or an unmanaged collection, false otherwise.
  - isManaged
```
public boolean isManaged()
```
    A RealmResults or a OrderedRealmCollectionSnapshot is always a managed collection.
    
    Specified by:
    
    isManaged in interface RealmCollection<E extends RealmModel>
    
    Returns:
    
    true.
    
    See Also:
    
    RealmCollection.isManaged()
  - contains
```
public boolean contains(Object object)
```
    Searches this OrderedRealmCollection for the specified object.
    
    Specified by:
    
    contains in interface RealmCollection<E extends RealmModel>
    
    Specified by:
    
    contains in interface Collection<E extends RealmModel>
    
    Specified by:
    
    contains in interface List<E extends RealmModel>
    
    Overrides:
    
    contains in class AbstractCollection<E extends RealmModel>
    
    Parameters:
    
    object - the object to search for.
    
    Returns:
    
    true if object is an element of this OrderedRealmCollection, false otherwise.
  - get
```
public E get(int location)
```
    Returns the element at the specified location in this list.
    
    Specified by:
    
    get in interface List<E extends RealmModel>
    
    Specified by:
    
    get in class AbstractList<E extends RealmModel>
    
    Parameters:
    
    location - the index of the element to return.
    
    Returns:
    
    the element at the specified index.
    
    Throws:
    
    IndexOutOfBoundsException - if location < 0 || location >= size().
  - first
```
public E first()
```
    Gets the first object from the collection.
    
    Specified by:
    
    first in interface OrderedRealmCollection<E extends RealmModel>
    
    Returns:
    
    the first object.
  - first
```
public E first(E defaultValue)
```
    Gets the first object from the collection. If the collection is empty, the provided default will be used instead.
    
    Specified by:
    
    first in interface OrderedRealmCollection<E extends RealmModel>
    
    Returns:
    
    the first object or the provided default.
  - last
```
public E last()
```
    Gets the last object from the collection.
    
    Specified by:
    
    last in interface OrderedRealmCollection<E extends RealmModel>
    
    Returns:
    
    the last object.
  - last
```
public E last(E defaultValue)
```
    Gets the last object from the collection. If the collection is empty, the provided default will be used instead.
    
    Specified by:
    
    last in interface OrderedRealmCollection<E extends RealmModel>
    
    Returns:
    
    the last object or the provided default.
  - iterator
```
public Iterator<E> iterator()
```
    Returns an iterator for the results of a query. Any change to Realm while iterating will cause this iterator to throw a ConcurrentModificationException if accessed.
    
    Specified by:
    
    iterator in interface Iterable<E extends RealmModel>
    
    Specified by:
    
    iterator in interface Collection<E extends RealmModel>
    
    Specified by:
    
    iterator in interface List<E extends RealmModel>
    
    Overrides:
    
    iterator in class AbstractList<E extends RealmModel>
    
    Returns:
    
    an iterator on the elements of this list.
    
    See Also:
    
    Iterator
  - listIterator
```
public ListIterator<E> listIterator()
```
    Returns a list iterator for the results of a query. Any change to Realm while iterating will cause the iterator to throw a ConcurrentModificationException if accessed.
    
    Specified by:
    
    listIterator in interface List<E extends RealmModel>
    
    Overrides:
    
    listIterator in class AbstractList<E extends RealmModel>
    
    Returns:
    
    a ListIterator on the elements of this list.
    
    See Also:
    
    ListIterator
  - listIterator
```
public ListIterator<E> listIterator(int location)
```
    Returns a list iterator on the results of a query. Any change to Realm while iterating will cause the iterator to throw a ConcurrentModificationException if accessed.
    
    Specified by:
    
    listIterator in interface List<E extends RealmModel>
    
    Overrides:
    
    listIterator in class AbstractList<E extends RealmModel>
    
    Parameters:
    
    location - the index at which to start the iteration.
    
    Returns:
    
    a ListIterator on the elements of this list.
    
    Throws:
    
    IndexOutOfBoundsException - if location < 0 || location > size().
    
    See Also:
    
    ListIterator
  - min
```
public Number min(String fieldName)
```
    Finds the minimum value of a field.
    
    Specified by:
    
    min in interface RealmCollection<E extends RealmModel>
    
    Parameters:
    
    fieldName - the field to look for a minimum on. Only number fields are supported.
    
    Returns:
    
    if no objects exist or they all have null as the value for the given field, null will be returned. Otherwise the minimum value is returned. When determining the minimum value, objects with null values are ignored.
  - minDate
```
public Date minDate(String fieldName)
```
    Finds the minimum date.
    
    Specified by:
    
    minDate in interface RealmCollection<E extends RealmModel>
    
    Parameters:
    
    fieldName - the field to look for the minimum date. If fieldName is not of Date type, an exception is thrown.
    
    Returns:
    
    if no objects exist or they all have null as the value for the given date field, null will be returned. Otherwise the minimum date is returned. When determining the minimum date, objects with null values are ignored.
  - max
```
public Number max(String fieldName)
```
    Finds the maximum value of a field.
    
    Specified by:
    
    max in interface RealmCollection<E extends RealmModel>
    
    Parameters:
    
    fieldName - the field to look for a maximum on. Only number fields are supported.
    
    Returns:
    
    if no objects exist or they all have null as the value for the given field, null will be returned. Otherwise the maximum value is returned. When determining the maximum value, objects with null values are ignored.
  - maxDate
```
public Date maxDate(String fieldName)
```
    Finds the maximum date.
    
    Specified by:
    
    maxDate in interface RealmCollection<E extends RealmModel>
    
    Parameters:
    
    fieldName - the field to look for the maximum date. If fieldName is not of Date type, an exception is thrown.
    
    Returns:
    
    if no objects exist or they all have null as the value for the given date field, null will be returned. Otherwise the maximum date is returned. When determining the maximum date, objects with null values are ignored.
    
    Throws:
    
    IllegalArgumentException - if fieldName is not a Date field.
  - sum
```
public Number sum(String fieldName)
```
    Calculates the sum of a given field.
    
    Specified by:
    
    sum in interface RealmCollection<E extends RealmModel>
    
    Parameters:
    
    fieldName - the field to sum. Only number fields are supported.
    
    Returns:
    
    the sum. If no objects exist or they all have null as the value for the given field, 0 will be returned. When computing the sum, objects with null values are ignored.
  - average
```
public double average(String fieldName)
```
    Returns the average of a given field.
    
    Specified by:
    
    average in interface RealmCollection<E extends RealmModel>
    
    Parameters:
    
    fieldName - the field to calculate average on. Only number fields are supported.
    
    Returns:
    
    the average for the given field amongst objects in query results. This will be of type double for all types of number fields. If no objects exist or they all have null as the value for the given field, 0 will be returned. When computing the average, objects with null values are ignored.
  - remove
```
@Deprecated
public E remove(int index)
```
    Deprecated.
    
    Not supported by RealmResults and OrderedRealmCollectionSnapshot.
    
    Specified by:
    
    remove in interface List<E extends RealmModel>
    
    Overrides:
    
    remove in class AbstractList<E extends RealmModel>
    
    Throws:
    
    UnsupportedOperationException
  - remove
```
@Deprecated
public boolean remove(Object object)
```
    Deprecated.
    
    Not supported by RealmResults and OrderedRealmCollectionSnapshot.
    
    Specified by:
    
    remove in interface Collection<E extends RealmModel>
    
    Specified by:
    
    remove in interface List<E extends RealmModel>
    
    Overrides:
    
    remove in class AbstractCollection<E extends RealmModel>
    
    Throws:
    
    UnsupportedOperationException
  - removeAll
```
@Deprecated
public boolean removeAll(Collection<?> collection)
```
    Deprecated.
    
    Not supported by RealmResults and OrderedRealmCollectionSnapshot.
    
    Specified by:
    
    removeAll in interface Collection<E extends RealmModel>
    
    Specified by:
    
    removeAll in interface List<E extends RealmModel>
    
    Overrides:
    
    removeAll in class AbstractCollection<E extends RealmModel>
    
    Throws:
    
    UnsupportedOperationException
  - set
```
@Deprecated
public E set(int location,
                         E object)
```
    Deprecated.
    
    Not supported by RealmResults and OrderedRealmCollectionSnapshot.
    
    Specified by:
    
    set in interface List<E extends RealmModel>
    
    Overrides:
    
    set in class AbstractList<E extends RealmModel>
    
    Throws:
    
    UnsupportedOperationException
  - retainAll
```
@Deprecated
public boolean retainAll(Collection<?> collection)
```
    Deprecated.
    
    Not supported by RealmResults and OrderedRealmCollectionSnapshot.
    
    Specified by:
    
    retainAll in interface Collection<E extends RealmModel>
    
    Specified by:
    
    retainAll in interface List<E extends RealmModel>
    
    Overrides:
    
    retainAll in class AbstractCollection<E extends RealmModel>
    
    Throws:
    
    UnsupportedOperationException
  - clear
```
@Deprecated
public void clear()
```
    Deprecated.
    
    Not supported by RealmResults and OrderedRealmCollectionSnapshot.
    
    Specified by:
    
    clear in interface Collection<E extends RealmModel>
    
    Specified by:
    
    clear in interface List<E extends RealmModel>
    
    Overrides:
    
    clear in class AbstractList<E extends RealmModel>
    
    Throws:
    
    UnsupportedOperationException - always.
  - add
```
@Deprecated
public boolean add(E element)
```
    Deprecated.
    
    Not supported by RealmResults and OrderedRealmCollectionSnapshot.
    
    Specified by:
    
    add in interface Collection<E extends RealmModel>
    
    Specified by:
    
    add in interface List<E extends RealmModel>
    
    Overrides:
    
    add in class AbstractList<E extends RealmModel>
    
    Throws:
    
    UnsupportedOperationException - always.
  - add
```
@Deprecated
public void add(int index,
                            E element)
```
    Deprecated.
    
    Not supported by RealmResults and OrderedRealmCollectionSnapshot.
    
    Specified by:
    
    add in interface List<E extends RealmModel>
    
    Overrides:
    
    add in class AbstractList<E extends RealmModel>
    
    Throws:
    
    UnsupportedOperationException - always.
  - addAll
```
@Deprecated
public boolean addAll(int location,
                                  Collection<? extends E> collection)
```
    Deprecated.
    
    Not supported by RealmResults and OrderedRealmCollectionSnapshot.
    
    Specified by:
    
    addAll in interface List<E extends RealmModel>
    
    Overrides:
    
    addAll in class AbstractList<E extends RealmModel>
    
    Throws:
    
    UnsupportedOperationException - always.
  - addAll
```
@Deprecated
public boolean addAll(Collection<? extends E> collection)
```
    Deprecated.
    
    Not supported by RealmResults and OrderedRealmCollectionSnapshot.
    
    Specified by:
    
    addAll in interface Collection<E extends RealmModel>
    
    Specified by:
    
    addAll in interface List<E extends RealmModel>
    
    Overrides:
    
    addAll in class AbstractCollection<E extends RealmModel>
    
    Throws:
    
    UnsupportedOperationException - always.

Class OrderedRealmCollectionSnapshot<E extends RealmModel>

Method Summary

Methods inherited from class java.util.AbstractList

Methods inherited from class java.util.AbstractCollection

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.List

Methods inherited from interface java.util.Collection

Methods inherited from interface java.lang.Iterable

Method Detail

size

sort

sort

sort

sort

where

isLoaded

load

createSnapshot

deleteFromRealm

deleteFirstFromRealm

deleteLastFromRealm

deleteAllFromRealm

isValid

isManaged

contains

get

first

first

last

last

iterator

listIterator

listIterator

min

minDate

max

maxDate

sum

average

remove

remove

removeAll

set

retainAll

clear

add

add

addAll

addAll