io.realm

Interface OrderedRealmCollection<E extends RealmModel>

All Superinterfaces:

Collection<E>, Iterable<E>, List<E>, RealmCollection<E>

All Known Implementing Classes:

RealmList, RealmResults

public interface OrderedRealmCollection<E extends RealmModel>
extends List<E>, RealmCollection<E>

An OrderedRealmCollection is a collection which maintains an ordering for its elements. Every element in the OrderedRealmCollection has an index. Each element can thus be accessed by its index, with the first index being zero. Normally, OrderedRealmCollections allow duplicate elements, as compared to Sets, where elements have to be unique.

Method Summary

Modifier and Type	Method and Description
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	last() Gets the last object from the collection.
E	last(E defaultValue) Gets the last object from the collection.
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.

Methods inherited from interface java.util.List

add, add, addAll, addAll, clear, contains, containsAll, equals, get, hashCode, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, replaceAll, retainAll, set, size, sort, spliterator, subList, toArray, toArray

Methods inherited from interface io.realm.RealmCollection

average, contains, deleteAllFromRealm, isLoaded, isManaged, isValid, load, max, maxDate, min, minDate, sum, where

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

Method Detail

first

E first()

Gets the first object from the collection.

Returns:

the first object.

Throws:

IndexOutOfBoundsException - if the collection is empty.

first

E first(E defaultValue)

Gets the first object from the collection. If the collection is empty, the provided default will be used instead.

Returns:

the first object or the provided default.

last

E last()

Gets the last object from the collection.

Returns:

the last object.

Throws:

IndexOutOfBoundsException - if the collection is empty.

last

E last(E defaultValue)

Gets the last object from the collection. If the collection is empty, the provided default will be used instead.

Returns:

the last object or the provided default.

sort

RealmResults<E> sort(String fieldName)

Sorts a collection based on the provided field in ascending order.

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:

IllegalArgumentException - if field name does not exist or it has an invalid type.

IllegalStateException - if the Realm is closed, called on the wrong thread or the collection is an unmanaged collection.

sort

RealmResults<E> sort(String fieldName,
                     Sort sortOrder)

Sorts a collection based on the provided field and sort order.

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:

IllegalArgumentException - if field name does not exist or has an invalid type.

IllegalStateException - if the Realm is closed, called on the wrong thread or the collection is an unmanaged collection.

sort

RealmResults<E> sort(String fieldName1,
                     Sort sortOrder1,
                     String fieldName2,
                     Sort sortOrder2)

Sorts a collection based on the provided fields and sort orders.

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:

IllegalArgumentException - if a field name does not exist or has an invalid type.

IllegalStateException - if the Realm is closed, called on the wrong thread or the collection is an unmanaged collection.

sort

RealmResults<E> sort(String[] fieldNames,
                     Sort[] sortOrders)

Sorts a collection based on the provided fields and sort orders.

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:

IllegalArgumentException - if a field name does not exist or has an invalid type.

IllegalStateException - if the Realm is closed, called on the wrong thread or the collection is an unmanaged collection.

deleteFromRealm

void deleteFromRealm(int location)

Deletes the object at the given index from the Realm. This also removes it from the collection.

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.

UnsupportedOperationException - if the collection is unmanaged.

deleteFirstFromRealm

boolean deleteFirstFromRealm()

Deletes the first object from the Realm. This also removes it from this collection.

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.

UnsupportedOperationException - if the collection is unmanaged.

deleteLastFromRealm

boolean deleteLastFromRealm()

Deletes the last object from the Realm. This also removes it from this collection.

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.

UnsupportedOperationException - if the collection is unmanaged.