RealmResults (Realm 5.6.0)

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

Type Parameters:

E - The class of objects in this list.

All Implemented Interfaces:

OrderedRealmCollection<E>, RealmCollection<E>, Iterable<E>, Collection<E>, List<E>
```
public class RealmResults<E>
extends AbstractList<E>
```
This class holds all the matches of a RealmQuery for a given Realm. The objects are not copied from the Realm to the RealmResults list, but are just referenced from the RealmResult instead. This saves memory and increases speed.
RealmResults are live views, which means that if it is on an Looper thread, it will automatically update its query results after a transaction has been committed. If on a non-looper thread, BaseRealm.waitForChange() must be called to update the results.
Updates to RealmObjects from a RealmResults list must be done from within a transaction and the modified objects are persisted to the Realm file during the commit of the transaction.
A RealmResults object cannot be passed between different threads.
Notice that a RealmResults is never null not even in the case where it contains no objects. You should always use the OrderedRealmCollectionImpl.size() method to check if a RealmResults is empty or not.
If a RealmResults is built on RealmList through RealmList.where(), it will become empty when the source RealmList gets deleted.
RealmResults can contain more elements than Integer.MAX_VALUE. In that case, you can access only first Integer.MAX_VALUE elements in it.

See Also:

RealmQuery.findAll(), Realm.executeTransaction(Realm.Transaction)

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.
`void`	`addChangeListener(OrderedRealmCollectionChangeListener<RealmResults<E>> listener)` Adds a change listener to this `RealmResults`.
`void`	`addChangeListener(RealmChangeListener<RealmResults<E>> listener)` Adds a change listener to this `RealmResults`.
`<any>`	`asChangesetObservable()` Returns an Rx Observable that monitors changes to this RealmResults.
`<any>`	`asFlowable()` Returns an Rx Flowable that monitors changes to this RealmResults.
`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 as well as from the collection.
`boolean`	`deleteFirstFromRealm()` Removes the first object in the list.
`void`	`deleteFromRealm(int location)` Deletes the object at the given index from the Realm.
`boolean`	`deleteLastFromRealm()` Removes the last object in the list.
`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.
`Realm`	`getRealm()` Returns the `Realm` instance to which this collection belongs.
`boolean`	`isLoaded()` Returns `false` if the results are not yet loaded, `true` if they are loaded.
`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()` Makes an asynchronous query blocking.
`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.
`void`	`removeAllChangeListeners()` Removes all user-defined change listeners.
`void`	`removeChangeListener(OrderedRealmCollectionChangeListener<RealmResults<E>> listener)` Removes the specified change listener.
`void`	`removeChangeListener(RealmChangeListener<RealmResults<E>> listener)` Removes the specified change listener.
`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)` Sorts a collection based on the provided field in ascending order.
`RealmResults<E>`	`sort(String[] fieldNames, Sort[] sortOrders)` Sorts a collection based on the provided fields and sort orders.
`RealmResults<E>`	`sort(String fieldName, Sort sortOrder)` Sorts a collection based on the provided field and sort order.
`RealmResults<E>`	`sort(String fieldName1, Sort sortOrder1, String fieldName2, Sort sortOrder2)` Sorts a collection based on the provided fields and sort orders.
`Number`	`sum(String fieldName)` Calculates the sum of a given field.
`RealmQuery<E>`	`where()` Returns a `RealmQuery`, which can be used to query for specific objects from this collection.

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
  - where
```
public RealmQuery<E> where()
```
    Returns a RealmQuery, which can be used to query for specific objects from this collection.
    
    Returns:
    
    a RealmQuery object.
    
    See Also:
    
    RealmQuery
  - sort
```
public RealmResults<E> sort(String fieldName1,
                            Sort sortOrder1,
                            String fieldName2,
                            Sort sortOrder2)
```
    Sorts a collection based on the provided fields and sort orders.
    
    Specified by:
    
    sort in interface OrderedRealmCollection<E>
    
    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.
  - isLoaded
```
public boolean isLoaded()
```
    Returns false if the results are not yet loaded, true if they are loaded.
    
    Returns:
    
    true if the query has completed and the data is available, false if the query is still running in the background.
  - load
```
public boolean load()
```
    Makes an asynchronous query blocking. This will also trigger any registered RealmChangeListener when the query completes.
    
    Returns:
    
    true if it successfully completed the query, false otherwise.
  - addChangeListener
```
public void addChangeListener(RealmChangeListener<RealmResults<E>> listener)
```
    Adds a change listener to this RealmResults.
    Registering a change listener will not prevent the underlying RealmResults from being garbage collected. If the RealmResults is garbage collected, the change listener will stop being triggered. To avoid this, keep a strong reference for as long as appropriate e.g. in a class variable.
```
 
 public class MyActivity extends Activity {

     private RealmResults<Person> results; // Strong reference to keep listeners alive

     \@Override
     protected void onCreate(Bundle savedInstanceState) {
       super.onCreate(savedInstanceState);
       results = realm.where(Person.class).findAllAsync();
       results.addChangeListener(new RealmChangeListener<RealmResults<Person>>() {
           \@Override
           public void onChange(RealmResults<Person> persons) {
               // React to change
           }
       });
     }
 }
 
 
```
    Parameters:
    
    listener - the change listener to be notified.
    
    Throws:
    
    IllegalArgumentException - if the change listener is null.
    
    IllegalStateException - if you try to add a listener from a non-Looper or IntentService thread.
  - addChangeListener
```
public void addChangeListener(OrderedRealmCollectionChangeListener<RealmResults<E>> listener)
```
    Adds a change listener to this RealmResults.
    Registering a change listener will not prevent the underlying RealmResults from being garbage collected. If the RealmResults is garbage collected, the change listener will stop being triggered. To avoid this, keep a strong reference for as long as appropriate e.g. in a class variable.
```
 
 public class MyActivity extends Activity {

     private RealmResults<Person> results; // Strong reference to keep listeners alive

     \@Override
     protected void onCreate(Bundle savedInstanceState) {
       super.onCreate(savedInstanceState);
       results = realm.where(Person.class).findAllAsync();
       results.addChangeListener(new OrderedRealmCollectionChangeListener<RealmResults<Person>>() {
           \@Override
           public void onChange(RealmResults<Person> persons, OrderedCollectionChangeSet changeSet) {
               // React to change
           }
       });
     }
 }
 
 
```
    Parameters:
    
    listener - the change listener to be notified.
    
    Throws:
    
    IllegalArgumentException - if the change listener is null.
    
    IllegalStateException - if you try to add a listener from a non-Looper or IntentService thread.
  - removeAllChangeListeners
```
public void removeAllChangeListeners()
```
    Removes all user-defined change listeners.
    
    Throws:
    
    IllegalStateException - if you try to remove listeners from a non-Looper Thread.
    
    See Also:
    
    RealmChangeListener
  - removeChangeListener
```
public void removeChangeListener(RealmChangeListener<RealmResults<E>> listener)
```
    Removes the specified change listener.
    
    Parameters:
    
    listener - the change listener to be removed.
    
    Throws:
    
    IllegalArgumentException - if the change listener is null.
    
    IllegalStateException - if you try to remove a listener from a non-Looper Thread.
    
    See Also:
    
    RealmChangeListener
  - removeChangeListener
```
public void removeChangeListener(OrderedRealmCollectionChangeListener<RealmResults<E>> listener)
```
    Removes the specified change listener.
    
    Parameters:
    
    listener - the change listener to be removed.
    
    Throws:
    
    IllegalArgumentException - if the change listener is null.
    
    IllegalStateException - if you try to remove a listener from a non-Looper Thread.
    
    See Also:
    
    RealmChangeListener
  - asFlowable
```
public <any> asFlowable()
```
    Returns an Rx Flowable that monitors changes to this RealmResults. It will emit the current RealmResults when subscribed to. RealmResults will continually be emitted as the RealmResults are updated - onComplete will never be called.
    If you would like the asFlowable() to stop emitting items you can instruct RxJava to only emit only the first item by using the first() operator:
```
 
 realm.where(Foo.class).findAllAsync().asFlowable()
      .filter(results -> results.isLoaded())
      .first()
      .subscribe( ... ) // You only get the results once
 
 
```
    Note that when the Realm is accessed from threads other than where it was created, IllegalStateException will be thrown. Care should be taken when using different schedulers with subscribeOn() and observeOn(). Consider using Realm.where().find*Async() instead.
    Returns:
    
    RxJava Observable that only calls onNext. It will never call onComplete or OnError.
    
    Throws:
    
    UnsupportedOperationException - if the required RxJava framework is not on the classpath or the corresponding Realm instance doesn't support RxJava.
    
    See Also:
    
    RxJava and Realm
  - asChangesetObservable
```
public <any> asChangesetObservable()
```
    Returns an Rx Observable that monitors changes to this RealmResults. It will emit the current RealmResults when subscribed. For each update to the RealmResult a pair consisting of the RealmResults and the OrderedCollectionChangeSet will be sent. The changeset will be null the first time an RealmResults is emitted.
    RealmResults will continually be emitted as the RealmResults are updated - onComplete will never be called.
    Note that when the Realm is accessed from threads other than where it was created, IllegalStateException will be thrown. Care should be taken when using different schedulers with subscribeOn() and observeOn(). Consider using Realm.where().find*Async() instead.
    
    Returns:
    
    RxJava Observable that only calls onNext. It will never call onComplete or OnError.
    
    Throws:
    
    UnsupportedOperationException - if the required RxJava framework is not on the classpath or the corresponding Realm instance doesn't support RxJava.
    
    See Also:
    
    RxJava and Realm
  - 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>
    
    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>
    
    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>
    
    Specified by:
    
    contains in interface Collection<E>
    
    Specified by:
    
    contains in interface List<E>
    
    Overrides:
    
    contains in class AbstractCollection<E>
    
    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>
    
    Specified by:
    
    get in class AbstractList<E>
    
    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>
    
    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>
    
    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>
    
    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>
    
    Returns:
    
    the last object or the provided default.
  - deleteFromRealm
```
public void deleteFromRealm(int location)
```
    Deletes the object at the given index from the Realm. This also removes it from the collection.
    
    Specified by:
    
    deleteFromRealm in interface OrderedRealmCollection<E>
    
    Parameters:
    
    location - the array index identifying the object to be removed.
  - deleteAllFromRealm
```
public boolean deleteAllFromRealm()
```
    This deletes all objects in the collection from the underlying Realm as well as from the collection.
    
    Specified by:
    
    deleteAllFromRealm in interface RealmCollection<E>
    
    Returns:
    
    true if objects was deleted, false otherwise.
  - 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>
    
    Specified by:
    
    iterator in interface Collection<E>
    
    Specified by:
    
    iterator in interface List<E>
    
    Overrides:
    
    iterator in class AbstractList<E>
    
    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>
    
    Overrides:
    
    listIterator in class AbstractList<E>
    
    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>
    
    Overrides:
    
    listIterator in class AbstractList<E>
    
    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
  - sort
```
public RealmResults<E> sort(String fieldName)
```
    Sorts a collection based on the provided field in ascending order.
    
    Specified by:
    
    sort in interface OrderedRealmCollection<E>
    
    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.
  - sort
```
public RealmResults<E> sort(String fieldName,
                            Sort sortOrder)
```
    Sorts a collection based on the provided field and sort order.
    
    Specified by:
    
    sort in interface OrderedRealmCollection<E>
    
    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.
  - sort
```
public RealmResults<E> sort(String[] fieldNames,
                            Sort[] sortOrders)
```
    Sorts a collection based on the provided fields and sort orders.
    
    Specified by:
    
    sort in interface OrderedRealmCollection<E>
    
    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.
  - size
```
public int size()
```
    Returns the number of elements in this query result.
    
    Specified by:
    
    size in interface Collection<E>
    
    Specified by:
    
    size in interface List<E>
    
    Specified by:
    
    size in class AbstractCollection<E>
    
    Returns:
    
    the number of elements in this query result.
  - min
```
public Number min(String fieldName)
```
    Finds the minimum value of a field.
    
    Specified by:
    
    min in interface RealmCollection<E>
    
    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>
    
    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>
    
    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>
    
    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>
    
    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>
    
    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>
    
    Overrides:
    
    remove in class AbstractList<E>
    
    Throws:
    
    UnsupportedOperationException
  - remove
```
@Deprecated
public boolean remove(Object object)
```
    Deprecated.
    
    Not supported by RealmResults and OrderedRealmCollectionSnapshot.
    
    Specified by:
    
    remove in interface Collection<E>
    
    Specified by:
    
    remove in interface List<E>
    
    Overrides:
    
    remove in class AbstractCollection<E>
    
    Throws:
    
    UnsupportedOperationException
  - removeAll
```
@Deprecated
public boolean removeAll(Collection<?> collection)
```
    Deprecated.
    
    Not supported by RealmResults and OrderedRealmCollectionSnapshot.
    
    Specified by:
    
    removeAll in interface Collection<E>
    
    Specified by:
    
    removeAll in interface List<E>
    
    Overrides:
    
    removeAll in class AbstractCollection<E>
    
    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>
    
    Overrides:
    
    set in class AbstractList<E>
    
    Throws:
    
    UnsupportedOperationException
  - retainAll
```
@Deprecated
public boolean retainAll(Collection<?> collection)
```
    Deprecated.
    
    Not supported by RealmResults and OrderedRealmCollectionSnapshot.
    
    Specified by:
    
    retainAll in interface Collection<E>
    
    Specified by:
    
    retainAll in interface List<E>
    
    Overrides:
    
    retainAll in class AbstractCollection<E>
    
    Throws:
    
    UnsupportedOperationException
  - deleteLastFromRealm
```
public boolean deleteLastFromRealm()
```
    Removes the last object in the list. This also deletes the object from the underlying Realm.
    
    Specified by:
    
    deleteLastFromRealm in interface OrderedRealmCollection<E>
    
    Returns:
    
    true if an object was deleted, false otherwise.
    
    Throws:
    
    IllegalStateException - if the corresponding Realm is closed or in an incorrect thread.
  - deleteFirstFromRealm
```
public boolean deleteFirstFromRealm()
```
    Removes the first object in the list. This also deletes the object from the underlying Realm.
    
    Specified by:
    
    deleteFirstFromRealm in interface OrderedRealmCollection<E>
    
    Returns:
    
    true if an object was deleted, false otherwise.
    
    Throws:
    
    IllegalStateException - if the corresponding Realm is closed or in an incorrect thread.
  - clear
```
@Deprecated
public void clear()
```
    Deprecated.
    
    Not supported by RealmResults and OrderedRealmCollectionSnapshot.
    
    Specified by:
    
    clear in interface Collection<E>
    
    Specified by:
    
    clear in interface List<E>
    
    Overrides:
    
    clear in class AbstractList<E>
    
    Throws:
    
    UnsupportedOperationException - always.
  - add
```
@Deprecated
public boolean add(E element)
```
    Deprecated.
    
    Not supported by RealmResults and OrderedRealmCollectionSnapshot.
    
    Specified by:
    
    add in interface Collection<E>
    
    Specified by:
    
    add in interface List<E>
    
    Overrides:
    
    add in class AbstractList<E>
    
    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>
    
    Overrides:
    
    add in class AbstractList<E>
    
    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>
    
    Overrides:
    
    addAll in class AbstractList<E>
    
    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>
    
    Specified by:
    
    addAll in interface List<E>
    
    Overrides:
    
    addAll in class AbstractCollection<E>
    
    Throws:
    
    UnsupportedOperationException - always.
  - createSnapshot
```
public OrderedRealmCollectionSnapshot<E> createSnapshot()
```
    Description copied from interface: OrderedRealmCollection
    
    Creates a snapshot from this OrderedRealmCollection.
    
    Specified by:
    
    createSnapshot in interface OrderedRealmCollection<E>
    
    Returns:
    
    the snapshot of this collection.
    
    See Also:
    
    OrderedRealmCollectionSnapshot
  - getRealm
```
public Realm getRealm()
```
    Returns the Realm instance to which this collection belongs.
    Calling BaseRealm.close() on the returned instance is discouraged as it is the same as calling it on the original Realm instance which may cause the Realm to fully close invalidating the query result.
    
    Returns:
    
    Realm instance this collection belongs to.
    
    Throws:
    
    IllegalStateException - if the Realm is an instance of DynamicRealm or the Realm was already closed.

Class RealmResults<E>

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

where

sort

isLoaded

load

addChangeListener

addChangeListener

removeAllChangeListeners

removeChangeListener

removeChangeListener

asFlowable

asChangesetObservable

isValid

isManaged

contains

get

first

first

last

last

deleteFromRealm

deleteAllFromRealm

iterator

listIterator

listIterator

sort

sort

sort

size

min

minDate

max

maxDate

sum

average

remove

remove

removeAll

set

retainAll

deleteLastFromRealm

deleteFirstFromRealm

clear

add

add

addAll

addAll

createSnapshot

getRealm