io.realm

Class RealmQuery<E extends RealmModel>

java.lang.Object

io.realm.RealmQuery<E>

Type Parameters:

E - the class of the objects to be queried.

public final class RealmQuery<E extends RealmModel>
extends java.lang.Object

A RealmQuery encapsulates a query on a Realm or a RealmResults using the Builder pattern. The query is executed using either findAll() or findFirst()

The input to many of the query functions take a field name as String. Note that this is not type safe. If a RealmObject class is refactored care has to be taken to not break any queries.

A Realm is unordered, which means that there is no guarantee that querying a Realm will return the objects in the order they where inserted. Use findAllSorted(String) and similar methods if a specific order is required.

A RealmQuery cannot be passed between different threads.

See Also:

Builder pattern, Realm.where(Class), RealmResults.where()

Method Summary

Modifier and Type	Method and Description
double	average(java.lang.String fieldName) Returns the average of a given field.
RealmQuery<E>	beginGroup() Begin grouping of conditions ("left parenthesis").
RealmQuery<E>	beginsWith(java.lang.String fieldName, java.lang.String value) Condition that the value of field begins with the specified string.
RealmQuery<E>	beginsWith(java.lang.String fieldName, java.lang.String value, Case casing) Condition that the value of field begins with the specified substring.
RealmQuery<E>	between(java.lang.String fieldName, java.util.Date from, java.util.Date to) Between condition.
RealmQuery<E>	between(java.lang.String fieldName, double from, double to) Between condition.
RealmQuery<E>	between(java.lang.String fieldName, float from, float to) Between condition.
RealmQuery<E>	between(java.lang.String fieldName, int from, int to) Between condition.
RealmQuery<E>	between(java.lang.String fieldName, long from, long to) Between condition.
RealmQuery<E>	contains(java.lang.String fieldName, java.lang.String value) Condition that value of field contains the specified substring.
RealmQuery<E>	contains(java.lang.String fieldName, java.lang.String value, Case casing) Condition that value of field contains the specified substring.
long	count() Counts the number of objects that fulfill the query conditions.
static <E extends RealmModel> RealmQuery<E>	createDynamicQuery(DynamicRealm realm, java.lang.String className) Creates a query for dynamic objects of a given type from a DynamicRealm.
static <E extends RealmModel> RealmQuery<E>	createQuery(Realm realm, java.lang.Class<E> clazz) Creates a query for objects of a given class from a Realm.
static <E extends RealmModel> RealmQuery<E>	createQueryFromList(RealmList<E> list) Creates a query from a existing RealmList.
static <E extends RealmModel> RealmQuery<E>	createQueryFromResult(RealmResults<E> queryResults) Creates a query from a existing RealmResults.
RealmResults<E>	distinct(java.lang.String fieldName) Returns a distinct set of objects of a specific class.
RealmResults<E>	distinct(java.lang.String firstFieldName, java.lang.String... remainingFieldNames) Returns a distinct set of objects from a specific class.
RealmResults<E>	distinctAsync(java.lang.String fieldName) Asynchronously returns a distinct set of objects of a specific class.
RealmQuery<E>	endGroup() End grouping of conditions ("right parenthesis") which was opened by a call to beginGroup().
RealmQuery<E>	endsWith(java.lang.String fieldName, java.lang.String value) Condition that the value of field ends with the specified string.
RealmQuery<E>	endsWith(java.lang.String fieldName, java.lang.String value, Case casing) Condition that the value of field ends with the specified substring.
RealmQuery<E>	equalTo(java.lang.String fieldName, java.lang.Boolean value) Equal-to comparison.
RealmQuery<E>	equalTo(java.lang.String fieldName, java.lang.Byte value) Equal-to comparison.
RealmQuery<E>	equalTo(java.lang.String fieldName, java.util.Date value) Equal-to comparison.
RealmQuery<E>	equalTo(java.lang.String fieldName, java.lang.Double value) Equal-to comparison.
RealmQuery<E>	equalTo(java.lang.String fieldName, java.lang.Float value) Equal-to comparison.
RealmQuery<E>	equalTo(java.lang.String fieldName, java.lang.Integer value) Equal-to comparison.
RealmQuery<E>	equalTo(java.lang.String fieldName, java.lang.Long value) Equal-to comparison.
RealmQuery<E>	equalTo(java.lang.String fieldName, java.lang.Short value) Equal-to comparison.
RealmQuery<E>	equalTo(java.lang.String fieldName, java.lang.String value) Equal-to comparison.
RealmQuery<E>	equalTo(java.lang.String fieldName, java.lang.String value, Case casing) Equal-to comparison.
RealmResults<E>	findAll() Finds all objects that fulfill the query conditions.
RealmResults<E>	findAllAsync() Finds all objects that fulfill the query conditions and sorted by specific field name.
RealmResults<E>	findAllSorted(java.lang.String fieldName) Finds all objects that fulfill the query conditions and sorted by specific field name in ascending order.
RealmResults<E>	findAllSorted(java.lang.String[] fieldNames, Sort[] sortOrders) Finds all objects that fulfill the query conditions and sorted by specific field names.
RealmResults<E>	findAllSorted(java.lang.String fieldName, Sort sortOrder) Finds all objects that fulfill the query conditions and sorted by specific field name.
RealmResults<E>	findAllSorted(java.lang.String fieldName1, Sort sortOrder1, java.lang.String fieldName2, Sort sortOrder2) Finds all objects that fulfill the query conditions and sorted by specific field names in ascending order.
RealmResults<E>	findAllSorted(java.lang.String fieldName1, Sort sortOrder1, java.lang.String fieldName2, Sort sortOrder2, java.lang.String fieldName3, Sort sortOrder3) Deprecated.
RealmResults<E>	findAllSortedAsync(java.lang.String fieldName) Similar to findAllSorted(String) but runs asynchronously on a worker thread This method is only available from a Looper thread.
RealmResults<E>	findAllSortedAsync(java.lang.String[] fieldNames, Sort[] sortOrders) Similar to findAllSorted(String[], Sort[]) but runs asynchronously from a worker thread.
RealmResults<E>	findAllSortedAsync(java.lang.String fieldName, Sort sortOrder) Similar to findAllSorted(String, Sort) but runs asynchronously on a worker thread (Need a Realm opened from a looper thread to work).
RealmResults<E>	findAllSortedAsync(java.lang.String fieldName1, Sort sortOrder1, java.lang.String fieldName2, Sort sortOrder2) Similar to findAllSorted(String, Sort, String, Sort) but runs asynchronously on a worker thread This method is only available from a Looper thread.
RealmResults<E>	findAllSortedAsync(java.lang.String fieldName1, Sort sortOrder1, java.lang.String fieldName2, Sort sortOrder2, java.lang.String fieldName3, Sort sortOrder3) Deprecated.
E	findFirst() Finds the first object that fulfills the query conditions.
E	findFirstAsync() Similar to findFirst() but runs asynchronously on a worker thread This method is only available from a Looper thread.
ArgumentsHolder	getArgument()
RealmQuery<E>	greaterThan(java.lang.String fieldName, java.util.Date value) Greater-than comparison.
RealmQuery<E>	greaterThan(java.lang.String fieldName, double value) Greater-than comparison.
RealmQuery<E>	greaterThan(java.lang.String fieldName, float value) Greater-than comparison.
RealmQuery<E>	greaterThan(java.lang.String fieldName, int value) Greater-than comparison.
RealmQuery<E>	greaterThan(java.lang.String fieldName, long value) Greater-than comparison.
RealmQuery<E>	greaterThanOrEqualTo(java.lang.String fieldName, java.util.Date value) Greater-than-or-equal-to comparison.
RealmQuery<E>	greaterThanOrEqualTo(java.lang.String fieldName, double value) Greater-than-or-equal-to comparison.
RealmQuery<E>	greaterThanOrEqualTo(java.lang.String fieldName, float value) Greater-than-or-equal-to comparison.
RealmQuery<E>	greaterThanOrEqualTo(java.lang.String fieldName, int value) Greater-than-or-equal-to comparison.
RealmQuery<E>	greaterThanOrEqualTo(java.lang.String fieldName, long value) Greater-than-or-equal-to comparison.
RealmQuery<E>	isEmpty(java.lang.String fieldName) Condition that find values that are considered "empty", i.e.
RealmQuery<E>	isNotEmpty(java.lang.String fieldName) Condition that find values that are considered "Not-empty", i.e.
RealmQuery<E>	isNotNull(java.lang.String fieldName) Tests if a field is not null.
RealmQuery<E>	isNull(java.lang.String fieldName) Tests if a field is null.
boolean	isValid() Checks if RealmQuery is still valid to use i.e.
RealmQuery<E>	lessThan(java.lang.String fieldName, java.util.Date value) Less-than comparison.
RealmQuery<E>	lessThan(java.lang.String fieldName, double value) Less-than comparison.
RealmQuery<E>	lessThan(java.lang.String fieldName, float value) Less-than comparison.
RealmQuery<E>	lessThan(java.lang.String fieldName, int value) Less-than comparison.
RealmQuery<E>	lessThan(java.lang.String fieldName, long value) Less-than comparison.
RealmQuery<E>	lessThanOrEqualTo(java.lang.String fieldName, java.util.Date value) Less-than-or-equal-to comparison.
RealmQuery<E>	lessThanOrEqualTo(java.lang.String fieldName, double value) Less-than-or-equal-to comparison.
RealmQuery<E>	lessThanOrEqualTo(java.lang.String fieldName, float value) Less-than-or-equal-to comparison.
RealmQuery<E>	lessThanOrEqualTo(java.lang.String fieldName, int value) Less-than-or-equal-to comparison.
RealmQuery<E>	lessThanOrEqualTo(java.lang.String fieldName, long value) Less-than-or-equal-to comparison.
java.lang.Number	max(java.lang.String fieldName) Finds the maximum value of a field.
java.util.Date	maximumDate(java.lang.String fieldName) Finds the maximum value of a field.
java.lang.Number	min(java.lang.String fieldName) Finds the minimum value of a field.
java.util.Date	minimumDate(java.lang.String fieldName) Finds the minimum value of a field.
RealmQuery<E>	not() Negate condition.
RealmQuery<E>	notEqualTo(java.lang.String fieldName, java.lang.Boolean value) Not-equal-to comparison.
RealmQuery<E>	notEqualTo(java.lang.String fieldName, java.lang.Byte value) Not-equal-to comparison.
RealmQuery<E>	notEqualTo(java.lang.String fieldName, java.util.Date value) Not-equal-to comparison.
RealmQuery<E>	notEqualTo(java.lang.String fieldName, java.lang.Double value) Not-equal-to comparison.
RealmQuery<E>	notEqualTo(java.lang.String fieldName, java.lang.Float value) Not-equal-to comparison.
RealmQuery<E>	notEqualTo(java.lang.String fieldName, java.lang.Integer value) Not-equal-to comparison.
RealmQuery<E>	notEqualTo(java.lang.String fieldName, java.lang.Long value) Not-equal-to comparison.
RealmQuery<E>	notEqualTo(java.lang.String fieldName, java.lang.Short value) Not-equal-to comparison.
RealmQuery<E>	notEqualTo(java.lang.String fieldName, java.lang.String value) Not-equal-to comparison.
RealmQuery<E>	notEqualTo(java.lang.String fieldName, java.lang.String value, Case casing) Not-equal-to comparison.
RealmQuery<E>	or() Logical-or two conditions.
java.lang.Number	sum(java.lang.String fieldName) Calculates the sum of a given field.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

createQuery

public static <E extends RealmModel> RealmQuery<E> createQuery(Realm realm,
                                                               java.lang.Class<E> clazz)

Creates a query for objects of a given class from a Realm.

Parameters:

realm - the realm to query within.

clazz - the class to query.

Returns:

RealmQuery object. After building the query call one of the find* methods to run it.

createDynamicQuery

public static <E extends RealmModel> RealmQuery<E> createDynamicQuery(DynamicRealm realm,
                                                                      java.lang.String className)

Creates a query for dynamic objects of a given type from a DynamicRealm.

Parameters:

realm - the realm to query within.

className - the type to query.

Returns:

RealmQuery object. After building the query call one of the find* methods to run it.

createQueryFromResult

public static <E extends RealmModel> RealmQuery<E> createQueryFromResult(RealmResults<E> queryResults)

Creates a query from a existing RealmResults.

Parameters:

queryResults - a existing @{link io.realm.RealmResults} to query against.

Returns:

RealmQuery object. After building the query call one of the find* methods to run it.

createQueryFromList

public static <E extends RealmModel> RealmQuery<E> createQueryFromList(RealmList<E> list)

Creates a query from a existing RealmList.

Parameters:

list - a existing @{link io.realm.RealmList} to query against.

Returns:

RealmQuery object. After building the query call one of the find* methods to run it.

isValid

public boolean isValid()

Checks if RealmQuery is still valid to use i.e. the Realm instance hasn't been closed and any parent RealmResults is still valid.

Returns:

true if still valid to use, false otherwise.

isNull

public RealmQuery<E> isNull(java.lang.String fieldName)

Tests if a field is null. Only works for nullable fields. For link queries, if any part of the link path is null the whole path is considered to be null e.g. isNull("linkField.stringField") will be considered to be null if either linkField or linkField.stringField is null.

Parameters:

fieldName - the field name.

Returns:

the query object.

Throws:

java.lang.IllegalArgumentException - if the field is not nullable.

See Also:

for further infomation.

isNotNull

public RealmQuery<E> isNotNull(java.lang.String fieldName)

Tests if a field is not null. Only works for nullable fields.

Parameters:

fieldName - the field name.

Returns:

the query object.

Throws:

java.lang.IllegalArgumentException - if the field is not nullable.

See Also:

for further infomation.

equalTo

public RealmQuery<E> equalTo(java.lang.String fieldName,
                             java.lang.String value)

Equal-to comparison.

Parameters:

fieldName - the field to compare.

value - the value to compare with.

Returns:

the query object.

Throws:

java.lang.IllegalArgumentException - if one or more arguments do not match class or field type.

equalTo

public RealmQuery<E> equalTo(java.lang.String fieldName,
                             java.lang.String value,
                             Case casing)

Equal-to comparison.

Parameters:

fieldName - the field to compare.

value - the value to compare with.

casing - How to handle casing. Setting this to Case.INSENSITIVE only works for English locale characters.

Returns:

the query object.

Throws:

java.lang.IllegalArgumentException - if one or more arguments do not match class or field type.

equalTo

public RealmQuery<E> equalTo(java.lang.String fieldName,
                             java.lang.Byte value)

Equal-to comparison.

Parameters:

fieldName - the field to compare.

value - the value to compare with.

Returns:

the query object.

Throws:

java.lang.IllegalArgumentException - if one or more arguments do not match class or field type.

equalTo

public RealmQuery<E> equalTo(java.lang.String fieldName,
                             java.lang.Short value)

Equal-to comparison.

Parameters:

fieldName - the field to compare.

value - the value to compare with.

Returns:

the query object.

Throws:

java.lang.IllegalArgumentException - if one or more arguments do not match class or field type.

equalTo

public RealmQuery<E> equalTo(java.lang.String fieldName,
                             java.lang.Integer value)

Equal-to comparison.

Parameters:

fieldName - the field to compare.

value - the value to compare with.

Returns:

the query object.

Throws:

java.lang.IllegalArgumentException - if one or more arguments do not match class or field type.

equalTo

public RealmQuery<E> equalTo(java.lang.String fieldName,
                             java.lang.Long value)

Equal-to comparison.

Parameters:

fieldName - the field to compare.

value - the value to compare with.

Returns:

the query object.

Throws:

java.lang.IllegalArgumentException - if one or more arguments do not match class or field type.

equalTo

public RealmQuery<E> equalTo(java.lang.String fieldName,
                             java.lang.Double value)

Equal-to comparison.

Parameters:

fieldName - the field to compare.

value - the value to compare with.

Returns:

the query object.

Throws:

java.lang.IllegalArgumentException - if one or more arguments do not match class or field type.

equalTo

public RealmQuery<E> equalTo(java.lang.String fieldName,
                             java.lang.Float value)

Equal-to comparison.

Parameters:

fieldName - the field to compare.

value - the value to compare with.

Returns:

The query object.

Throws:

java.lang.IllegalArgumentException - if one or more arguments do not match class or field type.

equalTo

public RealmQuery<E> equalTo(java.lang.String fieldName,
                             java.lang.Boolean value)

Equal-to comparison.

Parameters:

fieldName - the field to compare.

value - the value to compare with.

Returns:

the query object.

Throws:

java.lang.IllegalArgumentException - if one or more arguments do not match class or field type.

equalTo

public RealmQuery<E> equalTo(java.lang.String fieldName,
                             java.util.Date value)

Equal-to comparison.

Parameters:

fieldName - the field to compare.

value - the value to compare with.

Returns:

the query object.

Throws:

java.lang.IllegalArgumentException - if one or more arguments do not match class or field type.

notEqualTo

public RealmQuery<E> notEqualTo(java.lang.String fieldName,
                                java.lang.String value)

Not-equal-to comparison.

Parameters:

fieldName - the field to compare.

value - the value to compare with.

Returns:

the query object.

Throws:

java.lang.IllegalArgumentException - if one or more arguments do not match class or field type.

notEqualTo

public RealmQuery<E> notEqualTo(java.lang.String fieldName,
                                java.lang.String value,
                                Case casing)

Not-equal-to comparison.

Parameters:

fieldName - the field to compare.

value - the value to compare with.

casing - How casing is handled. Case.INSENSITIVE works only for the English locale characters.

Returns:

the query object.

Throws:

java.lang.IllegalArgumentException - if one or more arguments do not match class or field type.

notEqualTo

public RealmQuery<E> notEqualTo(java.lang.String fieldName,
                                java.lang.Byte value)

Not-equal-to comparison.

Parameters:

fieldName - the field to compare.

value - the value to compare with.

Returns:

the query object.

Throws:

java.lang.IllegalArgumentException - if one or more arguments do not match class or field type.

notEqualTo

public RealmQuery<E> notEqualTo(java.lang.String fieldName,
                                java.lang.Short value)

Not-equal-to comparison.

Parameters:

fieldName - the field to compare.

value - the value to compare with.

Returns:

the query object.

Throws:

java.lang.IllegalArgumentException - if one or more arguments do not match class or field type.

notEqualTo

public RealmQuery<E> notEqualTo(java.lang.String fieldName,
                                java.lang.Integer value)

Not-equal-to comparison.

Parameters:

fieldName - the field to compare.

value - the value to compare with.

Returns:

the query object.

Throws:

java.lang.IllegalArgumentException - if one or more arguments do not match class or field type.

notEqualTo

public RealmQuery<E> notEqualTo(java.lang.String fieldName,
                                java.lang.Long value)

Not-equal-to comparison.

Parameters:

fieldName - the field to compare.

value - the value to compare with.

Returns:

the query object

Throws:

java.lang.IllegalArgumentException - if one or more arguments do not match class or field type.

notEqualTo

public RealmQuery<E> notEqualTo(java.lang.String fieldName,
                                java.lang.Double value)

Not-equal-to comparison.

Parameters:

fieldName - the field to compare.

value - the value to compare with.

Returns:

the query object.

Throws:

java.lang.IllegalArgumentException - if one or more arguments do not match class or field type.

notEqualTo

public RealmQuery<E> notEqualTo(java.lang.String fieldName,
                                java.lang.Float value)

Not-equal-to comparison.

Parameters:

fieldName - the field to compare.

value - the value to compare with.

Returns:

the query object.

Throws:

java.lang.IllegalArgumentException - if one or more arguments do not match class or field type.

notEqualTo

public RealmQuery<E> notEqualTo(java.lang.String fieldName,
                                java.lang.Boolean value)

Not-equal-to comparison.

Parameters:

fieldName - the field to compare.

value - the value to compare with.

Returns:

the query object.

Throws:

java.lang.IllegalArgumentException - if one or more arguments do not match class or field type.

notEqualTo

public RealmQuery<E> notEqualTo(java.lang.String fieldName,
                                java.util.Date value)

Not-equal-to comparison.

Parameters:

fieldName - the field to compare.

value - the value to compare with.

Returns:

the query object.

Throws:

java.lang.IllegalArgumentException - if one or more arguments do not match class or field type.

greaterThan

public RealmQuery<E> greaterThan(java.lang.String fieldName,
                                 int value)

Greater-than comparison.

Parameters:

fieldName - the field to compare.

value - the value to compare with.

Returns:

the query object.

Throws:

java.lang.IllegalArgumentException - if one or more arguments do not match class or field type.

greaterThan

public RealmQuery<E> greaterThan(java.lang.String fieldName,
                                 long value)

Greater-than comparison.

Parameters:

fieldName - the field to compare.

value - the value to compare with.

Returns:

the query object.

Throws:

java.lang.IllegalArgumentException - if one or more arguments do not match class or field type.

greaterThan

public RealmQuery<E> greaterThan(java.lang.String fieldName,
                                 double value)

Greater-than comparison.

Parameters:

fieldName - the field to compare.

value - the value to compare with.

Returns:

the query object.

Throws:

java.lang.IllegalArgumentException - if one or more arguments do not match class or field type.

greaterThan

public RealmQuery<E> greaterThan(java.lang.String fieldName,
                                 float value)

Greater-than comparison.

Parameters:

fieldName - the field to compare.

value - the value to compare with.

Returns:

the query object.

Throws:

java.lang.IllegalArgumentException - if one or more arguments do not match class or field type.

greaterThan

public RealmQuery<E> greaterThan(java.lang.String fieldName,
                                 java.util.Date value)

Greater-than comparison.

Parameters:

fieldName - the field to compare.

value - the value to compare with.

Returns:

the query object.

Throws:

java.lang.IllegalArgumentException - if one or more arguments do not match class or field type.

greaterThanOrEqualTo

public RealmQuery<E> greaterThanOrEqualTo(java.lang.String fieldName,
                                          int value)

Greater-than-or-equal-to comparison.

Parameters:

fieldName - the field to compare.

value - the value to compare with.

Returns:

the query object.

Throws:

java.lang.IllegalArgumentException - if one or more arguments do not match class or field type.

greaterThanOrEqualTo

public RealmQuery<E> greaterThanOrEqualTo(java.lang.String fieldName,
                                          long value)

Greater-than-or-equal-to comparison.

Parameters:

fieldName - the field to compare.

value - the value to compare with.

Returns:

the query object.

Throws:

java.lang.IllegalArgumentException - if one or more arguments do not match class or field type.

greaterThanOrEqualTo

public RealmQuery<E> greaterThanOrEqualTo(java.lang.String fieldName,
                                          double value)

Greater-than-or-equal-to comparison.

Parameters:

fieldName - the field to compare.

value - the value to compare with.

Returns:

the query object.

Throws:

java.lang.IllegalArgumentException - if one or more arguments do not match class or field type.

greaterThanOrEqualTo

public RealmQuery<E> greaterThanOrEqualTo(java.lang.String fieldName,
                                          float value)

Greater-than-or-equal-to comparison.

Parameters:

fieldName - the field to compare.

value - the value to compare with.

Returns:

the query object.

Throws:

java.lang.IllegalArgumentException - if one or more arguments do not match class or field type

greaterThanOrEqualTo

public RealmQuery<E> greaterThanOrEqualTo(java.lang.String fieldName,
                                          java.util.Date value)

Greater-than-or-equal-to comparison.

Parameters:

fieldName - the field to compare.

value - the value to compare with.

Returns:

the query object.

Throws:

java.lang.IllegalArgumentException - if one or more arguments do not match class or field type.

lessThan

public RealmQuery<E> lessThan(java.lang.String fieldName,
                              int value)

Less-than comparison.

Parameters:

fieldName - the field to compare.

value - the value to compare with.

Returns:

the query object.

Throws:

java.lang.IllegalArgumentException - if one or more arguments do not match class or field type.

lessThan

public RealmQuery<E> lessThan(java.lang.String fieldName,
                              long value)

Less-than comparison.

Parameters:

fieldName - the field to compare.

value - the value to compare with.

Returns:

the query object.

Throws:

java.lang.IllegalArgumentException - if one or more arguments do not match class or field type.

lessThan

public RealmQuery<E> lessThan(java.lang.String fieldName,
                              double value)

Less-than comparison.

Parameters:

fieldName - the field to compare.

value - the value to compare with.

Returns:

the query object.

Throws:

java.lang.IllegalArgumentException - if one or more arguments do not match class or field type.

lessThan

public RealmQuery<E> lessThan(java.lang.String fieldName,
                              float value)

Less-than comparison.

Parameters:

fieldName - the field to compare.

value - the value to compare with.

Returns:

the query object.

Throws:

java.lang.IllegalArgumentException - if one or more arguments do not match class or field type.

lessThan

public RealmQuery<E> lessThan(java.lang.String fieldName,
                              java.util.Date value)

Less-than comparison.

Parameters:

fieldName - the field to compare.

value - the value to compare with.

Returns:

the query object.

Throws:

java.lang.IllegalArgumentException - if one or more arguments do not match class or field type.

lessThanOrEqualTo

public RealmQuery<E> lessThanOrEqualTo(java.lang.String fieldName,
                                       int value)

Less-than-or-equal-to comparison.

Parameters:

fieldName - the field to compare.

value - the value to compare with.

Returns:

the query object.

Throws:

java.lang.IllegalArgumentException - if one or more arguments do not match class or field type.

lessThanOrEqualTo

public RealmQuery<E> lessThanOrEqualTo(java.lang.String fieldName,
                                       long value)

Less-than-or-equal-to comparison.

Parameters:

fieldName - the field to compare.

value - the value to compare with.

Returns:

the query object.

Throws:

java.lang.IllegalArgumentException - if one or more arguments do not match class or field type.

lessThanOrEqualTo

public RealmQuery<E> lessThanOrEqualTo(java.lang.String fieldName,
                                       double value)

Less-than-or-equal-to comparison.

Parameters:

fieldName - the field to compare.

value - the value to compare with.

Returns:

the query object.

Throws:

java.lang.IllegalArgumentException - if one or more arguments do not match class or field type.

lessThanOrEqualTo

public RealmQuery<E> lessThanOrEqualTo(java.lang.String fieldName,
                                       float value)

Less-than-or-equal-to comparison.

Parameters:

fieldName - the field to compare.

value - the value to compare with.

Returns:

the query object.

Throws:

java.lang.IllegalArgumentException - if one or more arguments do not match class or field type.

lessThanOrEqualTo

public RealmQuery<E> lessThanOrEqualTo(java.lang.String fieldName,
                                       java.util.Date value)

Less-than-or-equal-to comparison.

Parameters:

fieldName - the field to compare.

value - the value to compare with.

Returns:

the query object.

Throws:

java.lang.IllegalArgumentException - if one or more arguments do not match class or field type.

between

public RealmQuery<E> between(java.lang.String fieldName,
                             int from,
                             int to)

Between condition.

Parameters:

fieldName - the field to compare.

from - lowest value (inclusive).

to - highest value (inclusive).

Returns:

the query object.

Throws:

java.lang.IllegalArgumentException - if one or more arguments do not match class or field type.

between

public RealmQuery<E> between(java.lang.String fieldName,
                             long from,
                             long to)

Between condition.

Parameters:

fieldName - the field to compare.

from - lowest value (inclusive).

to - highest value (inclusive).

Returns:

the query object.

Throws:

java.lang.IllegalArgumentException - if one or more arguments do not match class or field type.

between

public RealmQuery<E> between(java.lang.String fieldName,
                             double from,
                             double to)

Between condition.

Parameters:

fieldName - the field to compare.

from - lowest value (inclusive).

to - highest value (inclusive).

Returns:

the query object.

Throws:

java.lang.IllegalArgumentException - if one or more arguments do not match class or field type.

between

public RealmQuery<E> between(java.lang.String fieldName,
                             float from,
                             float to)

Between condition.

Parameters:

fieldName - the field to compare.

from - lowest value (inclusive).

to - highest value (inclusive).

Returns:

the query object.

Throws:

java.lang.IllegalArgumentException - if one or more arguments do not match class or field type.

between

public RealmQuery<E> between(java.lang.String fieldName,
                             java.util.Date from,
                             java.util.Date to)

Between condition.

Parameters:

fieldName - the field to compare.

from - lowest value (inclusive).

to - highest value (inclusive).

Returns:

the query object.

Throws:

java.lang.IllegalArgumentException - if one or more arguments do not match class or field type.

contains

public RealmQuery<E> contains(java.lang.String fieldName,
                              java.lang.String value)

Condition that value of field contains the specified substring.

Parameters:

fieldName - the field to compare.

value - the substring.

Returns:

the query object.

Throws:

java.lang.IllegalArgumentException - if one or more arguments do not match class or field type.

contains

public RealmQuery<E> contains(java.lang.String fieldName,
                              java.lang.String value,
                              Case casing)

Condition that value of field contains the specified substring.

Parameters:

fieldName - the field to compare.

value - the substring.

casing - How to handle casing. Setting this to Case.INSENSITIVE only works for English locale characters.

Returns:

The query object.

Throws:

java.lang.IllegalArgumentException - if one or more arguments do not match class or field type.

beginsWith

public RealmQuery<E> beginsWith(java.lang.String fieldName,
                                java.lang.String value)

Condition that the value of field begins with the specified string.

Parameters:

fieldName - the field to compare.

value - the string.

Returns:

the query object.

Throws:

java.lang.IllegalArgumentException - if one or more arguments do not match class or field type.

beginsWith

public RealmQuery<E> beginsWith(java.lang.String fieldName,
                                java.lang.String value,
                                Case casing)

Condition that the value of field begins with the specified substring.

Parameters:

fieldName - the field to compare.

value - the substring.

casing - How to handle casing. Setting this to Case.INSENSITIVE only works for English locale characters.

Returns:

the query object

Throws:

java.lang.IllegalArgumentException - if one or more arguments do not match class or field type.

endsWith

public RealmQuery<E> endsWith(java.lang.String fieldName,
                              java.lang.String value)

Condition that the value of field ends with the specified string.

Parameters:

fieldName - the field to compare.

value - the string.

Returns:

the query object.

Throws:

java.lang.IllegalArgumentException - if one or more arguments do not match class or field type.

endsWith

public RealmQuery<E> endsWith(java.lang.String fieldName,
                              java.lang.String value,
                              Case casing)

Condition that the value of field ends with the specified substring.

Parameters:

fieldName - the field to compare.

value - the substring.

casing - How to handle casing. Setting this to Case.INSENSITIVE only works for English locale characters.

Returns:

the query object.

Throws:

java.lang.IllegalArgumentException - One or more arguments do not match class or field type.

beginGroup

public RealmQuery<E> beginGroup()

Begin grouping of conditions ("left parenthesis"). A group must be closed with a call to endGroup().

Returns:

the query object.

See Also:

endGroup()

endGroup

public RealmQuery<E> endGroup()

End grouping of conditions ("right parenthesis") which was opened by a call to beginGroup().

Returns:

the query object.

See Also:

beginGroup()

or

public RealmQuery<E> or()

Logical-or two conditions.

Returns:

the query object.

not

public RealmQuery<E> not()

Negate condition.

Returns:

the query object.

isEmpty

public RealmQuery<E> isEmpty(java.lang.String fieldName)

Condition that find values that are considered "empty", i.e. an empty list, the 0-length string or byte array.

Parameters:

fieldName - the field to compare.

Returns:

the query object.

Throws:

java.lang.IllegalArgumentException - if the field name isn't valid or its type isn't either a RealmList, String or byte array.

isNotEmpty

public RealmQuery<E> isNotEmpty(java.lang.String fieldName)

Condition that find values that are considered "Not-empty", i.e. a list, a string or a byte array with not-empty values.

Parameters:

fieldName - the field to compare.

Returns:

the query object.

Throws:

java.lang.IllegalArgumentException - if the field name isn't valid or its type isn't either a RealmList, String or byte array.

distinct

public RealmResults<E> distinct(java.lang.String fieldName)

Returns a distinct set of objects of a specific class. If the result is sorted, the first object will be returned in case of multiple occurrences, otherwise it is undefined which object is returned.

Parameters:

fieldName - the field name.

Returns:

a non-null RealmResults containing the distinct objects.

Throws:

java.lang.IllegalArgumentException - if a field is null, does not exist, is an unsupported type, is not indexed, or points to linked fields.

distinctAsync

public RealmResults<E> distinctAsync(java.lang.String fieldName)

Asynchronously returns a distinct set of objects of a specific class. If the result is sorted, the first object will be returned in case of multiple occurrences, otherwise it is undefined which object is returned.

Parameters:

fieldName - the field name.

Returns:

immediately a RealmResults. Users need to register a listener RealmResults.addChangeListener(RealmChangeListener) to be notified when the query completes.

Throws:

java.lang.IllegalArgumentException - if a field is null, does not exist, is an unsupported type, is not indexed, or points to linked fields.

distinct

public RealmResults<E> distinct(java.lang.String firstFieldName,
                                java.lang.String... remainingFieldNames)

Returns a distinct set of objects from a specific class. When multiple distinct fields are given, all unique combinations of values in the fields will be returned. In case of multiple matches, it is undefined which object is returned. Unless the result is sorted, then the first object will be returned.

Parameters:

firstFieldName - first field name to use when finding distinct objects.

remainingFieldNames - remaining field names when determining all unique combinations of field values.

Returns:

a non-null RealmResults containing the distinct objects.

Throws:

java.lang.IllegalArgumentException - if field names is empty or null, does not exist, is an unsupported type, or points to a linked field.

sum

public java.lang.Number sum(java.lang.String fieldName)

Calculates the sum of a given field.

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.

Throws:

java.lang.IllegalArgumentException - if the field is not a number type.

average

public double average(java.lang.String fieldName)

Returns the average of a given field.

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.

Throws:

java.lang.IllegalArgumentException - if the field is not a number type.

min

public java.lang.Number min(java.lang.String fieldName)

Finds the minimum value of a field.

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.

Throws:

java.lang.IllegalArgumentException - if the field is not a number type.

minimumDate

public java.util.Date minimumDate(java.lang.String fieldName)

Finds the minimum value of a field.

Parameters:

fieldName - the field name

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.

Throws:

java.lang.UnsupportedOperationException - if the query is not valid ("syntax error").

max

public java.lang.Number max(java.lang.String fieldName)

Finds the maximum value of a field.

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.

Throws:

java.lang.IllegalArgumentException - if the field is not a number type.

maximumDate

public java.util.Date maximumDate(java.lang.String fieldName)

Finds the maximum value of a field.

Parameters:

fieldName - the field name.

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:

java.lang.UnsupportedOperationException - if the query is not valid ("syntax error").

count

public long count()

Counts the number of objects that fulfill the query conditions.

Returns:

the number of matching objects.

Throws:

java.lang.UnsupportedOperationException - if the query is not valid ("syntax error").

findAll

public RealmResults<E> findAll()

Finds all objects that fulfill the query conditions.

Returns:

a RealmResults containing objects. If no objects match the condition, a list with zero objects is returned.

See Also:

RealmResults

findAllAsync

public RealmResults<E> findAllAsync()

Finds all objects that fulfill the query conditions and sorted by specific field name. This method is only available from a Looper thread.

Returns:

immediately an empty RealmResults. Users need to register a listener RealmResults.addChangeListener(RealmChangeListener) to be notified when the query completes.

See Also:

RealmResults

findAllSorted

public RealmResults<E> findAllSorted(java.lang.String fieldName,
                                     Sort sortOrder)

Finds all objects that fulfill the query conditions and sorted by specific field name.

Sorting is currently limited to character sets in 'Latin Basic', 'Latin Supplement', 'Latin Extended A', 'Latin Extended B' (UTF-8 range 0-591). For other character sets, sorting will have no effect.

Parameters:

fieldName - the field name to sort by.

sortOrder - how to sort the results.

Returns:

a RealmResults containing objects. If no objects match the condition, a list with zero objects is returned.

Throws:

java.lang.IllegalArgumentException - if field name does not exist or it belongs to a child RealmObject or a child RealmList.

findAllSortedAsync

public RealmResults<E> findAllSortedAsync(java.lang.String fieldName,
                                          Sort sortOrder)

Similar to findAllSorted(String, Sort) but runs asynchronously on a worker thread (Need a Realm opened from a looper thread to work).

Returns:

immediately an empty RealmResults. Users need to register a listener RealmResults.addChangeListener(RealmChangeListener) to be notified when the query completes.

Throws:

java.lang.IllegalArgumentException - if field name does not exist or it belongs to a child RealmObject or a child RealmList.

findAllSorted

public RealmResults<E> findAllSorted(java.lang.String fieldName)

Finds all objects that fulfill the query conditions and sorted by specific field name in ascending order. Sorting is currently limited to character sets in 'Latin Basic', 'Latin Supplement', 'Latin Extended A', 'Latin Extended B' (UTF-8 range 0-591). For other character sets, sorting will have no effect.

Parameters:

fieldName - the field name to sort by.

Returns:

a RealmResults containing objects. If no objects match the condition, a list with zero objects is returned.

Throws:

java.lang.IllegalArgumentException - if field name does not exist.

findAllSortedAsync

public RealmResults<E> findAllSortedAsync(java.lang.String fieldName)

Similar to findAllSorted(String) but runs asynchronously on a worker thread This method is only available from a Looper thread.

Returns:

immediately an empty RealmResults. Users need to register a listener RealmResults.addChangeListener(RealmChangeListener) to be notified when the query completes.

Throws:

java.lang.IllegalArgumentException - if field name does not exist.

findAllSorted

public RealmResults<E> findAllSorted(java.lang.String[] fieldNames,
                                     Sort[] sortOrders)

Finds all objects that fulfill the query conditions and sorted by specific field names.

Sorting is currently limited to character sets in 'Latin Basic', 'Latin Supplement', 'Latin Extended A', 'Latin Extended B' (UTF-8 range 0-591). For other character sets, sorting will have no effect.

Parameters:

fieldNames - an array of field names to sort by.

sortOrders - how to sort the field names.

Returns:

a RealmResults containing objects. If no objects match the condition, a list with zero objects is returned.

Throws:

java.lang.IllegalArgumentException - if one of the field names does not exist or it belongs to a child RealmObject or a child RealmList.

findAllSortedAsync

public RealmResults<E> findAllSortedAsync(java.lang.String[] fieldNames,
                                          Sort[] sortOrders)

Similar to findAllSorted(String[], Sort[]) but runs asynchronously from a worker thread. This method is only available from a Looper thread.

Returns:

immediately an empty RealmResults. Users need to register a listener RealmResults.addChangeListener(RealmChangeListener) to be notified when the query completes.

Throws:

java.lang.IllegalArgumentException - if one of the field names does not exist or it belongs to a child RealmObject or a child RealmList.

See Also:

RealmResults

findAllSorted

public RealmResults<E> findAllSorted(java.lang.String fieldName1,
                                     Sort sortOrder1,
                                     java.lang.String fieldName2,
                                     Sort sortOrder2)

Finds all objects that fulfill the query conditions and sorted by specific field names in ascending order. Sorting is currently limited to character sets in 'Latin Basic', 'Latin Supplement', 'Latin Extended A', 'Latin Extended B' (UTF-8 range 0-591). For other character sets, sorting will have no effect.

Parameters:

fieldName1 - first field name

sortOrder1 - sort order for first field

fieldName2 - second field name

sortOrder2 - sort order for second field

Returns:

a RealmResults containing objects. If no objects match the condition, a list with zero objects is returned.

Throws:

java.lang.IllegalArgumentException - if a field name does not exist.

findAllSortedAsync

public RealmResults<E> findAllSortedAsync(java.lang.String fieldName1,
                                          Sort sortOrder1,
                                          java.lang.String fieldName2,
                                          Sort sortOrder2)

Similar to findAllSorted(String, Sort, String, Sort) but runs asynchronously on a worker thread This method is only available from a Looper thread.

Returns:

immediately an empty RealmResults. Users need to register a listener RealmResults.addChangeListener(RealmChangeListener) to be notified when the query completes.

Throws:

java.lang.IllegalArgumentException - if a field name does not exist.

findAllSorted

@Deprecated
public RealmResults<E> findAllSorted(java.lang.String fieldName1,
                                                 Sort sortOrder1,
                                                 java.lang.String fieldName2,
                                                 Sort sortOrder2,
                                                 java.lang.String fieldName3,
                                                 Sort sortOrder3)

Deprecated.

DEPRECATED: Use findAllSorted(String[], Sort[]) instead.

findAllSortedAsync

@Deprecated
public RealmResults<E> findAllSortedAsync(java.lang.String fieldName1,
                                                      Sort sortOrder1,
                                                      java.lang.String fieldName2,
                                                      Sort sortOrder2,
                                                      java.lang.String fieldName3,
                                                      Sort sortOrder3)

Deprecated.

DEPRECATED: Use findAllSortedAsync(String[], Sort[]) instead.

findFirst

public E findFirst()

Finds the first object that fulfills the query conditions.

Returns:

the object found or null if no object matches the query conditions.

See Also:

RealmObject

findFirstAsync

public E findFirstAsync()

Similar to findFirst() but runs asynchronously on a worker thread This method is only available from a Looper thread.

Returns:

immediately an empty RealmObject. Trying to access any field on the returned object before it is loaded will throw an IllegalStateException. Use RealmObject.isLoaded() to check if the object is fully loaded or register a listener RealmObject.addChangeListener(io.realm.RealmChangeListener<E>) to be notified when the query completes. If no RealmObject was found after the query completed, the returned RealmObject will have RealmObject.isLoaded() set to true and RealmObject.isValid() set to false.

getArgument

public ArgumentsHolder getArgument()