diff --git a/.yokedox.json b/.yokedox.json new file mode 100644 index 0000000000..98a91164c1 --- /dev/null +++ b/.yokedox.json @@ -0,0 +1,21 @@ +{ + "externalEntityPatterns": [ + { + "from": "^java\\.", + "toPrefix": "https://docs.oracle.com/javase/7/docs/api/", + "toSuffix": ".html" + }, + { + "from": "^io\\.reactivex\\.", + "toPrefix": "http://reactivex.io/RxJava/javadoc/" + }, + { + "from": "^android\\.", + "toPrefix": "https://developer.android.com/reference/" + }, + { + "from": "^org\\.bson\\.", + "toPrefix": "https://www.javadoc.io/doc/org.mongodb/bson/3.12.1/" + } + ] +} diff --git a/source/sdk/java/api/index.txt b/source/sdk/java/api/index.txt new file mode 100644 index 0000000000..e10f08b30d --- /dev/null +++ b/source/sdk/java/api/index.txt @@ -0,0 +1,63 @@ + +.. contents:: On this page + :local: + :backlinks: none + :depth: 2 + :class: singlecol + + + +API Reference +^^^^^^^^^^^^^ + +.. toctree:: + :titlesonly: + :hidden: + + + io.realm + io.realm.annotations + io.realm.coroutines + io.realm.exceptions + io.realm.gradle + io.realm.log + io.realm.mongodb + io.realm.mongodb.auth + io.realm.mongodb.functions + io.realm.mongodb.log.obfuscator + io.realm.mongodb.mongo + io.realm.mongodb.mongo.events + io.realm.mongodb.mongo.iterable + io.realm.mongodb.mongo.options + io.realm.mongodb.mongo.result + io.realm.mongodb.push + io.realm.mongodb.sync + io.realm.rx + io.realm.transformer + + + +| + +- :ref:`io.realm ` +- :ref:`io.realm.annotations ` +- :ref:`io.realm.coroutines ` +- :ref:`io.realm.exceptions ` +- :ref:`io.realm.gradle ` +- :ref:`io.realm.log ` +- :ref:`io.realm.mongodb ` +- :ref:`io.realm.mongodb.auth ` +- :ref:`io.realm.mongodb.functions ` +- :ref:`io.realm.mongodb.log.obfuscator ` +- :ref:`io.realm.mongodb.mongo ` +- :ref:`io.realm.mongodb.mongo.events ` +- :ref:`io.realm.mongodb.mongo.iterable ` +- :ref:`io.realm.mongodb.mongo.options ` +- :ref:`io.realm.mongodb.mongo.result ` +- :ref:`io.realm.mongodb.push ` +- :ref:`io.realm.mongodb.sync ` +- :ref:`io.realm.rx ` +- :ref:`io.realm.transformer ` + + + diff --git a/source/sdk/java/api/io/realm.txt b/source/sdk/java/api/io/realm.txt index 57696f22cd..857038ae82 100644 --- a/source/sdk/java/api/io/realm.txt +++ b/source/sdk/java/api/io/realm.txt @@ -16,6 +16,7 @@ io.realm Case + CollectionUtils CompactOnLaunchCallback DefaultCompactOnLaunchCallback DynamicRealm @@ -28,6 +29,8 @@ io.realm FieldAttribute FrozenPendingRow ImportFlag + MapChangeListener + MapChangeSet MutableRealmInteger ObjectChangeSet OrderedCollectionChangeSet @@ -43,13 +46,19 @@ io.realm Realm.Transaction.Callback Realm.Transaction.OnError Realm.Transaction.OnSuccess + RealmAny + RealmAny.Type + RealmAnyNativeFunctionsImpl + RealmAnyOperator RealmAsyncTask RealmChangeListener RealmCollection RealmConfiguration RealmConfiguration.Builder + RealmDictionary RealmFieldType RealmList + RealmMap RealmMigration RealmModel RealmObject @@ -59,6 +68,9 @@ io.realm RealmQuery RealmResults RealmSchema + RealmSet + SetChangeListener + SetChangeSet Sort @@ -66,6 +78,7 @@ io.realm | - :ref:`io.realm.Case ` +- :ref:`io.realm.CollectionUtils ` - :ref:`io.realm.CompactOnLaunchCallback ` - :ref:`io.realm.DefaultCompactOnLaunchCallback ` - :ref:`io.realm.DynamicRealm ` @@ -78,6 +91,8 @@ io.realm - :ref:`io.realm.FieldAttribute ` - :ref:`io.realm.FrozenPendingRow ` - :ref:`io.realm.ImportFlag ` +- :ref:`io.realm.MapChangeListener ` +- :ref:`io.realm.MapChangeSet ` - :ref:`io.realm.MutableRealmInteger ` - :ref:`io.realm.ObjectChangeSet ` - :ref:`io.realm.OrderedCollectionChangeSet ` @@ -93,13 +108,19 @@ io.realm - :ref:`io.realm.Realm.Transaction.Callback ` - :ref:`io.realm.Realm.Transaction.OnError ` - :ref:`io.realm.Realm.Transaction.OnSuccess ` +- :ref:`io.realm.RealmAny ` +- :ref:`io.realm.RealmAny.Type ` +- :ref:`io.realm.RealmAnyNativeFunctionsImpl ` +- :ref:`io.realm.RealmAnyOperator ` - :ref:`io.realm.RealmAsyncTask ` - :ref:`io.realm.RealmChangeListener ` - :ref:`io.realm.RealmCollection ` - :ref:`io.realm.RealmConfiguration ` - :ref:`io.realm.RealmConfiguration.Builder ` +- :ref:`io.realm.RealmDictionary ` - :ref:`io.realm.RealmFieldType ` - :ref:`io.realm.RealmList ` +- :ref:`io.realm.RealmMap ` - :ref:`io.realm.RealmMigration ` - :ref:`io.realm.RealmModel ` - :ref:`io.realm.RealmObject ` @@ -109,6 +130,9 @@ io.realm - :ref:`io.realm.RealmQuery ` - :ref:`io.realm.RealmResults ` - :ref:`io.realm.RealmSchema ` +- :ref:`io.realm.RealmSet ` +- :ref:`io.realm.SetChangeListener ` +- :ref:`io.realm.SetChangeSet ` - :ref:`io.realm.Sort ` diff --git a/source/sdk/java/api/io/realm/Case.txt b/source/sdk/java/api/io/realm/Case.txt index 5d4625ee9f..ef7ddc6182 100644 --- a/source/sdk/java/api/io/realm/Case.txt +++ b/source/sdk/java/api/io/realm/Case.txt @@ -18,8 +18,8 @@ io.realm ======== - | `java.lang.Object `__ - | `java.lang.Enum `__ + | `java.lang.Object `__ + | `java.lang.Enum `__ | io.realm.Case @@ -98,7 +98,7 @@ Method Summary * - public static :ref:`Case ` - | :ref:`valueOf ` ( - | `String `__ name + | `String `__ name | ) @@ -125,8 +125,8 @@ Inherited Methods -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` -- Methods inherited from class `java.lang.Enum `__ : ``name`` , ``ordinal`` , ``toString`` , ``equals`` , ``hashCode`` , ``clone`` , ``compareTo`` , ``getDeclaringClass`` , ``valueOf`` , ``finalize`` +- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` +- Methods inherited from class `java.lang.Enum `__ : ``name`` , ``ordinal`` , ``toString`` , ``equals`` , ``hashCode`` , ``clone`` , ``compareTo`` , ``getDeclaringClass`` , ``valueOf`` , ``finalize`` @@ -249,7 +249,7 @@ valueOf :header-rows: 1 * - | public static :ref:`Case ` :ref:`valueOf ` ( - | `String `__ name + | `String `__ name | ) diff --git a/source/sdk/java/api/io/realm/CollectionUtils.txt b/source/sdk/java/api/io/realm/CollectionUtils.txt new file mode 100644 index 0000000000..55de7d30eb --- /dev/null +++ b/source/sdk/java/api/io/realm/CollectionUtils.txt @@ -0,0 +1,425 @@ + +.. contents:: On this page + :local: + :backlinks: none + :depth: 2 + :class: singlecol + + + +Class CollectionUtils +^^^^^^^^^^^^^^^^^^^^^ + +.. _io_realm_CollectionUtils: + + + +io.realm +======== + + + | `java.lang.Object `__ + | io.realm.CollectionUtils + + + + + +Constructors +============ + +.. list-table:: + :header-rows: 1 + + * - Constructor and Description + + * - | :ref:`CollectionUtils ` () + | + + + + + + + + + + +Field Summary +============= + +.. list-table:: + :header-rows: 1 + + * - Modifier and Type + - Field and Description + + * - public static final `String `__ + + + - :ref:`DICTIONARY_TYPE ` + + + + + * - public static final `String `__ + + + - :ref:`LIST_TYPE ` + + + + + * - public static final `String `__ + + + - :ref:`SET_TYPE ` + + + + + + + +Method Summary +============== + +.. list-table:: + :header-rows: 1 + + * - Modifier and Type + - Method and Description + + * - public static **void** + - | :ref:`checkForAddRemoveListener ` ( + | **BaseRealm** baseRealm, + | `Object `__ listener, + | **boolean** checkListener + | ) + + + Checks whether it is possible to add or remove a provided listener. + + + + + * - public static **E** + - | :ref:`copyToRealm ` <**E** >( + | **BaseRealm** baseRealm, + | **E** object + | ) + + + Called by both list and dictionary operators to copy a RealmModel to Realm in case it has been deemed necessary. + + + + + + + +Inherited Methods +================= + + + +- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` + + + + +Field Detail +============ + +.. _io_realm_CollectionUtils_DICTIONARY_TYPE: + + + +``DICTIONARY_TYPE`` +-------------------- + + + + +.. _io_realm_CollectionUtils_LIST_TYPE: + + + +``LIST_TYPE`` +-------------- + + + + +.. _io_realm_CollectionUtils_SET_TYPE: + + + +``SET_TYPE`` +------------- + + + + + + +Constructor Detail +================== + +.. _CollectionUtils: + +.. _CollectionUtils__: + +.. _io_realm_CollectionUtils: + +.. _io_realm_CollectionUtils__: + +.. list-table:: + :header-rows: 1 + + * - | public :ref:`CollectionUtils ` () + | + + + + + * - + + + + + + + + + + + + + +Method Detail +============= + +.. _checkForAddRemoveListener: + +.. _checkForAddRemoveListener__: + +.. _CollectionUtils_checkForAddRemoveListener: + +.. _CollectionUtils_checkForAddRemoveListener__: + +.. _io_realm_CollectionUtils_checkForAddRemoveListener: + +.. _io_realm_CollectionUtils_checkForAddRemoveListener__: + + + +checkForAddRemoveListener +------------------------- + +.. _io_realm_CollectionUtils_checkForAddRemoveListener_io_realm_BaseRealm_java_lang_Object_boolean_: + +.. _io_realm_CollectionUtils_checkForAddRemoveListener_io_realm_BaseRealm__java_lang_Object__boolean_: + +.. _io_realm_CollectionUtils_checkForAddRemoveListener_io_realm_BaseRealm_Object_boolean_: + +.. _io_realm_CollectionUtils_checkForAddRemoveListener_io_realm_BaseRealm__Object__boolean_: + +.. _io_realm_CollectionUtils_checkForAddRemoveListener_BaseRealm_java_lang_Object_boolean_: + +.. _io_realm_CollectionUtils_checkForAddRemoveListener_BaseRealm__java_lang_Object__boolean_: + +.. _io_realm_CollectionUtils_checkForAddRemoveListener_BaseRealm_Object_boolean_: + +.. _io_realm_CollectionUtils_checkForAddRemoveListener_BaseRealm__Object__boolean_: + +.. _checkForAddRemoveListener_io_realm_BaseRealm_java_lang_Object_boolean_: + +.. _checkForAddRemoveListener_io_realm_BaseRealm__java_lang_Object__boolean_: + +.. _checkForAddRemoveListener_io_realm_BaseRealm_Object_boolean_: + +.. _checkForAddRemoveListener_io_realm_BaseRealm__Object__boolean_: + +.. _checkForAddRemoveListener_BaseRealm_java_lang_Object_boolean_: + +.. _checkForAddRemoveListener_BaseRealm__java_lang_Object__boolean_: + +.. _checkForAddRemoveListener_BaseRealm_Object_boolean_: + +.. _checkForAddRemoveListener_BaseRealm__Object__boolean_: + +.. _CollectionUtils_checkForAddRemoveListener_io_realm_BaseRealm_java_lang_Object_boolean_: + +.. _CollectionUtils_checkForAddRemoveListener_io_realm_BaseRealm__java_lang_Object__boolean_: + +.. _CollectionUtils_checkForAddRemoveListener_io_realm_BaseRealm_Object_boolean_: + +.. _CollectionUtils_checkForAddRemoveListener_io_realm_BaseRealm__Object__boolean_: + +.. _CollectionUtils_checkForAddRemoveListener_BaseRealm_java_lang_Object_boolean_: + +.. _CollectionUtils_checkForAddRemoveListener_BaseRealm__java_lang_Object__boolean_: + +.. _CollectionUtils_checkForAddRemoveListener_BaseRealm_Object_boolean_: + +.. _CollectionUtils_checkForAddRemoveListener_BaseRealm__Object__boolean_: + +.. list-table:: + :header-rows: 1 + + * - | public static **void** :ref:`checkForAddRemoveListener ` ( + | **BaseRealm** baseRealm, + | `Object `__ listener, + | **boolean** checkListener + | ) + + + + + * - Checks whether it is possible to add or remove a provided listener. + + + + + **Parameters** + + - ``listener`` - The listener to be checked. + + + + - ``checkListener`` - whether the check should be performed. + + + + + + + + + + + + + + + + +.. _copyToRealm: + +.. _copyToRealm__: + +.. _CollectionUtils_copyToRealm: + +.. _CollectionUtils_copyToRealm__: + +.. _io_realm_CollectionUtils_copyToRealm: + +.. _io_realm_CollectionUtils_copyToRealm__: + + + +copyToRealm +----------- + +.. _io_realm_CollectionUtils_copyToRealm_io_realm_BaseRealm_E_: + +.. _io_realm_CollectionUtils_copyToRealm_io_realm_BaseRealm__E_: + +.. _io_realm_CollectionUtils_copyToRealm_io_realm_BaseRealm_RealmModel_: + +.. _io_realm_CollectionUtils_copyToRealm_io_realm_BaseRealm__RealmModel_: + +.. _io_realm_CollectionUtils_copyToRealm_BaseRealm_E_: + +.. _io_realm_CollectionUtils_copyToRealm_BaseRealm__E_: + +.. _io_realm_CollectionUtils_copyToRealm_BaseRealm_RealmModel_: + +.. _io_realm_CollectionUtils_copyToRealm_BaseRealm__RealmModel_: + +.. _copyToRealm_io_realm_BaseRealm_E_: + +.. _copyToRealm_io_realm_BaseRealm__E_: + +.. _copyToRealm_io_realm_BaseRealm_RealmModel_: + +.. _copyToRealm_io_realm_BaseRealm__RealmModel_: + +.. _copyToRealm_BaseRealm_E_: + +.. _copyToRealm_BaseRealm__E_: + +.. _copyToRealm_BaseRealm_RealmModel_: + +.. _copyToRealm_BaseRealm__RealmModel_: + +.. _CollectionUtils_copyToRealm_io_realm_BaseRealm_E_: + +.. _CollectionUtils_copyToRealm_io_realm_BaseRealm__E_: + +.. _CollectionUtils_copyToRealm_io_realm_BaseRealm_RealmModel_: + +.. _CollectionUtils_copyToRealm_io_realm_BaseRealm__RealmModel_: + +.. _CollectionUtils_copyToRealm_BaseRealm_E_: + +.. _CollectionUtils_copyToRealm_BaseRealm__E_: + +.. _CollectionUtils_copyToRealm_BaseRealm_RealmModel_: + +.. _CollectionUtils_copyToRealm_BaseRealm__RealmModel_: + +.. list-table:: + :header-rows: 1 + + * - | public static **E** :ref:`copyToRealm ` <**E** >( + | **BaseRealm** baseRealm, + | **E** object + | ) + + + + + * - Called by both list and dictionary operators to copy a RealmModel to Realm in case it has been deemed necessary. + + + **Type Parameters** + + - ``E`` - The RealmModel type. + + + + + + + + **Parameters** + + - ``baseRealm`` - The Realm instance to copy the object to. + + + + - ``object`` - The object to copy. + + + + + + + + **Returns** + + the copied object + + + + + + + + + + + + diff --git a/source/sdk/java/api/io/realm/DefaultCompactOnLaunchCallback.txt b/source/sdk/java/api/io/realm/DefaultCompactOnLaunchCallback.txt index b2e6861b00..41db45f038 100644 --- a/source/sdk/java/api/io/realm/DefaultCompactOnLaunchCallback.txt +++ b/source/sdk/java/api/io/realm/DefaultCompactOnLaunchCallback.txt @@ -18,7 +18,7 @@ io.realm ======== - | `java.lang.Object `__ + | `java.lang.Object `__ | io.realm.DefaultCompactOnLaunchCallback @@ -81,7 +81,7 @@ Inherited Methods -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` +- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` diff --git a/source/sdk/java/api/io/realm/DynamicRealm.txt b/source/sdk/java/api/io/realm/DynamicRealm.txt index be47f43087..8a5b1d32d3 100644 --- a/source/sdk/java/api/io/realm/DynamicRealm.txt +++ b/source/sdk/java/api/io/realm/DynamicRealm.txt @@ -18,7 +18,7 @@ io.realm ======== - | `java.lang.Object `__ + | `java.lang.Object `__ | **io.realm.BaseRealm** | io.realm.DynamicRealm @@ -110,9 +110,9 @@ Method Summary * - public :ref:`DynamicRealmObject ` - | :ref:`createEmbeddedObject ` ( - | `String `__ className, + | `String `__ className, | :ref:`DynamicRealmObject ` parentObject, - | `String `__ parentProperty + | `String `__ parentProperty | ) @@ -123,8 +123,8 @@ Method Summary * - public :ref:`DynamicRealmObject ` - | :ref:`createObject ` ( - | `String `__ className, - | `Object `__ primaryKeyValue + | `String `__ className, + | `Object `__ primaryKeyValue | ) @@ -135,7 +135,7 @@ Method Summary * - public :ref:`DynamicRealmObject ` - | :ref:`createObject ` ( - | `String `__ className + | `String `__ className | ) @@ -146,7 +146,7 @@ Method Summary * - public **void** - | :ref:`delete ` ( - | `String `__ className + | `String `__ className | ) @@ -304,7 +304,7 @@ Method Summary * - public :ref:`RealmQuery ` - | :ref:`where ` ( - | `String `__ className + | `String `__ className | ) @@ -321,8 +321,8 @@ Inherited Methods -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` -- Methods inherited from class **io.realm.BaseRealm**: ``setAutoRefresh`` , ``isAutoRefresh`` , ``refresh`` , ``isInTransaction`` , ``addListener`` , ``removeListener`` , ``asFlowable`` , ``removeAllListeners`` , ``writeCopyTo`` , ``writeEncryptedCopyTo`` , ``waitForChange`` , ``stopWaitForChange`` , ``beginTransaction`` , ``commitTransaction`` , ``cancelTransaction`` , ``freeze`` , ``isFrozen`` , ``getNumberOfActiveVersions`` , ``checkIfValid`` , ``checkAllowQueriesOnUiThread`` , ``checkAllowWritesOnUiThread`` , ``checkIfInTransaction`` , ``checkIfValidAndInTransaction`` , ``getPath`` , ``getConfiguration`` , ``getVersion`` , ``close`` , ``isClosed`` , ``isEmpty`` , ``getSchema`` , ``deleteAll`` , ``migrateRealm`` , ``finalize`` +- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` +- Methods inherited from class **io.realm.BaseRealm**: ``setAutoRefresh`` , ``isAutoRefresh`` , ``refresh`` , ``isInTransaction`` , ``addListener`` , ``removeListener`` , ``asFlowable`` , ``removeAllListeners`` , ``writeCopyTo`` , ``writeEncryptedCopyTo`` , ``waitForChange`` , ``stopWaitForChange`` , ``beginTransaction`` , ``commitTransaction`` , ``cancelTransaction`` , ``freeze`` , ``isFrozen`` , ``getNumberOfActiveVersions`` , ``checkIfValid`` , ``checkAllowQueriesOnUiThread`` , ``checkAllowWritesOnUiThread`` , ``checkIfInTransaction`` , ``checkIfValidAndInTransaction`` , ``getPath`` , ``getConfiguration`` , ``getVersion`` , ``close`` , ``isClosed`` , ``isEmpty`` , ``getSchema`` , ``getSubscriptions`` , ``deleteAll`` , ``migrateRealm`` , ``finalize`` @@ -396,7 +396,7 @@ addChangeListener **Throws** - - `IllegalArgumentException `__ - if the change listener is ``null`` . + - `IllegalArgumentException `__ - if the change listener is ``null`` . @@ -645,9 +645,9 @@ createEmbeddedObject :header-rows: 1 * - | public :ref:`DynamicRealmObject ` :ref:`createEmbeddedObject ` ( - | `String `__ className, + | `String `__ className, | :ref:`DynamicRealmObject ` parentObject, - | `String `__ parentProperty + | `String `__ parentProperty | ) @@ -687,7 +687,7 @@ createEmbeddedObject **Throws** - - `IllegalArgumentException `__ - if ``clazz`` is not an embedded class or if the property in the parent class cannot hold objects of the appropriate type. + - `IllegalArgumentException `__ - if ``clazz`` is not an embedded class or if the property in the parent class cannot hold objects of the appropriate type. @@ -785,8 +785,8 @@ createObject :header-rows: 1 * - | public :ref:`DynamicRealmObject ` :ref:`createObject ` ( - | `String `__ className, - | `Object `__ primaryKeyValue + | `String `__ className, + | `Object `__ primaryKeyValue | ) @@ -814,11 +814,11 @@ createObject - - `IllegalStateException `__ - if the model clazz does not have an primary key defined. + - `IllegalStateException `__ - if the model clazz does not have a primary key defined. - - `IllegalArgumentException `__ - if the ``primaryKeyValue`` doesn't have a value that can be converted to the expected value. + - `IllegalArgumentException `__ - if the ``primaryKeyValue`` doesn't have a value that can be converted to the expected value. @@ -847,7 +847,7 @@ createObject :header-rows: 1 * - | public :ref:`DynamicRealmObject ` :ref:`createObject ` ( - | `String `__ className + | `String `__ className | ) @@ -923,7 +923,7 @@ delete :header-rows: 1 * - | public **void** :ref:`delete ` ( - | `String `__ className + | `String `__ className | ) @@ -948,7 +948,7 @@ delete **Throws** - - `IllegalStateException `__ - if the Realm is closed or called from an incorrect thread. + - `IllegalStateException `__ - if the Realm is closed or called from an incorrect thread. @@ -1033,7 +1033,7 @@ executeTransaction **Throws** - - `IllegalArgumentException `__ - if the ``transaction`` is ``null`` . + - `IllegalArgumentException `__ - if the ``transaction`` is ``null`` . @@ -1445,7 +1445,7 @@ executeTransactionAsync **Throws** - - `IllegalArgumentException `__ - if the ``transaction`` is ``null`` , or if the realm is opened from another thread. + - `IllegalArgumentException `__ - if the ``transaction`` is ``null`` , or if the realm is opened from another thread. @@ -1611,7 +1611,7 @@ executeTransactionAsync **Throws** - - `IllegalArgumentException `__ - if the ``transaction`` is ``null`` , or if the realm is opened from another thread. + - `IllegalArgumentException `__ - if the ``transaction`` is ``null`` , or if the realm is opened from another thread. @@ -1777,7 +1777,7 @@ executeTransactionAsync **Throws** - - `IllegalArgumentException `__ - if the ``transaction`` is ``null`` , or if the realm is opened from another thread. + - `IllegalArgumentException `__ - if the ``transaction`` is ``null`` , or if the realm is opened from another thread. @@ -1848,7 +1848,7 @@ executeTransactionAsync **Throws** - - `IllegalArgumentException `__ - if the ``transaction`` is ``null`` , or if the Realm is opened from another thread. + - `IllegalArgumentException `__ - if the ``transaction`` is ``null`` , or if the Realm is opened from another thread. @@ -1889,9 +1889,9 @@ freeze - * - Returns a frozen snapshot of the current Realm. This Realm can be read and queried from any thread without throwing an `IllegalStateException `__ . A frozen Realm has its own lifecycle and can be closed by calling **close()**, but fully closing the Realm that spawned the frozen copy will also close the frozen Realm. + * - Returns a frozen snapshot of the current Realm. This Realm can be read and queried from any thread without throwing an `IllegalStateException `__ . A frozen Realm has its own lifecycle and can be closed by calling **close()**, but fully closing the Realm that spawned the frozen copy will also close the frozen Realm. - Frozen data can be queried as normal, but trying to mutate it in any way or attempting to register any listener will throw an `IllegalStateException `__ . + Frozen data can be queried as normal, but trying to mutate it in any way or attempting to register any listener will throw an `IllegalStateException `__ . @@ -1985,7 +1985,7 @@ getInstance - - `IllegalArgumentException `__ - if ``configuration`` argument is ``null`` . + - `IllegalArgumentException `__ - if ``configuration`` argument is ``null`` . @@ -2148,13 +2148,13 @@ getInstanceAsync **Throws** - - `IllegalArgumentException `__ - if a null :ref:`RealmConfiguration ` or a null :ref:`Callback ` is provided. + - `IllegalArgumentException `__ - if a null :ref:`RealmConfiguration ` or a null :ref:`Callback ` is provided. - - `IllegalStateException `__ - if it is called from a non-Looper or `android.app.IntentService `__ thread. + - `IllegalStateException `__ - if it is called from a non-Looper or `android.app.IntentService `__ thread. @@ -2328,7 +2328,7 @@ removeAllChangeListeners **Throws** - - `IllegalStateException `__ - if you try to remove listeners from a non-Looper Thread. + - `IllegalStateException `__ - if you try to remove listeners from a non-Looper Thread. @@ -2415,13 +2415,13 @@ removeChangeListener **Throws** - - `IllegalArgumentException `__ - if the change listener is ``null`` . + - `IllegalArgumentException `__ - if the change listener is ``null`` . - - `IllegalStateException `__ - if you try to remove a listener from a non-Looper Thread. + - `IllegalStateException `__ - if you try to remove a listener from a non-Looper Thread. @@ -2481,7 +2481,7 @@ where :header-rows: 1 * - | public :ref:`RealmQuery ` :ref:`where ` ( - | `String `__ className + | `String `__ className | ) @@ -2511,7 +2511,7 @@ where **Throws** - - `IllegalArgumentException `__ - if the class doesn't exist. + - `IllegalArgumentException `__ - if the class doesn't exist. diff --git a/source/sdk/java/api/io/realm/DynamicRealm/Callback.txt b/source/sdk/java/api/io/realm/DynamicRealm/Callback.txt index f232676cf8..7d772b920a 100644 --- a/source/sdk/java/api/io/realm/DynamicRealm/Callback.txt +++ b/source/sdk/java/api/io/realm/DynamicRealm/Callback.txt @@ -18,7 +18,7 @@ io.realm ======== - | `java.lang.Object `__ + | `java.lang.Object `__ | **io.realm.BaseRealm.InstanceCallback** | io.realm.DynamicRealm.Callback @@ -67,7 +67,7 @@ Method Summary * - public **void** - | :ref:`onError ` ( - | `Throwable `__ exception + | `Throwable `__ exception | ) @@ -97,7 +97,7 @@ Inherited Methods -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` +- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` - Methods inherited from class **io.realm.BaseRealm.InstanceCallback**: ``onSuccess`` , ``onError`` @@ -177,7 +177,7 @@ onError :header-rows: 1 * - | public **void** :ref:`onError ` ( - | `Throwable `__ exception + | `Throwable `__ exception | ) diff --git a/source/sdk/java/api/io/realm/DynamicRealm/Transaction.txt b/source/sdk/java/api/io/realm/DynamicRealm/Transaction.txt index 3e8385236f..c0cb2459ab 100644 --- a/source/sdk/java/api/io/realm/DynamicRealm/Transaction.txt +++ b/source/sdk/java/api/io/realm/DynamicRealm/Transaction.txt @@ -25,7 +25,7 @@ io.realm -Encapsulates a Realm transaction.Using this class will automatically handle **beginTransaction()** and **commitTransaction()** If any exception is thrown during the transaction **cancelTransaction()** will be called instead of **commitTransaction()**. +Encapsulates a Realm transaction.Using this class will automatically handle **io.realm.DynamicRealm.beginTransaction()** and **io.realm.DynamicRealm.commitTransaction()** If any exception is thrown during the transaction **io.realm.DynamicRealm.cancelTransaction()** will be called instead of **io.realm.DynamicRealm.commitTransaction()**. diff --git a/source/sdk/java/api/io/realm/DynamicRealm/Transaction/Callback.txt b/source/sdk/java/api/io/realm/DynamicRealm/Transaction/Callback.txt index d0edc35d36..114f1f50c6 100644 --- a/source/sdk/java/api/io/realm/DynamicRealm/Transaction/Callback.txt +++ b/source/sdk/java/api/io/realm/DynamicRealm/Transaction/Callback.txt @@ -18,7 +18,7 @@ io.realm ======== - | `java.lang.Object `__ + | `java.lang.Object `__ | io.realm.DynamicRealm.Transaction.Callback @@ -64,7 +64,7 @@ Method Summary * - public **void** - | :ref:`onError ` ( - | `Exception `__ ignore + | `Exception `__ ignore | ) @@ -91,7 +91,7 @@ Inherited Methods -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` +- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` @@ -170,7 +170,7 @@ onError :header-rows: 1 * - | public **void** :ref:`onError ` ( - | `Exception `__ ignore + | `Exception `__ ignore | ) diff --git a/source/sdk/java/api/io/realm/DynamicRealm/Transaction/OnError.txt b/source/sdk/java/api/io/realm/DynamicRealm/Transaction/OnError.txt index 23a601eea6..a924076447 100644 --- a/source/sdk/java/api/io/realm/DynamicRealm/Transaction/OnError.txt +++ b/source/sdk/java/api/io/realm/DynamicRealm/Transaction/OnError.txt @@ -41,7 +41,7 @@ Method Summary * - public **void** - | :ref:`onError ` ( - | `Throwable `__ error + | `Throwable `__ error | ) @@ -93,7 +93,7 @@ onError :header-rows: 1 * - | public **void** :ref:`onError ` ( - | `Throwable `__ error + | `Throwable `__ error | ) diff --git a/source/sdk/java/api/io/realm/DynamicRealmObject.txt b/source/sdk/java/api/io/realm/DynamicRealmObject.txt index 805dbe2c9b..40f49b6d74 100644 --- a/source/sdk/java/api/io/realm/DynamicRealmObject.txt +++ b/source/sdk/java/api/io/realm/DynamicRealmObject.txt @@ -18,19 +18,11 @@ io.realm ======== - | `java.lang.Object `__ + | `java.lang.Object `__ | :ref:`io.realm.RealmObject ` | io.realm.DynamicRealmObject -**Implemented interfaces:** - - - -- **io.realm.internal.RealmObjectProxy** -- :ref:`io.realm.RealmModel ` - - Class that wraps a normal RealmObject in order to allow dynamic access instead of a typed interface. Using a DynamicRealmObject is slower than using the regular RealmObject class. @@ -66,7 +58,7 @@ Method Summary * - public **boolean** - | :ref:`equals ` ( - | `Object `__ o + | `Object `__ o | ) @@ -77,7 +69,7 @@ Method Summary * - public **E** - | :ref:`get ` <**E** >( - | `String `__ fieldName + | `String `__ fieldName | ) @@ -88,7 +80,7 @@ Method Summary * - public **byte** - | :ref:`getBlob ` ( - | `String `__ fieldName + | `String `__ fieldName | ) @@ -101,7 +93,7 @@ Method Summary * - public **boolean** - | :ref:`getBoolean ` ( - | `String `__ fieldName + | `String `__ fieldName | ) @@ -114,7 +106,7 @@ Method Summary * - public **byte** - | :ref:`getByte ` ( - | `String `__ fieldName + | `String `__ fieldName | ) @@ -125,9 +117,9 @@ Method Summary - * - public `Date `__ + * - public `Date `__ - | :ref:`getDate ` ( - | `String `__ fieldName + | `String `__ fieldName | ) @@ -140,7 +132,7 @@ Method Summary * - public **Decimal128** - | :ref:`getDecimal128 ` ( - | `String `__ fieldName + | `String `__ fieldName | ) @@ -151,9 +143,36 @@ Method Summary + * - public :ref:`RealmDictionary ` + - | :ref:`getDictionary ` <**E** >( + | `String `__ fieldName, + | `java.lang.Class\ `__ primitiveType + | ) + + + Returns the :ref:`RealmDictionary ` containing only primitive values. + + + + + + + * - public :ref:`RealmDictionary ` + - | :ref:`getDictionary ` ( + | `String `__ fieldName + | ) + + + Returns the :ref:`RealmDictionary ` of :ref:`DynamicRealmObject ` s being linked from the given field. + + + + + + * - public **double** - | :ref:`getDouble ` ( - | `String `__ fieldName + | `String `__ fieldName | ) @@ -176,7 +195,7 @@ Method Summary - * - public `String `__ + * - public `String `__ - | :ref:`getFieldNames ` () | @@ -188,7 +207,7 @@ Method Summary * - public :ref:`RealmFieldType ` - | :ref:`getFieldType ` ( - | `String `__ fieldName + | `String `__ fieldName | ) @@ -199,7 +218,7 @@ Method Summary * - public **float** - | :ref:`getFloat ` ( - | `String `__ fieldName + | `String `__ fieldName | ) @@ -212,7 +231,7 @@ Method Summary * - public **int** - | :ref:`getInt ` ( - | `String `__ fieldName + | `String `__ fieldName | ) @@ -225,8 +244,8 @@ Method Summary * - public :ref:`RealmList ` - | :ref:`getList ` <**E** >( - | `String `__ fieldName, - | `java.lang.Class\ `__ primitiveType + | `String `__ fieldName, + | `java.lang.Class\ `__ primitiveType | ) @@ -239,7 +258,7 @@ Method Summary * - public :ref:`RealmList ` - | :ref:`getList ` ( - | `String `__ fieldName + | `String `__ fieldName | ) @@ -252,7 +271,7 @@ Method Summary * - public **long** - | :ref:`getLong ` ( - | `String `__ fieldName + | `String `__ fieldName | ) @@ -265,7 +284,7 @@ Method Summary * - public :ref:`DynamicRealmObject ` - | :ref:`getObject ` ( - | `String `__ fieldName + | `String `__ fieldName | ) @@ -276,7 +295,7 @@ Method Summary * - public **ObjectId** - | :ref:`getObjectId ` ( - | `String `__ fieldName + | `String `__ fieldName | ) @@ -287,9 +306,49 @@ Method Summary + * - public :ref:`RealmAny ` + - | :ref:`getRealmAny ` ( + | `String `__ fieldName + | ) + + + Returns the ``RealmAny`` value for a given field. + + + + + + + * - public :ref:`RealmSet ` + - | :ref:`getRealmSet ` <**E** >( + | `String `__ fieldName, + | `java.lang.Class\ `__ primitiveType + | ) + + + Returns the :ref:`RealmSet ` containing only primitive values. + + + + + + + * - public :ref:`RealmSet ` + - | :ref:`getRealmSet ` ( + | `String `__ fieldName + | ) + + + Returns the :ref:`RealmSet ` of :ref:`DynamicRealmObject ` s being linked from the given field. + + + + + + * - public **short** - | :ref:`getShort ` ( - | `String `__ fieldName + | `String `__ fieldName | ) @@ -300,9 +359,9 @@ Method Summary - * - public `String `__ + * - public `String `__ - | :ref:`getString ` ( - | `String `__ fieldName + | `String `__ fieldName | ) @@ -313,7 +372,7 @@ Method Summary - * - public `String `__ + * - public `String `__ - | :ref:`getType ` () | @@ -323,9 +382,22 @@ Method Summary + * - public `UUID `__ + - | :ref:`getUUID ` ( + | `String `__ fieldName + | ) + + + Returns the ``UUID`` value for a given field. + + + + + + * - public **boolean** - | :ref:`hasField ` ( - | `String `__ fieldName + | `String `__ fieldName | ) @@ -348,7 +420,7 @@ Method Summary * - public **boolean** - | :ref:`isNull ` ( - | `String `__ fieldName + | `String `__ fieldName | ) @@ -361,8 +433,8 @@ Method Summary * - public :ref:`RealmResults ` - | :ref:`linkingObjects ` ( - | `String `__ srcClassName, - | `String `__ srcFieldName + | `String `__ srcClassName, + | `String `__ srcFieldName | ) @@ -395,8 +467,8 @@ Method Summary * - public **void** - | :ref:`set ` ( - | `String `__ fieldName, - | `Object `__ value + | `String `__ fieldName, + | `Object `__ value | ) @@ -407,7 +479,7 @@ Method Summary * - public **void** - | :ref:`setBlob ` ( - | `String `__ fieldName, + | `String `__ fieldName, | **byte[]** value | ) @@ -419,7 +491,7 @@ Method Summary * - public **void** - | :ref:`setBoolean ` ( - | `String `__ fieldName, + | `String `__ fieldName, | **boolean** value | ) @@ -433,7 +505,7 @@ Method Summary * - public **void** - | :ref:`setByte ` ( - | `String `__ fieldName, + | `String `__ fieldName, | **byte** value | ) @@ -447,8 +519,8 @@ Method Summary * - public **void** - | :ref:`setDate ` ( - | `String `__ fieldName, - | `Date `__ value + | `String `__ fieldName, + | `Date `__ value | ) @@ -461,7 +533,7 @@ Method Summary * - public **void** - | :ref:`setDecimal128 ` ( - | `String `__ fieldName, + | `String `__ fieldName, | **Decimal128** value | ) @@ -473,9 +545,23 @@ Method Summary + * - public **void** + - | :ref:`setDictionary ` <**E** >( + | `String `__ fieldName, + | :ref:`io.realm.RealmDictionary\ ` dictionary + | ) + + + Sets the reference to a :ref:`RealmDictionary ` on the given field. + + + + + + * - public **void** - | :ref:`setDouble ` ( - | `String `__ fieldName, + | `String `__ fieldName, | **double** value | ) @@ -489,7 +575,7 @@ Method Summary * - public **void** - | :ref:`setFloat ` ( - | `String `__ fieldName, + | `String `__ fieldName, | **float** value | ) @@ -503,7 +589,7 @@ Method Summary * - public **void** - | :ref:`setInt ` ( - | `String `__ fieldName, + | `String `__ fieldName, | **int** value | ) @@ -517,7 +603,7 @@ Method Summary * - public **void** - | :ref:`setList ` <**E** >( - | `String `__ fieldName, + | `String `__ fieldName, | :ref:`io.realm.RealmList\ ` list | ) @@ -531,7 +617,7 @@ Method Summary * - public **void** - | :ref:`setLong ` ( - | `String `__ fieldName, + | `String `__ fieldName, | **long** value | ) @@ -545,7 +631,7 @@ Method Summary * - public **void** - | :ref:`setNull ` ( - | `String `__ fieldName + | `String `__ fieldName | ) @@ -558,7 +644,7 @@ Method Summary * - public **void** - | :ref:`setObject ` ( - | `String `__ fieldName, + | `String `__ fieldName, | :ref:`DynamicRealmObject ` value | ) @@ -570,7 +656,7 @@ Method Summary * - public **void** - | :ref:`setObjectId ` ( - | `String `__ fieldName, + | `String `__ fieldName, | **ObjectId** value | ) @@ -582,9 +668,37 @@ Method Summary + * - public **void** + - | :ref:`setRealmAny ` ( + | `String `__ fieldName, + | :ref:`RealmAny ` value + | ) + + + Sets the ``RealmAny`` value of the given field. + + + + + + + * - public **void** + - | :ref:`setRealmSet ` <**E** >( + | `String `__ fieldName, + | :ref:`io.realm.RealmSet\ ` set + | ) + + + Sets the reference to a :ref:`RealmSet ` on the given field. + + + + + + * - public **void** - | :ref:`setShort ` ( - | `String `__ fieldName, + | `String `__ fieldName, | **short** value | ) @@ -598,8 +712,8 @@ Method Summary * - public **void** - | :ref:`setString ` ( - | `String `__ fieldName, - | `String `__ value + | `String `__ fieldName, + | `String `__ value | ) @@ -610,7 +724,21 @@ Method Summary - * - public `String `__ + * - public **void** + - | :ref:`setUUID ` ( + | `String `__ fieldName, + | `UUID `__ value + | ) + + + Sets the ``UUID`` value of the given field. + + + + + + + * - public `String `__ - | :ref:`toString ` () | @@ -628,7 +756,7 @@ Inherited Methods -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` +- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` - Methods inherited from class :ref:`io.realm.RealmObject ` : ``deleteFromRealm`` , ``deleteFromRealm`` , ``isValid`` , ``isValid`` , ``isFrozen`` , ``freeze`` , ``isFrozen`` , ``freeze`` , ``isLoaded`` , ``isLoaded`` , ``isManaged`` , ``isManaged`` , ``getRealm`` , ``getRealm`` , ``load`` , ``load`` , ``addChangeListener`` , ``addChangeListener`` , ``addChangeListener`` , ``addChangeListener`` , ``removeChangeListener`` , ``removeChangeListener`` , ``removeChangeListener`` , ``removeChangeListener`` , ``removeAllChangeListeners`` , ``removeAllChangeListeners`` , ``asFlowable`` , ``asChangesetObservable`` , ``asFlowable`` , ``asChangesetObservable`` @@ -715,7 +843,7 @@ equals :header-rows: 1 * - | public **boolean** :ref:`equals ` ( - | `Object `__ o + | `Object `__ o | ) @@ -734,7 +862,7 @@ equals **Overrides** - ``equals`` in class `Object `__ + ``equals`` in class `Object `__ @@ -774,7 +902,7 @@ get :header-rows: 1 * - | public **E** :ref:`get ` <**E** >( - | `String `__ fieldName + | `String `__ fieldName | ) @@ -804,7 +932,7 @@ get **Throws** - - `ClassCastException `__ - if the field doesn't contain a field of the defined return type. + - `ClassCastException `__ - if the field doesn't contain a field of the defined return type. @@ -850,7 +978,7 @@ getBlob :header-rows: 1 * - | public **byte** :ref:`getBlob ` ( - | `String `__ fieldName + | `String `__ fieldName | ) @@ -882,7 +1010,7 @@ getBlob **Throws** - - `IllegalArgumentException `__ - if field name doesn't exist or it doesn't contain binary data. + - `IllegalArgumentException `__ - if field name doesn't exist or it doesn't contain binary data. @@ -928,7 +1056,7 @@ getBoolean :header-rows: 1 * - | public **boolean** :ref:`getBoolean ` ( - | `String `__ fieldName + | `String `__ fieldName | ) @@ -964,7 +1092,7 @@ getBoolean **Throws** - - `IllegalArgumentException `__ - if field name doesn't exist or it doesn't contain booleans. + - `IllegalArgumentException `__ - if field name doesn't exist or it doesn't contain booleans. @@ -1016,7 +1144,7 @@ getByte :header-rows: 1 * - | public **byte** :ref:`getByte ` ( - | `String `__ fieldName + | `String `__ fieldName | ) @@ -1052,7 +1180,7 @@ getByte **Throws** - - `IllegalArgumentException `__ - if field name doesn't exist or it doesn't contain integers. + - `IllegalArgumentException `__ - if field name doesn't exist or it doesn't contain integers. @@ -1103,8 +1231,8 @@ getDate .. list-table:: :header-rows: 1 - * - | public `Date `__ :ref:`getDate ` ( - | `String `__ fieldName + * - | public `Date `__ :ref:`getDate ` ( + | `String `__ fieldName | ) @@ -1136,7 +1264,7 @@ getDate **Throws** - - `IllegalArgumentException `__ - if field name doesn't exist or it doesn't contain Dates. + - `IllegalArgumentException `__ - if field name doesn't exist or it doesn't contain Dates. @@ -1182,7 +1310,7 @@ getDecimal128 :header-rows: 1 * - | public **Decimal128** :ref:`getDecimal128 ` ( - | `String `__ fieldName + | `String `__ fieldName | ) @@ -1214,7 +1342,199 @@ getDecimal128 **Throws** - - `IllegalArgumentException `__ - if field name doesn't exist or it doesn't contain Decimal128. + - `IllegalArgumentException `__ - if field name doesn't exist or it doesn't contain Decimal128. + + + + + + + + + + + + +.. _getDictionary: + +.. _getDictionary__: + +.. _DynamicRealmObject_getDictionary: + +.. _DynamicRealmObject_getDictionary__: + +.. _io_realm_DynamicRealmObject_getDictionary: + +.. _io_realm_DynamicRealmObject_getDictionary__: + + + +getDictionary +------------- + +.. _io_realm_DynamicRealmObject_getDictionary_java_lang_String_java_lang_Class_: + +.. _io_realm_DynamicRealmObject_getDictionary_java_lang_String__java_lang_Class_: + +.. _io_realm_DynamicRealmObject_getDictionary_java_lang_String_Class_: + +.. _io_realm_DynamicRealmObject_getDictionary_java_lang_String__Class_: + +.. _io_realm_DynamicRealmObject_getDictionary_String_java_lang_Class_: + +.. _io_realm_DynamicRealmObject_getDictionary_String__java_lang_Class_: + +.. _io_realm_DynamicRealmObject_getDictionary_String_Class_: + +.. _io_realm_DynamicRealmObject_getDictionary_String__Class_: + +.. _getDictionary_java_lang_String_java_lang_Class_: + +.. _getDictionary_java_lang_String__java_lang_Class_: + +.. _getDictionary_java_lang_String_Class_: + +.. _getDictionary_java_lang_String__Class_: + +.. _getDictionary_String_java_lang_Class_: + +.. _getDictionary_String__java_lang_Class_: + +.. _getDictionary_String_Class_: + +.. _getDictionary_String__Class_: + +.. _DynamicRealmObject_getDictionary_java_lang_String_java_lang_Class_: + +.. _DynamicRealmObject_getDictionary_java_lang_String__java_lang_Class_: + +.. _DynamicRealmObject_getDictionary_java_lang_String_Class_: + +.. _DynamicRealmObject_getDictionary_java_lang_String__Class_: + +.. _DynamicRealmObject_getDictionary_String_java_lang_Class_: + +.. _DynamicRealmObject_getDictionary_String__java_lang_Class_: + +.. _DynamicRealmObject_getDictionary_String_Class_: + +.. _DynamicRealmObject_getDictionary_String__Class_: + +.. _io_realm_DynamicRealmObject_getDictionary_String__Class_E__: + +.. list-table:: + :header-rows: 1 + + * - | public :ref:`RealmDictionary ` :ref:`getDictionary ` <**E** >( + | `String `__ fieldName, + | `java.lang.Class\ `__ primitiveType + | ) + + + + + * - Returns the :ref:`RealmDictionary ` containing only primitive values. + + If the dictionary contains references to other Realm objects, use :ref:`getDictionary(String) ` instead. + + + + + + + + + **Parameters** + + - ``fieldName`` - the name of the field. + + + + - ``primitiveType`` - the type of elements in the dictionary. Only primitive types are supported. + + + + + + + + **Returns** + + the :ref:`RealmDictionary ` data for this field. + + + + + + + **Throws** + + - `IllegalArgumentException `__ - if field name doesn't exist or it doesn't contain a dictionary of primitive objects. + + + + + + + + + + +.. _io_realm_DynamicRealmObject_getDictionary_java_lang_String_: + +.. _io_realm_DynamicRealmObject_getDictionary_String_: + +.. _getDictionary_java_lang_String_: + +.. _getDictionary_String_: + +.. _DynamicRealmObject_getDictionary_java_lang_String_: + +.. _DynamicRealmObject_getDictionary_String_: + +.. list-table:: + :header-rows: 1 + + * - | public :ref:`RealmDictionary ` :ref:`getDictionary ` ( + | `String `__ fieldName + | ) + + + + + * - Returns the :ref:`RealmDictionary ` of :ref:`DynamicRealmObject ` s being linked from the given field. + + If the dictionary contains primitive types, use :ref:`getDictionary(String, Class) ` instead. + + + + + + + + + **Parameters** + + - ``fieldName`` - the name of the field. + + + + + + + + **Returns** + + the :ref:`RealmDictionary ` data for this field. + + + + + + + **Throws** + + - `IllegalArgumentException `__ - if field name doesn't exist or it doesn't contain a dictionary of objects. @@ -1260,7 +1580,7 @@ getDouble :header-rows: 1 * - | public **double** :ref:`getDouble ` ( - | `String `__ fieldName + | `String `__ fieldName | ) @@ -1296,7 +1616,7 @@ getDouble **Throws** - - `IllegalArgumentException `__ - if field name doesn't exist or it doesn't contain doubles. + - `IllegalArgumentException `__ - if field name doesn't exist or it doesn't contain doubles. @@ -1365,7 +1685,7 @@ getDynamicRealm **Throws** - - `IllegalStateException `__ - if this object was deleted or the corresponding :ref:`DynamicRealm ` was already closed. + - `IllegalStateException `__ - if this object was deleted or the corresponding :ref:`DynamicRealm ` was already closed. @@ -1400,7 +1720,7 @@ getFieldNames .. list-table:: :header-rows: 1 - * - | public `String `__ :ref:`getFieldNames ` () + * - | public `String `__ :ref:`getFieldNames ` () | @@ -1460,7 +1780,7 @@ getFieldType :header-rows: 1 * - | public :ref:`RealmFieldType ` :ref:`getFieldType ` ( - | `String `__ fieldName + | `String `__ fieldName | ) @@ -1520,7 +1840,7 @@ getFloat :header-rows: 1 * - | public **float** :ref:`getFloat ` ( - | `String `__ fieldName + | `String `__ fieldName | ) @@ -1556,7 +1876,7 @@ getFloat **Throws** - - `IllegalArgumentException `__ - if field name doesn't exist or it doesn't contain floats. + - `IllegalArgumentException `__ - if field name doesn't exist or it doesn't contain floats. @@ -1608,7 +1928,7 @@ getInt :header-rows: 1 * - | public **int** :ref:`getInt ` ( - | `String `__ fieldName + | `String `__ fieldName | ) @@ -1646,7 +1966,7 @@ getInt **Throws** - - `IllegalArgumentException `__ - if field name doesn't exist or it doesn't contain integers. + - `IllegalArgumentException `__ - if field name doesn't exist or it doesn't contain integers. @@ -1736,8 +2056,8 @@ getList :header-rows: 1 * - | public :ref:`RealmList ` :ref:`getList ` <**E** >( - | `String `__ fieldName, - | `java.lang.Class\ `__ primitiveType + | `String `__ fieldName, + | `java.lang.Class\ `__ primitiveType | ) @@ -1779,7 +2099,7 @@ getList **Throws** - - `IllegalArgumentException `__ - if field name doesn't exist or it doesn't contain a list of primitive objects. + - `IllegalArgumentException `__ - if field name doesn't exist or it doesn't contain a list of primitive objects. @@ -1806,7 +2126,7 @@ getList :header-rows: 1 * - | public :ref:`RealmList ` :ref:`getList ` ( - | `String `__ fieldName + | `String `__ fieldName | ) @@ -1844,7 +2164,7 @@ getList **Throws** - - `IllegalArgumentException `__ - if field name doesn't exist or it doesn't contain a list of objects. + - `IllegalArgumentException `__ - if field name doesn't exist or it doesn't contain a list of objects. @@ -1890,7 +2210,7 @@ getLong :header-rows: 1 * - | public **long** :ref:`getLong ` ( - | `String `__ fieldName + | `String `__ fieldName | ) @@ -1928,7 +2248,7 @@ getLong **Throws** - - `IllegalArgumentException `__ - if field name doesn't exist or it doesn't contain integers. + - `IllegalArgumentException `__ - if field name doesn't exist or it doesn't contain integers. @@ -1980,7 +2300,7 @@ getObject :header-rows: 1 * - | public :ref:`DynamicRealmObject ` :ref:`getObject ` ( - | `String `__ fieldName + | `String `__ fieldName | ) @@ -2012,7 +2332,7 @@ getObject **Throws** - - `IllegalArgumentException `__ - if field name doesn't exist or it doesn't contain links to other objects. + - `IllegalArgumentException `__ - if field name doesn't exist or it doesn't contain links to other objects. @@ -2058,7 +2378,7 @@ getObjectId :header-rows: 1 * - | public **ObjectId** :ref:`getObjectId ` ( - | `String `__ fieldName + | `String `__ fieldName | ) @@ -2090,7 +2410,7 @@ getObjectId **Throws** - - `IllegalArgumentException `__ - if field name doesn't exist or it doesn't contain ObjectId. + - `IllegalArgumentException `__ - if field name doesn't exist or it doesn't contain ObjectId. @@ -2103,46 +2423,316 @@ getObjectId -.. _getShort: +.. _getRealmAny: -.. _getShort__: +.. _getRealmAny__: -.. _DynamicRealmObject_getShort: +.. _DynamicRealmObject_getRealmAny: -.. _DynamicRealmObject_getShort__: +.. _DynamicRealmObject_getRealmAny__: -.. _io_realm_DynamicRealmObject_getShort: +.. _io_realm_DynamicRealmObject_getRealmAny: -.. _io_realm_DynamicRealmObject_getShort__: +.. _io_realm_DynamicRealmObject_getRealmAny__: -getShort --------- +getRealmAny +----------- -.. _io_realm_DynamicRealmObject_getShort_java_lang_String_: +.. _io_realm_DynamicRealmObject_getRealmAny_java_lang_String_: -.. _io_realm_DynamicRealmObject_getShort_String_: +.. _io_realm_DynamicRealmObject_getRealmAny_String_: -.. _getShort_java_lang_String_: +.. _getRealmAny_java_lang_String_: -.. _getShort_String_: +.. _getRealmAny_String_: -.. _DynamicRealmObject_getShort_java_lang_String_: +.. _DynamicRealmObject_getRealmAny_java_lang_String_: -.. _DynamicRealmObject_getShort_String_: +.. _DynamicRealmObject_getRealmAny_String_: .. list-table:: :header-rows: 1 - * - | public **short** :ref:`getShort ` ( - | `String `__ fieldName + * - | public :ref:`RealmAny ` :ref:`getRealmAny ` ( + | `String `__ fieldName | ) - * - Returns the ``short`` value for a given field. + * - Returns the ``RealmAny`` value for a given field. + + + + + + + **Parameters** + + - ``fieldName`` - the name of the field. + + + + + + + + **Returns** + + the RealmAny value. + + + + + **Throws** + + - `IllegalArgumentException `__ - if field name doesn't exist or it doesn't contain RealmAny. + + + + + + + + + + + + +.. _getRealmSet: + +.. _getRealmSet__: + +.. _DynamicRealmObject_getRealmSet: + +.. _DynamicRealmObject_getRealmSet__: + +.. _io_realm_DynamicRealmObject_getRealmSet: + +.. _io_realm_DynamicRealmObject_getRealmSet__: + + + +getRealmSet +----------- + +.. _io_realm_DynamicRealmObject_getRealmSet_java_lang_String_java_lang_Class_: + +.. _io_realm_DynamicRealmObject_getRealmSet_java_lang_String__java_lang_Class_: + +.. _io_realm_DynamicRealmObject_getRealmSet_java_lang_String_Class_: + +.. _io_realm_DynamicRealmObject_getRealmSet_java_lang_String__Class_: + +.. _io_realm_DynamicRealmObject_getRealmSet_String_java_lang_Class_: + +.. _io_realm_DynamicRealmObject_getRealmSet_String__java_lang_Class_: + +.. _io_realm_DynamicRealmObject_getRealmSet_String_Class_: + +.. _io_realm_DynamicRealmObject_getRealmSet_String__Class_: + +.. _getRealmSet_java_lang_String_java_lang_Class_: + +.. _getRealmSet_java_lang_String__java_lang_Class_: + +.. _getRealmSet_java_lang_String_Class_: + +.. _getRealmSet_java_lang_String__Class_: + +.. _getRealmSet_String_java_lang_Class_: + +.. _getRealmSet_String__java_lang_Class_: + +.. _getRealmSet_String_Class_: + +.. _getRealmSet_String__Class_: + +.. _DynamicRealmObject_getRealmSet_java_lang_String_java_lang_Class_: + +.. _DynamicRealmObject_getRealmSet_java_lang_String__java_lang_Class_: + +.. _DynamicRealmObject_getRealmSet_java_lang_String_Class_: + +.. _DynamicRealmObject_getRealmSet_java_lang_String__Class_: + +.. _DynamicRealmObject_getRealmSet_String_java_lang_Class_: + +.. _DynamicRealmObject_getRealmSet_String__java_lang_Class_: + +.. _DynamicRealmObject_getRealmSet_String_Class_: + +.. _DynamicRealmObject_getRealmSet_String__Class_: + +.. _io_realm_DynamicRealmObject_getRealmSet_String__Class_E__: + +.. list-table:: + :header-rows: 1 + + * - | public :ref:`RealmSet ` :ref:`getRealmSet ` <**E** >( + | `String `__ fieldName, + | `java.lang.Class\ `__ primitiveType + | ) + + + + + * - Returns the :ref:`RealmSet ` containing only primitive values. + + If the set contains references to other Realm objects, use :ref:`getRealmSet(String) ` instead. + + + + + + + + + **Parameters** + + - ``fieldName`` - the name of the field. + + + + - ``primitiveType`` - the type of elements in the set. Only primitive types are supported. + + + + + + + + **Returns** + + the :ref:`RealmSet ` data for this field. + + + + + + + **Throws** + + - `IllegalArgumentException `__ - if field name doesn't exist or it doesn't contain a set of primitive objects. + + + + + + + + + + +.. _io_realm_DynamicRealmObject_getRealmSet_java_lang_String_: + +.. _io_realm_DynamicRealmObject_getRealmSet_String_: + +.. _getRealmSet_java_lang_String_: + +.. _getRealmSet_String_: + +.. _DynamicRealmObject_getRealmSet_java_lang_String_: + +.. _DynamicRealmObject_getRealmSet_String_: + +.. list-table:: + :header-rows: 1 + + * - | public :ref:`RealmSet ` :ref:`getRealmSet ` ( + | `String `__ fieldName + | ) + + + + + * - Returns the :ref:`RealmSet ` of :ref:`DynamicRealmObject ` s being linked from the given field. + + If the set contains primitive types, use :ref:`getRealmSet(String, Class) ` instead. + + + + + + + + + **Parameters** + + - ``fieldName`` - the name of the field. + + + + + + + + **Returns** + + the :ref:`RealmSet ` data for this field. + + + + + + + **Throws** + + - `IllegalArgumentException `__ - if field name doesn't exist or it doesn't contain a set of objects. + + + + + + + + + + + + +.. _getShort: + +.. _getShort__: + +.. _DynamicRealmObject_getShort: + +.. _DynamicRealmObject_getShort__: + +.. _io_realm_DynamicRealmObject_getShort: + +.. _io_realm_DynamicRealmObject_getShort__: + + + +getShort +-------- + +.. _io_realm_DynamicRealmObject_getShort_java_lang_String_: + +.. _io_realm_DynamicRealmObject_getShort_String_: + +.. _getShort_java_lang_String_: + +.. _getShort_String_: + +.. _DynamicRealmObject_getShort_java_lang_String_: + +.. _DynamicRealmObject_getShort_String_: + +.. list-table:: + :header-rows: 1 + + * - | public **short** :ref:`getShort ` ( + | `String `__ fieldName + | ) + + + + + * - Returns the ``short`` value for a given field. If the field is nullable, use :ref:`isNull(String) ` to check for ``null`` instead of using this method. @@ -2174,7 +2764,7 @@ getShort **Throws** - - `IllegalArgumentException `__ - if field name doesn't exist or it doesn't contain integers. + - `IllegalArgumentException `__ - if field name doesn't exist or it doesn't contain integers. @@ -2225,8 +2815,8 @@ getString .. list-table:: :header-rows: 1 - * - | public `String `__ :ref:`getString ` ( - | `String `__ fieldName + * - | public `String `__ :ref:`getString ` ( + | `String `__ fieldName | ) @@ -2258,7 +2848,7 @@ getString **Throws** - - `IllegalArgumentException `__ - if field name doesn't exist or it doesn't contain Strings. + - `IllegalArgumentException `__ - if field name doesn't exist or it doesn't contain Strings. @@ -2291,7 +2881,7 @@ getType .. list-table:: :header-rows: 1 - * - | public `String `__ :ref:`getType ` () + * - | public `String `__ :ref:`getType ` () | @@ -2320,6 +2910,84 @@ getType +.. _getUUID: + +.. _getUUID__: + +.. _DynamicRealmObject_getUUID: + +.. _DynamicRealmObject_getUUID__: + +.. _io_realm_DynamicRealmObject_getUUID: + +.. _io_realm_DynamicRealmObject_getUUID__: + + + +getUUID +------- + +.. _io_realm_DynamicRealmObject_getUUID_java_lang_String_: + +.. _io_realm_DynamicRealmObject_getUUID_String_: + +.. _getUUID_java_lang_String_: + +.. _getUUID_String_: + +.. _DynamicRealmObject_getUUID_java_lang_String_: + +.. _DynamicRealmObject_getUUID_String_: + +.. list-table:: + :header-rows: 1 + + * - | public `UUID `__ :ref:`getUUID ` ( + | `String `__ fieldName + | ) + + + + + * - Returns the ``UUID`` value for a given field. + + + + + + + **Parameters** + + - ``fieldName`` - the name of the field. + + + + + + + + **Returns** + + the UUID value. + + + + + **Throws** + + - `IllegalArgumentException `__ - if field name doesn't exist or it doesn't contain UUID. + + + + + + + + + + + + .. _hasField: .. _hasField__: @@ -2353,7 +3021,7 @@ hasField :header-rows: 1 * - | public **boolean** :ref:`hasField ` ( - | `String `__ fieldName + | `String `__ fieldName | ) @@ -2418,7 +3086,7 @@ hashCode * - Returns a hash code value for the :ref:`DynamicRealmObject ` object. - By the general contract of `Object.hashCode() `__ , any two objects for which :ref:`equals ` returns ``true`` must return the same hash code value. + By the general contract of `Object.hashCode() `__ , any two objects for which :ref:`equals ` returns ``true`` must return the same hash code value. @@ -2444,7 +3112,7 @@ hashCode **Overrides** - ``hashCode`` in class `Object `__ + ``hashCode`` in class `Object `__ @@ -2498,7 +3166,7 @@ isNull :header-rows: 1 * - | public **boolean** :ref:`isNull ` ( - | `String `__ fieldName + | `String `__ fieldName | ) @@ -2532,7 +3200,7 @@ isNull **Throws** - - `IllegalArgumentException `__ - if field name doesn't exist. + - `IllegalArgumentException `__ - if field name doesn't exist. @@ -2614,8 +3282,8 @@ linkingObjects :header-rows: 1 * - | public :ref:`RealmResults ` :ref:`linkingObjects ` ( - | `String `__ srcClassName, - | `String `__ srcFieldName + | `String `__ srcClassName, + | `String `__ srcFieldName | ) @@ -2655,7 +3323,7 @@ linkingObjects **Throws** - - `IllegalArgumentException `__ - if the ``srcClassName`` is ``null`` or does not exist, the ``srcFieldName`` is ``null`` or does not exist, type of the source field is not supported. + - `IllegalArgumentException `__ - if the ``srcClassName`` is ``null`` or does not exist, the ``srcFieldName`` is ``null`` or does not exist, type of the source field is not supported. @@ -2823,8 +3491,8 @@ set :header-rows: 1 * - | public **void** :ref:`set ` ( - | `String `__ fieldName, - | `Object `__ value + | `String `__ fieldName, + | `Object `__ value | ) @@ -2845,11 +3513,11 @@ set **Throws** - - `IllegalArgumentException `__ - if field name doesn't exist or if the input value cannot be converted to the appropriate input type. + - `IllegalArgumentException `__ - if field name doesn't exist or if the input value cannot be converted to the appropriate input type. - - `NumberFormatException `__ - if a String based number cannot be converted properly. + - `NumberFormatException `__ - if a String based number cannot be converted properly. @@ -2939,7 +3607,7 @@ setBlob :header-rows: 1 * - | public **void** :ref:`setBlob ` ( - | `String `__ fieldName, + | `String `__ fieldName, | **byte[]** value | ) @@ -2969,7 +3637,7 @@ setBlob **Throws** - - `IllegalArgumentException `__ - if field name doesn't exist or field isn't a binary field. + - `IllegalArgumentException `__ - if field name doesn't exist or field isn't a binary field. @@ -3027,7 +3695,7 @@ setBoolean :header-rows: 1 * - | public **void** :ref:`setBoolean ` ( - | `String `__ fieldName, + | `String `__ fieldName, | **boolean** value | ) @@ -3059,7 +3727,7 @@ setBoolean **Throws** - - `IllegalArgumentException `__ - if field name doesn't exist or field isn't a boolean field. + - `IllegalArgumentException `__ - if field name doesn't exist or field isn't a boolean field. @@ -3117,7 +3785,7 @@ setByte :header-rows: 1 * - | public **void** :ref:`setByte ` ( - | `String `__ fieldName, + | `String `__ fieldName, | **byte** value | ) @@ -3149,7 +3817,7 @@ setByte **Throws** - - `IllegalArgumentException `__ - if field name doesn't exist or field isn't an integer field. + - `IllegalArgumentException `__ - if field name doesn't exist or field isn't an integer field. @@ -3237,8 +3905,8 @@ setDate :header-rows: 1 * - | public **void** :ref:`setDate ` ( - | `String `__ fieldName, - | `Date `__ value + | `String `__ fieldName, + | `Date `__ value | ) @@ -3269,7 +3937,7 @@ setDate **Throws** - - `IllegalArgumentException `__ - if field name doesn't exist or field isn't a Date field. + - `IllegalArgumentException `__ - if field name doesn't exist or field isn't a Date field. @@ -3307,34 +3975,154 @@ setDecimal128 .. _io_realm_DynamicRealmObject_setDecimal128_String__Decimal128_: -.. _setDecimal128_java_lang_String_Decimal128_: +.. _setDecimal128_java_lang_String_Decimal128_: + +.. _setDecimal128_java_lang_String__Decimal128_: + +.. _setDecimal128_String_Decimal128_: + +.. _setDecimal128_String__Decimal128_: + +.. _DynamicRealmObject_setDecimal128_java_lang_String_Decimal128_: + +.. _DynamicRealmObject_setDecimal128_java_lang_String__Decimal128_: + +.. _DynamicRealmObject_setDecimal128_String_Decimal128_: + +.. _DynamicRealmObject_setDecimal128_String__Decimal128_: + +.. list-table:: + :header-rows: 1 + + * - | public **void** :ref:`setDecimal128 ` ( + | `String `__ fieldName, + | **Decimal128** value + | ) + + + + + * - Sets the ``Decimal128`` value of the given field. + + + + + + + **Parameters** + + - ``fieldName`` - field name. + + + + - ``value`` - value to insert. + + + + + + + + + + **Throws** + + - `IllegalArgumentException `__ - if field name doesn't exist or field isn't a Decimal128 field. + + + + + + + + + + + + +.. _setDictionary: + +.. _setDictionary__: + +.. _DynamicRealmObject_setDictionary: + +.. _DynamicRealmObject_setDictionary__: + +.. _io_realm_DynamicRealmObject_setDictionary: + +.. _io_realm_DynamicRealmObject_setDictionary__: + + + +setDictionary +------------- + +.. _io_realm_DynamicRealmObject_setDictionary_java_lang_String_io_realm_RealmDictionary_: + +.. _io_realm_DynamicRealmObject_setDictionary_java_lang_String__io_realm_RealmDictionary_: + +.. _io_realm_DynamicRealmObject_setDictionary_java_lang_String_RealmDictionary_: + +.. _io_realm_DynamicRealmObject_setDictionary_java_lang_String__RealmDictionary_: + +.. _io_realm_DynamicRealmObject_setDictionary_String_io_realm_RealmDictionary_: + +.. _io_realm_DynamicRealmObject_setDictionary_String__io_realm_RealmDictionary_: + +.. _io_realm_DynamicRealmObject_setDictionary_String_RealmDictionary_: + +.. _io_realm_DynamicRealmObject_setDictionary_String__RealmDictionary_: + +.. _setDictionary_java_lang_String_io_realm_RealmDictionary_: + +.. _setDictionary_java_lang_String__io_realm_RealmDictionary_: + +.. _setDictionary_java_lang_String_RealmDictionary_: + +.. _setDictionary_java_lang_String__RealmDictionary_: + +.. _setDictionary_String_io_realm_RealmDictionary_: + +.. _setDictionary_String__io_realm_RealmDictionary_: + +.. _setDictionary_String_RealmDictionary_: + +.. _setDictionary_String__RealmDictionary_: + +.. _DynamicRealmObject_setDictionary_java_lang_String_io_realm_RealmDictionary_: + +.. _DynamicRealmObject_setDictionary_java_lang_String__io_realm_RealmDictionary_: -.. _setDecimal128_java_lang_String__Decimal128_: +.. _DynamicRealmObject_setDictionary_java_lang_String_RealmDictionary_: -.. _setDecimal128_String_Decimal128_: +.. _DynamicRealmObject_setDictionary_java_lang_String__RealmDictionary_: -.. _setDecimal128_String__Decimal128_: +.. _DynamicRealmObject_setDictionary_String_io_realm_RealmDictionary_: -.. _DynamicRealmObject_setDecimal128_java_lang_String_Decimal128_: +.. _DynamicRealmObject_setDictionary_String__io_realm_RealmDictionary_: -.. _DynamicRealmObject_setDecimal128_java_lang_String__Decimal128_: +.. _DynamicRealmObject_setDictionary_String_RealmDictionary_: -.. _DynamicRealmObject_setDecimal128_String_Decimal128_: +.. _DynamicRealmObject_setDictionary_String__RealmDictionary_: -.. _DynamicRealmObject_setDecimal128_String__Decimal128_: +.. _io_realm_DynamicRealmObject_setDictionary_String__RealmDictionary_E__: .. list-table:: :header-rows: 1 - * - | public **void** :ref:`setDecimal128 ` ( - | `String `__ fieldName, - | **Decimal128** value + * - | public **void** :ref:`setDictionary ` <**E** >( + | `String `__ fieldName, + | :ref:`io.realm.RealmDictionary\ ` dictionary | ) - * - Sets the ``Decimal128`` value of the given field. + * - Sets the reference to a :ref:`RealmDictionary ` on the given field. + + This will copy all the elements in the dictionary into Realm, but any further changes to the dictionary will not be reflected in the Realm. Use :ref:`getDictionary(String) ` in order to get a reference to the managed dictionary. + + @@ -3347,7 +4135,9 @@ setDecimal128 - - ``value`` - value to insert. + - ``dictionary`` - dictionary of objects. Must either be primitive types or :ref:`DynamicRealmObject ` s. + + @@ -3359,7 +4149,7 @@ setDecimal128 **Throws** - - `IllegalArgumentException `__ - if field name doesn't exist or field isn't a Decimal128 field. + - `IllegalArgumentException `__ - if field name doesn't exist, it is not a dictionary field, the objects in the dictionary doesn't match the expected type or any Realm object in the dictionary belongs to a different Realm. @@ -3417,7 +4207,7 @@ setDouble :header-rows: 1 * - | public **void** :ref:`setDouble ` ( - | `String `__ fieldName, + | `String `__ fieldName, | **double** value | ) @@ -3449,7 +4239,7 @@ setDouble **Throws** - - `IllegalArgumentException `__ - if field name doesn't exist or field isn't a double field. + - `IllegalArgumentException `__ - if field name doesn't exist or field isn't a double field. @@ -3507,7 +4297,7 @@ setFloat :header-rows: 1 * - | public **void** :ref:`setFloat ` ( - | `String `__ fieldName, + | `String `__ fieldName, | **float** value | ) @@ -3539,7 +4329,7 @@ setFloat **Throws** - - `IllegalArgumentException `__ - if field name doesn't exist or field isn't a float field. + - `IllegalArgumentException `__ - if field name doesn't exist or field isn't a float field. @@ -3597,7 +4387,7 @@ setInt :header-rows: 1 * - | public **void** :ref:`setInt ` ( - | `String `__ fieldName, + | `String `__ fieldName, | **int** value | ) @@ -3629,7 +4419,7 @@ setInt **Throws** - - `IllegalArgumentException `__ - if field name doesn't exist or field isn't an integer field. + - `IllegalArgumentException `__ - if field name doesn't exist or field isn't an integer field. @@ -3719,7 +4509,7 @@ setList :header-rows: 1 * - | public **void** :ref:`setList ` <**E** >( - | `String `__ fieldName, + | `String `__ fieldName, | :ref:`io.realm.RealmList\ ` list | ) @@ -3757,7 +4547,7 @@ setList **Throws** - - `IllegalArgumentException `__ - if field name doesn't exist, it is not a list field, the objects in the list doesn't match the expected type or any Realm object in the list belongs to a different Realm. + - `IllegalArgumentException `__ - if field name doesn't exist, it is not a list field, the objects in the list doesn't match the expected type or any Realm object in the list belongs to a different Realm. @@ -3815,7 +4605,7 @@ setLong :header-rows: 1 * - | public **void** :ref:`setLong ` ( - | `String `__ fieldName, + | `String `__ fieldName, | **long** value | ) @@ -3847,7 +4637,7 @@ setLong **Throws** - - `IllegalArgumentException `__ - if field name doesn't exist or field isn't an integer field. + - `IllegalArgumentException `__ - if field name doesn't exist or field isn't an integer field. @@ -3899,7 +4689,7 @@ setNull :header-rows: 1 * - | public **void** :ref:`setNull ` ( - | `String `__ fieldName + | `String `__ fieldName | ) @@ -3926,7 +4716,7 @@ setNull **Throws** - - `IllegalArgumentException `__ - if field name doesn't exist, or the field isn't nullable. + - `IllegalArgumentException `__ - if field name doesn't exist, or the field isn't nullable. @@ -4014,7 +4804,7 @@ setObject :header-rows: 1 * - | public **void** :ref:`setObject ` ( - | `String `__ fieldName, + | `String `__ fieldName, | :ref:`DynamicRealmObject ` value | ) @@ -4044,7 +4834,7 @@ setObject **Throws** - - `IllegalArgumentException `__ - if field name doesn't exist, it doesn't link to other Realm objects, the type of DynamicRealmObject doesn't match or it belongs to a different Realm. + - `IllegalArgumentException `__ - if field name doesn't exist, it doesn't link to other Realm objects, the type of DynamicRealmObject doesn't match or it belongs to a different Realm. @@ -4102,7 +4892,7 @@ setObjectId :header-rows: 1 * - | public **void** :ref:`setObjectId ` ( - | `String `__ fieldName, + | `String `__ fieldName, | **ObjectId** value | ) @@ -4134,7 +4924,243 @@ setObjectId **Throws** - - `IllegalArgumentException `__ - if field name doesn't exist or field isn't a ObjectId field. + - `IllegalArgumentException `__ - if field name doesn't exist or field isn't a ObjectId field. + + + + + + + + + + + + +.. _setRealmAny: + +.. _setRealmAny__: + +.. _DynamicRealmObject_setRealmAny: + +.. _DynamicRealmObject_setRealmAny__: + +.. _io_realm_DynamicRealmObject_setRealmAny: + +.. _io_realm_DynamicRealmObject_setRealmAny__: + + + +setRealmAny +----------- + +.. _io_realm_DynamicRealmObject_setRealmAny_java_lang_String_io_realm_RealmAny_: + +.. _io_realm_DynamicRealmObject_setRealmAny_java_lang_String__io_realm_RealmAny_: + +.. _io_realm_DynamicRealmObject_setRealmAny_java_lang_String_RealmAny_: + +.. _io_realm_DynamicRealmObject_setRealmAny_java_lang_String__RealmAny_: + +.. _io_realm_DynamicRealmObject_setRealmAny_String_io_realm_RealmAny_: + +.. _io_realm_DynamicRealmObject_setRealmAny_String__io_realm_RealmAny_: + +.. _io_realm_DynamicRealmObject_setRealmAny_String_RealmAny_: + +.. _io_realm_DynamicRealmObject_setRealmAny_String__RealmAny_: + +.. _setRealmAny_java_lang_String_io_realm_RealmAny_: + +.. _setRealmAny_java_lang_String__io_realm_RealmAny_: + +.. _setRealmAny_java_lang_String_RealmAny_: + +.. _setRealmAny_java_lang_String__RealmAny_: + +.. _setRealmAny_String_io_realm_RealmAny_: + +.. _setRealmAny_String__io_realm_RealmAny_: + +.. _setRealmAny_String_RealmAny_: + +.. _setRealmAny_String__RealmAny_: + +.. _DynamicRealmObject_setRealmAny_java_lang_String_io_realm_RealmAny_: + +.. _DynamicRealmObject_setRealmAny_java_lang_String__io_realm_RealmAny_: + +.. _DynamicRealmObject_setRealmAny_java_lang_String_RealmAny_: + +.. _DynamicRealmObject_setRealmAny_java_lang_String__RealmAny_: + +.. _DynamicRealmObject_setRealmAny_String_io_realm_RealmAny_: + +.. _DynamicRealmObject_setRealmAny_String__io_realm_RealmAny_: + +.. _DynamicRealmObject_setRealmAny_String_RealmAny_: + +.. _DynamicRealmObject_setRealmAny_String__RealmAny_: + +.. list-table:: + :header-rows: 1 + + * - | public **void** :ref:`setRealmAny ` ( + | `String `__ fieldName, + | :ref:`RealmAny ` value + | ) + + + + + * - Sets the ``RealmAny`` value of the given field. + + + + + + + **Parameters** + + - ``fieldName`` - field name. + + + + - ``value`` - value to insert. + + + + + + + + + + **Throws** + + - `IllegalArgumentException `__ - if field name doesn't exist or field isn't a RealmAny field. + + + + + + + + + + + + +.. _setRealmSet: + +.. _setRealmSet__: + +.. _DynamicRealmObject_setRealmSet: + +.. _DynamicRealmObject_setRealmSet__: + +.. _io_realm_DynamicRealmObject_setRealmSet: + +.. _io_realm_DynamicRealmObject_setRealmSet__: + + + +setRealmSet +----------- + +.. _io_realm_DynamicRealmObject_setRealmSet_java_lang_String_io_realm_RealmSet_: + +.. _io_realm_DynamicRealmObject_setRealmSet_java_lang_String__io_realm_RealmSet_: + +.. _io_realm_DynamicRealmObject_setRealmSet_java_lang_String_RealmSet_: + +.. _io_realm_DynamicRealmObject_setRealmSet_java_lang_String__RealmSet_: + +.. _io_realm_DynamicRealmObject_setRealmSet_String_io_realm_RealmSet_: + +.. _io_realm_DynamicRealmObject_setRealmSet_String__io_realm_RealmSet_: + +.. _io_realm_DynamicRealmObject_setRealmSet_String_RealmSet_: + +.. _io_realm_DynamicRealmObject_setRealmSet_String__RealmSet_: + +.. _setRealmSet_java_lang_String_io_realm_RealmSet_: + +.. _setRealmSet_java_lang_String__io_realm_RealmSet_: + +.. _setRealmSet_java_lang_String_RealmSet_: + +.. _setRealmSet_java_lang_String__RealmSet_: + +.. _setRealmSet_String_io_realm_RealmSet_: + +.. _setRealmSet_String__io_realm_RealmSet_: + +.. _setRealmSet_String_RealmSet_: + +.. _setRealmSet_String__RealmSet_: + +.. _DynamicRealmObject_setRealmSet_java_lang_String_io_realm_RealmSet_: + +.. _DynamicRealmObject_setRealmSet_java_lang_String__io_realm_RealmSet_: + +.. _DynamicRealmObject_setRealmSet_java_lang_String_RealmSet_: + +.. _DynamicRealmObject_setRealmSet_java_lang_String__RealmSet_: + +.. _DynamicRealmObject_setRealmSet_String_io_realm_RealmSet_: + +.. _DynamicRealmObject_setRealmSet_String__io_realm_RealmSet_: + +.. _DynamicRealmObject_setRealmSet_String_RealmSet_: + +.. _DynamicRealmObject_setRealmSet_String__RealmSet_: + +.. _io_realm_DynamicRealmObject_setRealmSet_String__RealmSet_E__: + +.. list-table:: + :header-rows: 1 + + * - | public **void** :ref:`setRealmSet ` <**E** >( + | `String `__ fieldName, + | :ref:`io.realm.RealmSet\ ` set + | ) + + + + + * - Sets the reference to a :ref:`RealmSet ` on the given field. + + This will copy all the elements in the set into Realm, but any further changes to the set will not be reflected in the Realm. Use :ref:`getRealmSet(String) ` in order to get a reference to the managed set. + + + + + + + + + **Parameters** + + - ``fieldName`` - field name. + + + + - ``set`` - set of objects. Must either be primitive types or :ref:`DynamicRealmObject ` s. + + + + + + + + + + + + **Throws** + + - `IllegalArgumentException `__ - if field name doesn't exist, it is not a set field, the objects in the set doesn't match the expected type or any Realm object in the set belongs to a different Realm. @@ -4192,7 +5218,7 @@ setShort :header-rows: 1 * - | public **void** :ref:`setShort ` ( - | `String `__ fieldName, + | `String `__ fieldName, | **short** value | ) @@ -4224,7 +5250,7 @@ setShort **Throws** - - `IllegalArgumentException `__ - if field name doesn't exist or field isn't an integer field. + - `IllegalArgumentException `__ - if field name doesn't exist or field isn't an integer field. @@ -4312,8 +5338,8 @@ setString :header-rows: 1 * - | public **void** :ref:`setString ` ( - | `String `__ fieldName, - | `String `__ value + | `String `__ fieldName, + | `String `__ value | ) @@ -4344,7 +5370,7 @@ setString **Throws** - - `IllegalArgumentException `__ - if field name doesn't exist or field isn't a String field. + - `IllegalArgumentException `__ - if field name doesn't exist or field isn't a String field. @@ -4363,6 +5389,120 @@ setString +.. _setUUID: + +.. _setUUID__: + +.. _DynamicRealmObject_setUUID: + +.. _DynamicRealmObject_setUUID__: + +.. _io_realm_DynamicRealmObject_setUUID: + +.. _io_realm_DynamicRealmObject_setUUID__: + + + +setUUID +------- + +.. _io_realm_DynamicRealmObject_setUUID_java_lang_String_java_util_UUID_: + +.. _io_realm_DynamicRealmObject_setUUID_java_lang_String__java_util_UUID_: + +.. _io_realm_DynamicRealmObject_setUUID_java_lang_String_UUID_: + +.. _io_realm_DynamicRealmObject_setUUID_java_lang_String__UUID_: + +.. _io_realm_DynamicRealmObject_setUUID_String_java_util_UUID_: + +.. _io_realm_DynamicRealmObject_setUUID_String__java_util_UUID_: + +.. _io_realm_DynamicRealmObject_setUUID_String_UUID_: + +.. _io_realm_DynamicRealmObject_setUUID_String__UUID_: + +.. _setUUID_java_lang_String_java_util_UUID_: + +.. _setUUID_java_lang_String__java_util_UUID_: + +.. _setUUID_java_lang_String_UUID_: + +.. _setUUID_java_lang_String__UUID_: + +.. _setUUID_String_java_util_UUID_: + +.. _setUUID_String__java_util_UUID_: + +.. _setUUID_String_UUID_: + +.. _setUUID_String__UUID_: + +.. _DynamicRealmObject_setUUID_java_lang_String_java_util_UUID_: + +.. _DynamicRealmObject_setUUID_java_lang_String__java_util_UUID_: + +.. _DynamicRealmObject_setUUID_java_lang_String_UUID_: + +.. _DynamicRealmObject_setUUID_java_lang_String__UUID_: + +.. _DynamicRealmObject_setUUID_String_java_util_UUID_: + +.. _DynamicRealmObject_setUUID_String__java_util_UUID_: + +.. _DynamicRealmObject_setUUID_String_UUID_: + +.. _DynamicRealmObject_setUUID_String__UUID_: + +.. list-table:: + :header-rows: 1 + + * - | public **void** :ref:`setUUID ` ( + | `String `__ fieldName, + | `UUID `__ value + | ) + + + + + * - Sets the ``UUID`` value of the given field. + + + + + + + **Parameters** + + - ``fieldName`` - field name. + + + + - ``value`` - value to insert. + + + + + + + + + + **Throws** + + - `IllegalArgumentException `__ - if field name doesn't exist or field isn't a UUID field. + + + + + + + + + + + + .. _toString: .. _toString__: @@ -4383,7 +5523,7 @@ toString .. list-table:: :header-rows: 1 - * - | public `String `__ :ref:`toString ` () + * - | public `String `__ :ref:`toString ` () | @@ -4402,7 +5542,7 @@ toString **Overrides** - ``toString`` in class `Object `__ + ``toString`` in class `Object `__ diff --git a/source/sdk/java/api/io/realm/FieldAttribute.txt b/source/sdk/java/api/io/realm/FieldAttribute.txt index c4639752db..8eadabd736 100644 --- a/source/sdk/java/api/io/realm/FieldAttribute.txt +++ b/source/sdk/java/api/io/realm/FieldAttribute.txt @@ -18,8 +18,8 @@ io.realm ======== - | `java.lang.Object `__ - | `java.lang.Enum `__ + | `java.lang.Object `__ + | `java.lang.Enum `__ | io.realm.FieldAttribute @@ -71,7 +71,7 @@ Method Summary * - public static :ref:`FieldAttribute ` - | :ref:`valueOf ` ( - | `String `__ name + | `String `__ name | ) @@ -98,8 +98,8 @@ Inherited Methods -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` -- Methods inherited from class `java.lang.Enum `__ : ``name`` , ``ordinal`` , ``toString`` , ``equals`` , ``hashCode`` , ``clone`` , ``compareTo`` , ``getDeclaringClass`` , ``valueOf`` , ``finalize`` +- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` +- Methods inherited from class `java.lang.Enum `__ : ``name`` , ``ordinal`` , ``toString`` , ``equals`` , ``hashCode`` , ``clone`` , ``compareTo`` , ``getDeclaringClass`` , ``valueOf`` , ``finalize`` @@ -194,7 +194,7 @@ valueOf :header-rows: 1 * - | public static :ref:`FieldAttribute ` :ref:`valueOf ` ( - | `String `__ name + | `String `__ name | ) diff --git a/source/sdk/java/api/io/realm/FrozenPendingRow.txt b/source/sdk/java/api/io/realm/FrozenPendingRow.txt index 4a972d25d1..8d3e1f28f3 100644 --- a/source/sdk/java/api/io/realm/FrozenPendingRow.txt +++ b/source/sdk/java/api/io/realm/FrozenPendingRow.txt @@ -18,18 +18,11 @@ io.realm ======== - | `java.lang.Object `__ - | `java.lang.Enum `__ + | `java.lang.Object `__ + | `java.lang.Enum `__ | io.realm.FrozenPendingRow -**Implemented interfaces:** - - - -- **io.realm.internal.Row** - - A PendingRow that has been frozen. This behaves in many ways similar to a deleted Row, but will report :ref:`isLoaded() ` as ``as false`` . @@ -67,8 +60,6 @@ Method Summary | - Throws `IllegalStateException `__ if the row is not attached. - @@ -92,7 +83,7 @@ Method Summary | ) - Returns a frozen copy of this Row. + @@ -131,21 +122,21 @@ Method Summary * - public **long** - | :ref:`getColumnKey ` ( - | `String `__ columnName + | `String `__ columnName | ) - Returns the column key from a column name. + - * - public `String `__ + * - public `String `__ - | :ref:`getColumnNames ` () | - Returns all the column names of the tables. + @@ -156,12 +147,12 @@ Method Summary | ) - Gets the type of a column identified by the columnKey. + - * - public `Date `__ + * - public `Date `__ - | :ref:`getDate ` ( | **long** columnKey | ) @@ -238,6 +229,39 @@ Method Summary + * - public **OsMap** + - | :ref:`getModelMap ` ( + | **long** columnKey + | ) + + + + + + + + * - public **OsSet** + - | :ref:`getModelSet ` ( + | **long** columnKey + | ) + + + + + + + + * - public **NativeRealmAny** + - | :ref:`getNativeRealmAny ` ( + | **long** columnKey + | ) + + + + + + + * - public **ObjectId** - | :ref:`getObjectId ` ( | **long** columnKey @@ -254,12 +278,34 @@ Method Summary | - Returns the object key in the original source table, not the tableview. + + + + + + * - public **OsMap** + - | :ref:`getRealmAnyMap ` ( + | **long** columnKey + | ) + + + + + + + + * - public **OsSet** + - | :ref:`getRealmAnySet ` ( + | **long** columnKey + | ) + + + - * - public `String `__ + * - public `String `__ - | :ref:`getString ` ( | **long** columnKey | ) @@ -280,6 +326,17 @@ Method Summary + * - public `UUID `__ + - | :ref:`getUUID ` ( + | **long** columnKey + | ) + + + + + + + * - public **OsList** - | :ref:`getValueList ` ( | **long** columnKey, @@ -292,14 +349,36 @@ Method Summary + * - public **OsMap** + - | :ref:`getValueMap ` ( + | **long** columnKey, + | :ref:`RealmFieldType ` fieldType + | ) + + + + + + + + * - public **OsSet** + - | :ref:`getValueSet ` ( + | **long** columnKey, + | :ref:`RealmFieldType ` fieldType + | ) + + + + + + + * - public **boolean** - | :ref:`hasColumn ` ( - | `String `__ fieldName + | `String `__ fieldName | ) - Returns ``true`` if the field name exists. - @@ -310,7 +389,7 @@ Method Summary | - Return whether the row is considered to be loaded, i.e. + @@ -342,7 +421,7 @@ Method Summary | - Checks if the row is still valid. + @@ -385,7 +464,7 @@ Method Summary * - public **void** - | :ref:`setDate ` ( | **long** columnKey, - | `Date `__ date + | `Date `__ date | ) @@ -477,10 +556,34 @@ Method Summary + * - public **void** + - | :ref:`setRealmAny ` ( + | **long** columnKey, + | **long** value + | ) + + + + + + + * - public **void** - | :ref:`setString ` ( | **long** columnKey, - | `String `__ value + | `String `__ value + | ) + + + + + + + + * - public **void** + - | :ref:`setUUID ` ( + | **long** columnKey, + | `UUID `__ value | ) @@ -491,7 +594,7 @@ Method Summary * - public static :ref:`FrozenPendingRow ` - | :ref:`valueOf ` ( - | `String `__ name + | `String `__ name | ) @@ -518,8 +621,8 @@ Inherited Methods -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` -- Methods inherited from class `java.lang.Enum `__ : ``name`` , ``ordinal`` , ``toString`` , ``equals`` , ``hashCode`` , ``clone`` , ``compareTo`` , ``getDeclaringClass`` , ``valueOf`` , ``finalize`` +- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` +- Methods inherited from class `java.lang.Enum `__ : ``name`` , ``ordinal`` , ``toString`` , ``equals`` , ``hashCode`` , ``clone`` , ``compareTo`` , ``getDeclaringClass`` , ``valueOf`` , ``finalize`` @@ -573,9 +676,7 @@ checkIfAttached - * - Throws `IllegalStateException `__ if the row is not attached. - - + * - @@ -676,16 +777,10 @@ createEmbeddedObject freeze ------ -.. _io_realm_FrozenPendingRow_freeze_io_realm_internal_OsSharedRealm_: - .. _io_realm_FrozenPendingRow_freeze_OsSharedRealm_: -.. _freeze_io_realm_internal_OsSharedRealm_: - .. _freeze_OsSharedRealm_: -.. _FrozenPendingRow_freeze_io_realm_internal_OsSharedRealm_: - .. _FrozenPendingRow_freeze_OsSharedRealm_: .. list-table:: @@ -698,7 +793,7 @@ freeze - * - Returns a frozen copy of this Row. + * - @@ -887,22 +982,17 @@ getColumnKey :header-rows: 1 * - | public **long** :ref:`getColumnKey ` ( - | `String `__ columnName + | `String `__ columnName | ) - * - Returns the column key from a column name. - - - + * - - **Returns** - the column key @@ -934,22 +1024,17 @@ getColumnNames .. list-table:: :header-rows: 1 - * - | public `String `__ :ref:`getColumnNames ` () + * - | public `String `__ :ref:`getColumnNames ` () | - * - Returns all the column names of the tables. - - - + * - - **Returns** - array of column names. @@ -994,16 +1079,11 @@ getColumnType - * - Gets the type of a column identified by the columnKey. - - - + * - - **Returns** - the type of the particular column. @@ -1041,7 +1121,7 @@ getDate .. list-table:: :header-rows: 1 - * - | public `Date `__ :ref:`getDate ` ( + * - | public `Date `__ :ref:`getDate ` ( | **long** columnKey | ) @@ -1358,33 +1438,33 @@ getModelList -.. _getObjectId: +.. _getModelMap: -.. _getObjectId__: +.. _getModelMap__: -.. _FrozenPendingRow_getObjectId: +.. _FrozenPendingRow_getModelMap: -.. _FrozenPendingRow_getObjectId__: +.. _FrozenPendingRow_getModelMap__: -.. _io_realm_FrozenPendingRow_getObjectId: +.. _io_realm_FrozenPendingRow_getModelMap: -.. _io_realm_FrozenPendingRow_getObjectId__: +.. _io_realm_FrozenPendingRow_getModelMap__: -getObjectId +getModelMap ----------- -.. _io_realm_FrozenPendingRow_getObjectId_long_: +.. _io_realm_FrozenPendingRow_getModelMap_long_: -.. _getObjectId_long_: +.. _getModelMap_long_: -.. _FrozenPendingRow_getObjectId_long_: +.. _FrozenPendingRow_getModelMap_long_: .. list-table:: :header-rows: 1 - * - | public **ObjectId** :ref:`getObjectId ` ( + * - | public **OsMap** :ref:`getModelMap ` ( | **long** columnKey | ) @@ -1407,33 +1487,40 @@ getObjectId -.. _getObjectKey: +.. _getModelSet: -.. _getObjectKey__: +.. _getModelSet__: -.. _FrozenPendingRow_getObjectKey: +.. _FrozenPendingRow_getModelSet: -.. _FrozenPendingRow_getObjectKey__: +.. _FrozenPendingRow_getModelSet__: -.. _io_realm_FrozenPendingRow_getObjectKey: +.. _io_realm_FrozenPendingRow_getModelSet: -.. _io_realm_FrozenPendingRow_getObjectKey__: +.. _io_realm_FrozenPendingRow_getModelSet__: -getObjectKey ------------- +getModelSet +----------- + +.. _io_realm_FrozenPendingRow_getModelSet_long_: + +.. _getModelSet_long_: + +.. _FrozenPendingRow_getModelSet_long_: .. list-table:: :header-rows: 1 - * - | public **long** :ref:`getObjectKey ` () - | + * - | public **OsSet** :ref:`getModelSet ` ( + | **long** columnKey + | ) - * - Returns the object key in the original source table, not the tableview. + * - @@ -1449,33 +1536,33 @@ getObjectKey -.. _getString: +.. _getNativeRealmAny: -.. _getString__: +.. _getNativeRealmAny__: -.. _FrozenPendingRow_getString: +.. _FrozenPendingRow_getNativeRealmAny: -.. _FrozenPendingRow_getString__: +.. _FrozenPendingRow_getNativeRealmAny__: -.. _io_realm_FrozenPendingRow_getString: +.. _io_realm_FrozenPendingRow_getNativeRealmAny: -.. _io_realm_FrozenPendingRow_getString__: +.. _io_realm_FrozenPendingRow_getNativeRealmAny__: -getString ---------- +getNativeRealmAny +----------------- -.. _io_realm_FrozenPendingRow_getString_long_: +.. _io_realm_FrozenPendingRow_getNativeRealmAny_long_: -.. _getString_long_: +.. _getNativeRealmAny_long_: -.. _FrozenPendingRow_getString_long_: +.. _FrozenPendingRow_getNativeRealmAny_long_: .. list-table:: :header-rows: 1 - * - | public `String `__ :ref:`getString ` ( + * - | public **NativeRealmAny** :ref:`getNativeRealmAny ` ( | **long** columnKey | ) @@ -1498,28 +1585,35 @@ getString -.. _getTable: +.. _getObjectId: -.. _getTable__: +.. _getObjectId__: -.. _FrozenPendingRow_getTable: +.. _FrozenPendingRow_getObjectId: -.. _FrozenPendingRow_getTable__: +.. _FrozenPendingRow_getObjectId__: -.. _io_realm_FrozenPendingRow_getTable: +.. _io_realm_FrozenPendingRow_getObjectId: -.. _io_realm_FrozenPendingRow_getTable__: +.. _io_realm_FrozenPendingRow_getObjectId__: -getTable --------- +getObjectId +----------- + +.. _io_realm_FrozenPendingRow_getObjectId_long_: + +.. _getObjectId_long_: + +.. _FrozenPendingRow_getObjectId_long_: .. list-table:: :header-rows: 1 - * - | public **Table** :ref:`getTable ` () - | + * - | public **ObjectId** :ref:`getObjectId ` ( + | **long** columnKey + | ) @@ -1540,53 +1634,76 @@ getTable -.. _getValueList: +.. _getObjectKey: -.. _getValueList__: +.. _getObjectKey__: -.. _FrozenPendingRow_getValueList: +.. _FrozenPendingRow_getObjectKey: -.. _FrozenPendingRow_getValueList__: +.. _FrozenPendingRow_getObjectKey__: -.. _io_realm_FrozenPendingRow_getValueList: +.. _io_realm_FrozenPendingRow_getObjectKey: -.. _io_realm_FrozenPendingRow_getValueList__: +.. _io_realm_FrozenPendingRow_getObjectKey__: -getValueList +getObjectKey ------------ -.. _io_realm_FrozenPendingRow_getValueList_long_io_realm_RealmFieldType_: +.. list-table:: + :header-rows: 1 + + * - | public **long** :ref:`getObjectKey ` () + | + + + + + * - + + + + + + + + + + + + + -.. _io_realm_FrozenPendingRow_getValueList_long__io_realm_RealmFieldType_: -.. _io_realm_FrozenPendingRow_getValueList_long_RealmFieldType_: +.. _getRealmAnyMap: -.. _io_realm_FrozenPendingRow_getValueList_long__RealmFieldType_: +.. _getRealmAnyMap__: -.. _getValueList_long_io_realm_RealmFieldType_: +.. _FrozenPendingRow_getRealmAnyMap: -.. _getValueList_long__io_realm_RealmFieldType_: +.. _FrozenPendingRow_getRealmAnyMap__: -.. _getValueList_long_RealmFieldType_: +.. _io_realm_FrozenPendingRow_getRealmAnyMap: -.. _getValueList_long__RealmFieldType_: +.. _io_realm_FrozenPendingRow_getRealmAnyMap__: -.. _FrozenPendingRow_getValueList_long_io_realm_RealmFieldType_: -.. _FrozenPendingRow_getValueList_long__io_realm_RealmFieldType_: -.. _FrozenPendingRow_getValueList_long_RealmFieldType_: +getRealmAnyMap +-------------- -.. _FrozenPendingRow_getValueList_long__RealmFieldType_: +.. _io_realm_FrozenPendingRow_getRealmAnyMap_long_: + +.. _getRealmAnyMap_long_: + +.. _FrozenPendingRow_getRealmAnyMap_long_: .. list-table:: :header-rows: 1 - * - | public **OsList** :ref:`getValueList ` ( - | **long** columnKey, - | :ref:`RealmFieldType ` fieldType + * - | public **OsMap** :ref:`getRealmAnyMap ` ( + | **long** columnKey | ) @@ -1608,17 +1725,410 @@ getValueList -.. _hasColumn: +.. _getRealmAnySet: -.. _hasColumn__: +.. _getRealmAnySet__: -.. _FrozenPendingRow_hasColumn: +.. _FrozenPendingRow_getRealmAnySet: -.. _FrozenPendingRow_hasColumn__: +.. _FrozenPendingRow_getRealmAnySet__: -.. _io_realm_FrozenPendingRow_hasColumn: +.. _io_realm_FrozenPendingRow_getRealmAnySet: -.. _io_realm_FrozenPendingRow_hasColumn__: +.. _io_realm_FrozenPendingRow_getRealmAnySet__: + + + +getRealmAnySet +-------------- + +.. _io_realm_FrozenPendingRow_getRealmAnySet_long_: + +.. _getRealmAnySet_long_: + +.. _FrozenPendingRow_getRealmAnySet_long_: + +.. list-table:: + :header-rows: 1 + + * - | public **OsSet** :ref:`getRealmAnySet ` ( + | **long** columnKey + | ) + + + + + * - + + + + + + + + + + + + + + + +.. _getString: + +.. _getString__: + +.. _FrozenPendingRow_getString: + +.. _FrozenPendingRow_getString__: + +.. _io_realm_FrozenPendingRow_getString: + +.. _io_realm_FrozenPendingRow_getString__: + + + +getString +--------- + +.. _io_realm_FrozenPendingRow_getString_long_: + +.. _getString_long_: + +.. _FrozenPendingRow_getString_long_: + +.. list-table:: + :header-rows: 1 + + * - | public `String `__ :ref:`getString ` ( + | **long** columnKey + | ) + + + + + * - + + + + + + + + + + + + + + + +.. _getTable: + +.. _getTable__: + +.. _FrozenPendingRow_getTable: + +.. _FrozenPendingRow_getTable__: + +.. _io_realm_FrozenPendingRow_getTable: + +.. _io_realm_FrozenPendingRow_getTable__: + + + +getTable +-------- + +.. list-table:: + :header-rows: 1 + + * - | public **Table** :ref:`getTable ` () + | + + + + + * - + + + + + + + + + + + + + + + +.. _getUUID: + +.. _getUUID__: + +.. _FrozenPendingRow_getUUID: + +.. _FrozenPendingRow_getUUID__: + +.. _io_realm_FrozenPendingRow_getUUID: + +.. _io_realm_FrozenPendingRow_getUUID__: + + + +getUUID +------- + +.. _io_realm_FrozenPendingRow_getUUID_long_: + +.. _getUUID_long_: + +.. _FrozenPendingRow_getUUID_long_: + +.. list-table:: + :header-rows: 1 + + * - | public `UUID `__ :ref:`getUUID ` ( + | **long** columnKey + | ) + + + + + * - + + + + + + + + + + + + + + + +.. _getValueList: + +.. _getValueList__: + +.. _FrozenPendingRow_getValueList: + +.. _FrozenPendingRow_getValueList__: + +.. _io_realm_FrozenPendingRow_getValueList: + +.. _io_realm_FrozenPendingRow_getValueList__: + + + +getValueList +------------ + +.. _io_realm_FrozenPendingRow_getValueList_long_io_realm_RealmFieldType_: + +.. _io_realm_FrozenPendingRow_getValueList_long__io_realm_RealmFieldType_: + +.. _io_realm_FrozenPendingRow_getValueList_long_RealmFieldType_: + +.. _io_realm_FrozenPendingRow_getValueList_long__RealmFieldType_: + +.. _getValueList_long_io_realm_RealmFieldType_: + +.. _getValueList_long__io_realm_RealmFieldType_: + +.. _getValueList_long_RealmFieldType_: + +.. _getValueList_long__RealmFieldType_: + +.. _FrozenPendingRow_getValueList_long_io_realm_RealmFieldType_: + +.. _FrozenPendingRow_getValueList_long__io_realm_RealmFieldType_: + +.. _FrozenPendingRow_getValueList_long_RealmFieldType_: + +.. _FrozenPendingRow_getValueList_long__RealmFieldType_: + +.. list-table:: + :header-rows: 1 + + * - | public **OsList** :ref:`getValueList ` ( + | **long** columnKey, + | :ref:`RealmFieldType ` fieldType + | ) + + + + + * - + + + + + + + + + + + + + + + +.. _getValueMap: + +.. _getValueMap__: + +.. _FrozenPendingRow_getValueMap: + +.. _FrozenPendingRow_getValueMap__: + +.. _io_realm_FrozenPendingRow_getValueMap: + +.. _io_realm_FrozenPendingRow_getValueMap__: + + + +getValueMap +----------- + +.. _io_realm_FrozenPendingRow_getValueMap_long_io_realm_RealmFieldType_: + +.. _io_realm_FrozenPendingRow_getValueMap_long__io_realm_RealmFieldType_: + +.. _io_realm_FrozenPendingRow_getValueMap_long_RealmFieldType_: + +.. _io_realm_FrozenPendingRow_getValueMap_long__RealmFieldType_: + +.. _getValueMap_long_io_realm_RealmFieldType_: + +.. _getValueMap_long__io_realm_RealmFieldType_: + +.. _getValueMap_long_RealmFieldType_: + +.. _getValueMap_long__RealmFieldType_: + +.. _FrozenPendingRow_getValueMap_long_io_realm_RealmFieldType_: + +.. _FrozenPendingRow_getValueMap_long__io_realm_RealmFieldType_: + +.. _FrozenPendingRow_getValueMap_long_RealmFieldType_: + +.. _FrozenPendingRow_getValueMap_long__RealmFieldType_: + +.. list-table:: + :header-rows: 1 + + * - | public **OsMap** :ref:`getValueMap ` ( + | **long** columnKey, + | :ref:`RealmFieldType ` fieldType + | ) + + + + + * - + + + + + + + + + + + + + + + +.. _getValueSet: + +.. _getValueSet__: + +.. _FrozenPendingRow_getValueSet: + +.. _FrozenPendingRow_getValueSet__: + +.. _io_realm_FrozenPendingRow_getValueSet: + +.. _io_realm_FrozenPendingRow_getValueSet__: + + + +getValueSet +----------- + +.. _io_realm_FrozenPendingRow_getValueSet_long_io_realm_RealmFieldType_: + +.. _io_realm_FrozenPendingRow_getValueSet_long__io_realm_RealmFieldType_: + +.. _io_realm_FrozenPendingRow_getValueSet_long_RealmFieldType_: + +.. _io_realm_FrozenPendingRow_getValueSet_long__RealmFieldType_: + +.. _getValueSet_long_io_realm_RealmFieldType_: + +.. _getValueSet_long__io_realm_RealmFieldType_: + +.. _getValueSet_long_RealmFieldType_: + +.. _getValueSet_long__RealmFieldType_: + +.. _FrozenPendingRow_getValueSet_long_io_realm_RealmFieldType_: + +.. _FrozenPendingRow_getValueSet_long__io_realm_RealmFieldType_: + +.. _FrozenPendingRow_getValueSet_long_RealmFieldType_: + +.. _FrozenPendingRow_getValueSet_long__RealmFieldType_: + +.. list-table:: + :header-rows: 1 + + * - | public **OsSet** :ref:`getValueSet ` ( + | **long** columnKey, + | :ref:`RealmFieldType ` fieldType + | ) + + + + + * - + + + + + + + + + + + + + + + +.. _hasColumn: + +.. _hasColumn__: + +.. _FrozenPendingRow_hasColumn: + +.. _FrozenPendingRow_hasColumn__: + +.. _io_realm_FrozenPendingRow_hasColumn: + +.. _io_realm_FrozenPendingRow_hasColumn__: @@ -1641,24 +2151,15 @@ hasColumn :header-rows: 1 * - | public **boolean** :ref:`hasColumn ` ( - | `String `__ fieldName + | `String `__ fieldName | ) - * - Returns ``true`` if the field name exists. - - - - - - - + * - - **Returns** - ``true`` if field name exists, ``false`` otherwise. @@ -1698,7 +2199,7 @@ isLoaded - * - Return whether the row is considered to be loaded, i.e. it doesn't represent a query in flight. + * - @@ -1838,16 +2339,9 @@ isValid - * - Checks if the row is still valid. - - - - - + * - - **Returns** - ``true`` if the row is still valid and attached to the underlying data. ``false`` otherwise. @@ -2082,7 +2576,7 @@ setDate * - | public **void** :ref:`setDate ` ( | **long** columnKey, - | `Date `__ date + | `Date `__ date | ) @@ -2489,6 +2983,62 @@ setObjectId +.. _setRealmAny: + +.. _setRealmAny__: + +.. _FrozenPendingRow_setRealmAny: + +.. _FrozenPendingRow_setRealmAny__: + +.. _io_realm_FrozenPendingRow_setRealmAny: + +.. _io_realm_FrozenPendingRow_setRealmAny__: + + + +setRealmAny +----------- + +.. _io_realm_FrozenPendingRow_setRealmAny_long_long_: + +.. _io_realm_FrozenPendingRow_setRealmAny_long__long_: + +.. _setRealmAny_long_long_: + +.. _setRealmAny_long__long_: + +.. _FrozenPendingRow_setRealmAny_long_long_: + +.. _FrozenPendingRow_setRealmAny_long__long_: + +.. list-table:: + :header-rows: 1 + + * - | public **void** :ref:`setRealmAny ` ( + | **long** columnKey, + | **long** value + | ) + + + + + * - + + + + + + + + + + + + + + + .. _setString: .. _setString__: @@ -2535,7 +3085,75 @@ setString * - | public **void** :ref:`setString ` ( | **long** columnKey, - | `String `__ value + | `String `__ value + | ) + + + + + * - + + + + + + + + + + + + + + + +.. _setUUID: + +.. _setUUID__: + +.. _FrozenPendingRow_setUUID: + +.. _FrozenPendingRow_setUUID__: + +.. _io_realm_FrozenPendingRow_setUUID: + +.. _io_realm_FrozenPendingRow_setUUID__: + + + +setUUID +------- + +.. _io_realm_FrozenPendingRow_setUUID_long_java_util_UUID_: + +.. _io_realm_FrozenPendingRow_setUUID_long__java_util_UUID_: + +.. _io_realm_FrozenPendingRow_setUUID_long_UUID_: + +.. _io_realm_FrozenPendingRow_setUUID_long__UUID_: + +.. _setUUID_long_java_util_UUID_: + +.. _setUUID_long__java_util_UUID_: + +.. _setUUID_long_UUID_: + +.. _setUUID_long__UUID_: + +.. _FrozenPendingRow_setUUID_long_java_util_UUID_: + +.. _FrozenPendingRow_setUUID_long__java_util_UUID_: + +.. _FrozenPendingRow_setUUID_long_UUID_: + +.. _FrozenPendingRow_setUUID_long__UUID_: + +.. list-table:: + :header-rows: 1 + + * - | public **void** :ref:`setUUID ` ( + | **long** columnKey, + | `UUID `__ value | ) @@ -2590,7 +3208,7 @@ valueOf :header-rows: 1 * - | public static :ref:`FrozenPendingRow ` :ref:`valueOf ` ( - | `String `__ name + | `String `__ name | ) diff --git a/source/sdk/java/api/io/realm/ImportFlag.txt b/source/sdk/java/api/io/realm/ImportFlag.txt index ae9e8f49df..069222f6f8 100644 --- a/source/sdk/java/api/io/realm/ImportFlag.txt +++ b/source/sdk/java/api/io/realm/ImportFlag.txt @@ -18,8 +18,8 @@ io.realm ======== - | `java.lang.Object `__ - | `java.lang.Enum `__ + | `java.lang.Object `__ + | `java.lang.Enum `__ | io.realm.ImportFlag @@ -69,7 +69,7 @@ Method Summary * - public static :ref:`ImportFlag ` - | :ref:`valueOf ` ( - | `String `__ name + | `String `__ name | ) @@ -96,8 +96,8 @@ Inherited Methods -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` -- Methods inherited from class `java.lang.Enum `__ : ``name`` , ``ordinal`` , ``toString`` , ``equals`` , ``hashCode`` , ``clone`` , ``compareTo`` , ``getDeclaringClass`` , ``valueOf`` , ``finalize`` +- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` +- Methods inherited from class `java.lang.Enum `__ : ``name`` , ``ordinal`` , ``toString`` , ``equals`` , ``hashCode`` , ``clone`` , ``compareTo`` , ``getDeclaringClass`` , ``valueOf`` , ``finalize`` @@ -117,11 +117,11 @@ Enum Constant Detail public static final :ref:`ImportFlag ` -With this flag enabled, fields will not be written to the Realm file if they contain the same value as the value already present in the Realm.For local Realms this only has an impact on change listeners which will not report changes to those fields that was not written. +With this flag enabled, fields will not be written to the Realm file if they contain the same value as the value already present in the Realm.For local Realms this only has an impact on change listeners which will not report changes to those fields that were not written. -For synchronized Realms this also impacts the server, which will see improved performance as there is less changes to upload and merge into the server Realm. +For synchronized Realms this also impacts the server, which will see improved performance as there are fewer changes to upload and merge into the server Realm. -It also impact how the server merges changes from different devices. Realm uses a last-write-wins approach when merging individual fields in an object, so if a field is not written it will be considered "older" than other fields modified. +It also impacts how the server merges changes from different devices. Realm uses a last-write-wins approach when merging individual fields in an object, so if a field is not written it will be considered "older" than other fields modified. E.g: @@ -141,7 +141,7 @@ E.g: -This is normally the desired behaviour as the final object is the merged result of the latest changes from both devices, however if all the fields in an object are considered an atomic unit, then this flag should not be set as it will ensure that all fields are set and thus have the same "age" when data are sent to the server. +This is normally the desired behavior as the final object is the merged result of the latest changes from both devices, however if all the fields in an object are considered an atomic unit, then this flag should not be set as it will ensure that all fields are set and thus have the same "age" when data are sent to the server. @@ -182,7 +182,7 @@ valueOf :header-rows: 1 * - | public static :ref:`ImportFlag ` :ref:`valueOf ` ( - | `String `__ name + | `String `__ name | ) diff --git a/source/sdk/java/api/io/realm/MapChangeListener.txt b/source/sdk/java/api/io/realm/MapChangeListener.txt new file mode 100644 index 0000000000..efa98b2959 --- /dev/null +++ b/source/sdk/java/api/io/realm/MapChangeListener.txt @@ -0,0 +1,176 @@ + +.. contents:: On this page + :local: + :backlinks: none + :depth: 2 + :class: singlecol + + + +Interface MapChangeListener +^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. _io_realm_MapChangeListener: + + + +io.realm +======== + +:ref:`MapChangeListener ` can be registered with a :ref:`RealmMap ` to receive a notification with a :ref:`MapChangeSet ` to describe the details of what have been changed in the map since last time. + +Realm instances on a thread without an `android.os.Looper `__ cannot register a :ref:`MapChangeListener ` . + + + + + + +.. seealso:: + + + + - :ref:`RealmMap.addChangeListener(MapChangeListener) ` + + + + + + + + + +Method Summary +============== + +.. list-table:: + :header-rows: 1 + + * - Modifier and Type + - Method and Description + + * - public **void** + - | :ref:`onChange ` ( + | :ref:`io.realm.RealmMap\ ` map, + | :ref:`io.realm.MapChangeSet\ ` changes + | ) + + + This will be called when the async query is finished the first time or the collection of objects has changed. + + + + + + + +Method Detail +============= + +.. _onChange: + +.. _onChange__: + +.. _MapChangeListener_onChange: + +.. _MapChangeListener_onChange__: + +.. _io_realm_MapChangeListener_onChange: + +.. _io_realm_MapChangeListener_onChange__: + + + +onChange +-------- + +.. _io_realm_MapChangeListener_onChange_io_realm_RealmMap_io_realm_MapChangeSet_: + +.. _io_realm_MapChangeListener_onChange_io_realm_RealmMap__io_realm_MapChangeSet_: + +.. _io_realm_MapChangeListener_onChange_io_realm_RealmMap_MapChangeSet_: + +.. _io_realm_MapChangeListener_onChange_io_realm_RealmMap__MapChangeSet_: + +.. _io_realm_MapChangeListener_onChange_RealmMap_io_realm_MapChangeSet_: + +.. _io_realm_MapChangeListener_onChange_RealmMap__io_realm_MapChangeSet_: + +.. _io_realm_MapChangeListener_onChange_RealmMap_MapChangeSet_: + +.. _io_realm_MapChangeListener_onChange_RealmMap__MapChangeSet_: + +.. _onChange_io_realm_RealmMap_io_realm_MapChangeSet_: + +.. _onChange_io_realm_RealmMap__io_realm_MapChangeSet_: + +.. _onChange_io_realm_RealmMap_MapChangeSet_: + +.. _onChange_io_realm_RealmMap__MapChangeSet_: + +.. _onChange_RealmMap_io_realm_MapChangeSet_: + +.. _onChange_RealmMap__io_realm_MapChangeSet_: + +.. _onChange_RealmMap_MapChangeSet_: + +.. _onChange_RealmMap__MapChangeSet_: + +.. _MapChangeListener_onChange_io_realm_RealmMap_io_realm_MapChangeSet_: + +.. _MapChangeListener_onChange_io_realm_RealmMap__io_realm_MapChangeSet_: + +.. _MapChangeListener_onChange_io_realm_RealmMap_MapChangeSet_: + +.. _MapChangeListener_onChange_io_realm_RealmMap__MapChangeSet_: + +.. _MapChangeListener_onChange_RealmMap_io_realm_MapChangeSet_: + +.. _MapChangeListener_onChange_RealmMap__io_realm_MapChangeSet_: + +.. _MapChangeListener_onChange_RealmMap_MapChangeSet_: + +.. _MapChangeListener_onChange_RealmMap__MapChangeSet_: + +.. _io_realm_MapChangeListener_onChange_RealmMap_K__V___MapChangeSet_K__: + +.. list-table:: + :header-rows: 1 + + * - | public **void** :ref:`onChange ` ( + | :ref:`io.realm.RealmMap\ ` map, + | :ref:`io.realm.MapChangeSet\ ` changes + | ) + + + + + * - This will be called when the async query is finished the first time or the collection of objects has changed. + + + + + **Parameters** + + - ``map`` - the map this listener is registered to. + + + + - ``changes`` - object with information about the change. + + + + + + + + + + + + + + + + + diff --git a/source/sdk/java/api/io/realm/MapChangeSet.txt b/source/sdk/java/api/io/realm/MapChangeSet.txt new file mode 100644 index 0000000000..25f7639d65 --- /dev/null +++ b/source/sdk/java/api/io/realm/MapChangeSet.txt @@ -0,0 +1,270 @@ + +.. contents:: On this page + :local: + :backlinks: none + :depth: 2 + :class: singlecol + + + +Interface MapChangeSet +^^^^^^^^^^^^^^^^^^^^^^ + +.. _io_realm_MapChangeSet: + + + +io.realm +======== + +This interface describes the changes made to a map during the last update.:ref:`MapChangeSet ` is passed to the :ref:`MapChangeListener ` which is registered by :ref:`RealmMap.addChangeListener(MapChangeListener) ` . + + + + + + +Method Summary +============== + +.. list-table:: + :header-rows: 1 + + * - Modifier and Type + - Method and Description + + * - public **T** + - | :ref:`getChanges ` () + | + + + Array containing the keys that have been modified in the previous version of the map. + + + + + * - public **T** + - | :ref:`getDeletions ` () + | + + + The number of entries that have been deleted in the previous version of the map. + + + + + * - public **T** + - | :ref:`getInsertions ` () + | + + + Array containing the keys that have been inserted in the previous version of the map. + + + + + * - public **boolean** + - | :ref:`isEmpty ` () + | + + + Whether the change set is empty or not. + + + + + + + +Method Detail +============= + +.. _getChanges: + +.. _getChanges__: + +.. _MapChangeSet_getChanges: + +.. _MapChangeSet_getChanges__: + +.. _io_realm_MapChangeSet_getChanges: + +.. _io_realm_MapChangeSet_getChanges__: + + + +getChanges +---------- + +.. list-table:: + :header-rows: 1 + + * - | public **T** :ref:`getChanges ` () + | + + + + + * - Array containing the keys that have been modified in the previous version of the map. + + + + + + + **Returns** + + array with the keys that have been modified. + + + + + + + + + + + +.. _getDeletions: + +.. _getDeletions__: + +.. _MapChangeSet_getDeletions: + +.. _MapChangeSet_getDeletions__: + +.. _io_realm_MapChangeSet_getDeletions: + +.. _io_realm_MapChangeSet_getDeletions__: + + + +getDeletions +------------ + +.. list-table:: + :header-rows: 1 + + * - | public **T** :ref:`getDeletions ` () + | + + + + + * - The number of entries that have been deleted in the previous version of the map. + + + + + + + **Returns** + + array with the keys that have been deleted. + + + + + + + + + + + +.. _getInsertions: + +.. _getInsertions__: + +.. _MapChangeSet_getInsertions: + +.. _MapChangeSet_getInsertions__: + +.. _io_realm_MapChangeSet_getInsertions: + +.. _io_realm_MapChangeSet_getInsertions__: + + + +getInsertions +------------- + +.. list-table:: + :header-rows: 1 + + * - | public **T** :ref:`getInsertions ` () + | + + + + + * - Array containing the keys that have been inserted in the previous version of the map. + + + + + + + **Returns** + + array with the keys that have been inserted. + + + + + + + + + + + +.. _isEmpty: + +.. _isEmpty__: + +.. _MapChangeSet_isEmpty: + +.. _MapChangeSet_isEmpty__: + +.. _io_realm_MapChangeSet_isEmpty: + +.. _io_realm_MapChangeSet_isEmpty__: + + + +isEmpty +------- + +.. list-table:: + :header-rows: 1 + + * - | public **boolean** :ref:`isEmpty ` () + | + + + + + * - Whether the change set is empty or not. This is needed to detect whether a notification has been triggered right after subscription. + + + + + + + **Returns** + + whether the change set contains changes. + + + + + + + + + + + + diff --git a/source/sdk/java/api/io/realm/MutableRealmInteger.txt b/source/sdk/java/api/io/realm/MutableRealmInteger.txt index 32ce5b728e..bfd00fe461 100644 --- a/source/sdk/java/api/io/realm/MutableRealmInteger.txt +++ b/source/sdk/java/api/io/realm/MutableRealmInteger.txt @@ -18,7 +18,7 @@ io.realm ======== - | `java.lang.Object `__ + | `java.lang.Object `__ | io.realm.MutableRealmInteger @@ -26,11 +26,10 @@ io.realm -- `java.lang.Comparable `__ -- **io.realm.internal.ManageableObject** +- `java.lang.Comparable `__ -A ``MutableRealmInteger`` is a mutable, `Long `__ -like numeric quantity. It behaves almost exactly as a reference to a `Long `__ . More specifically: +A ``MutableRealmInteger`` is a mutable, `Long `__ -like numeric quantity. It behaves almost exactly as a reference to a `Long `__ . More specifically: @@ -39,17 +38,17 @@ A ``MutableRealmInteger`` is a mutable, `Long ` operator compares the contained `Long `__ values. ``null`` -valued ``MutableRealmInteger`` are ``.equals`` +- The :ref:`equals ` operator compares the contained `Long `__ values. ``null`` -valued ``MutableRealmInteger`` are ``.equals`` -- The :ref:`compareTo ` operator compares the contained `Long `__ values. It considers ``null`` < any non-``null`` value. +- The :ref:`compareTo ` operator compares the contained `Long `__ values. It considers ``null`` < any non-``null`` value. -- The :ref:`increment ` and :ref:`decrement ` operators throw `IllegalStateException `__ when applied to a ``null`` -valued ``MutableRealmInteger`` . +- The :ref:`increment ` and :ref:`decrement ` operators throw `IllegalStateException `__ when applied to a ``null`` -valued ``MutableRealmInteger`` . @@ -155,7 +154,7 @@ Method Summary * - public final **boolean** - | :ref:`equals ` ( - | `Object `__ o + | `Object `__ o | ) @@ -166,7 +165,7 @@ Method Summary - * - public abstract `Long `__ + * - public abstract `Long `__ - | :ref:`get ` () | @@ -240,7 +239,7 @@ Method Summary * - public abstract **void** - | :ref:`set ` ( - | `Long `__ newValue + | `Long `__ newValue | ) @@ -253,7 +252,7 @@ Method Summary * - public static :ref:`MutableRealmInteger ` - | :ref:`valueOf ` ( - | `String `__ value + | `String `__ value | ) @@ -279,7 +278,7 @@ Method Summary * - public static :ref:`MutableRealmInteger ` - | :ref:`valueOf ` ( - | `Long `__ value + | `Long `__ value | ) @@ -298,7 +297,7 @@ Inherited Methods -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` +- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` @@ -470,7 +469,7 @@ equals :header-rows: 1 * - | public final **boolean** :ref:`equals ` ( - | `Object `__ o + | `Object `__ o | ) @@ -504,7 +503,7 @@ equals **Overrides** - ``equals`` in class `Object `__ + ``equals`` in class `Object `__ @@ -531,7 +530,7 @@ get .. list-table:: :header-rows: 1 - * - | public abstract `Long `__ :ref:`get ` () + * - | public abstract `Long `__ :ref:`get ` () | @@ -606,7 +605,7 @@ hashCode **Overrides** - ``hashCode`` in class `Object `__ + ``hashCode`` in class `Object `__ @@ -840,7 +839,7 @@ set :header-rows: 1 * - | public abstract **void** :ref:`set ` ( - | `Long `__ newValue + | `Long `__ newValue | ) @@ -905,7 +904,7 @@ valueOf :header-rows: 1 * - | public static :ref:`MutableRealmInteger ` :ref:`valueOf ` ( - | `String `__ value + | `String `__ value | ) @@ -920,7 +919,7 @@ valueOf **Parameters** - - ``value`` - initial value: parsed by `Long.parseLong `__ . + - ``value`` - initial value: parsed by `Long.parseLong `__ . @@ -993,7 +992,7 @@ valueOf :header-rows: 1 * - | public static :ref:`MutableRealmInteger ` :ref:`valueOf ` ( - | `Long `__ value + | `Long `__ value | ) diff --git a/source/sdk/java/api/io/realm/ObjectChangeSet.txt b/source/sdk/java/api/io/realm/ObjectChangeSet.txt index 045f3fa9ee..41a37b8776 100644 --- a/source/sdk/java/api/io/realm/ObjectChangeSet.txt +++ b/source/sdk/java/api/io/realm/ObjectChangeSet.txt @@ -43,7 +43,7 @@ Method Summary * - Modifier and Type - Method and Description - * - public `String `__ + * - public `String `__ - | :ref:`getChangedFields ` () | @@ -65,7 +65,7 @@ Method Summary * - public **boolean** - | :ref:`isFieldChanged ` ( - | `String `__ fieldName + | `String `__ fieldName | ) @@ -100,7 +100,7 @@ getChangedFields .. list-table:: :header-rows: 1 - * - | public `String `__ :ref:`getChangedFields ` () + * - | public `String `__ :ref:`getChangedFields ` () | @@ -209,7 +209,7 @@ isFieldChanged :header-rows: 1 * - | public **boolean** :ref:`isFieldChanged ` ( - | `String `__ fieldName + | `String `__ fieldName | ) diff --git a/source/sdk/java/api/io/realm/OrderedCollectionChangeSet.txt b/source/sdk/java/api/io/realm/OrderedCollectionChangeSet.txt index ee5a5ac552..a591795ee7 100644 --- a/source/sdk/java/api/io/realm/OrderedCollectionChangeSet.txt +++ b/source/sdk/java/api/io/realm/OrderedCollectionChangeSet.txt @@ -97,7 +97,7 @@ Method Summary - * - public `Throwable `__ + * - public `Throwable `__ - | :ref:`getError ` () | @@ -359,7 +359,7 @@ getError .. list-table:: :header-rows: 1 - * - | public `Throwable `__ :ref:`getError ` () + * - | public `Throwable `__ :ref:`getError ` () | diff --git a/source/sdk/java/api/io/realm/OrderedCollectionChangeSet/Range.txt b/source/sdk/java/api/io/realm/OrderedCollectionChangeSet/Range.txt index 66a88822a5..8366cfd7aa 100644 --- a/source/sdk/java/api/io/realm/OrderedCollectionChangeSet/Range.txt +++ b/source/sdk/java/api/io/realm/OrderedCollectionChangeSet/Range.txt @@ -18,7 +18,7 @@ io.realm ======== - | `java.lang.Object `__ + | `java.lang.Object `__ | io.realm.OrderedCollectionChangeSet.Range @@ -94,7 +94,7 @@ Method Summary * - Modifier and Type - Method and Description - * - public `String `__ + * - public `String `__ - | :ref:`toString ` () | @@ -112,7 +112,7 @@ Inherited Methods -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` +- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` @@ -219,7 +219,7 @@ toString .. list-table:: :header-rows: 1 - * - | public `String `__ :ref:`toString ` () + * - | public `String `__ :ref:`toString ` () | @@ -238,7 +238,7 @@ toString **Overrides** - ``toString`` in class `Object `__ + ``toString`` in class `Object `__ diff --git a/source/sdk/java/api/io/realm/OrderedCollectionChangeSet/State.txt b/source/sdk/java/api/io/realm/OrderedCollectionChangeSet/State.txt index 8d75a55c3d..c0e7acfdfe 100644 --- a/source/sdk/java/api/io/realm/OrderedCollectionChangeSet/State.txt +++ b/source/sdk/java/api/io/realm/OrderedCollectionChangeSet/State.txt @@ -18,8 +18,8 @@ io.realm ======== - | `java.lang.Object `__ - | `java.lang.Enum `__ + | `java.lang.Object `__ + | `java.lang.Enum `__ | io.realm.OrderedCollectionChangeSet.State @@ -77,7 +77,7 @@ Method Summary * - public static :ref:`OrderedCollectionChangeSet.State ` - | :ref:`valueOf ` ( - | `String `__ name + | `String `__ name | ) @@ -104,8 +104,8 @@ Inherited Methods -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` -- Methods inherited from class `java.lang.Enum `__ : ``name`` , ``ordinal`` , ``toString`` , ``equals`` , ``hashCode`` , ``clone`` , ``compareTo`` , ``getDeclaringClass`` , ``valueOf`` , ``finalize`` +- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` +- Methods inherited from class `java.lang.Enum `__ : ``name`` , ``ordinal`` , ``toString`` , ``equals`` , ``hashCode`` , ``clone`` , ``compareTo`` , ``getDeclaringClass`` , ``valueOf`` , ``finalize`` @@ -202,7 +202,7 @@ valueOf :header-rows: 1 * - | public static :ref:`OrderedCollectionChangeSet.State ` :ref:`valueOf ` ( - | `String `__ name + | `String `__ name | ) diff --git a/source/sdk/java/api/io/realm/OrderedRealmCollection.txt b/source/sdk/java/api/io/realm/OrderedRealmCollection.txt index 92b475f12e..47a9b70620 100644 --- a/source/sdk/java/api/io/realm/OrderedRealmCollection.txt +++ b/source/sdk/java/api/io/realm/OrderedRealmCollection.txt @@ -21,13 +21,12 @@ io.realm -- `java.util.List `__ +- `java.util.List `__ - :ref:`io.realm.RealmCollection ` -- `java.util.Collection `__ -- `java.lang.Iterable `__ -- `java.util.Collection `__ -- **io.realm.internal.ManageableObject** -- `java.lang.Iterable `__ +- `java.util.Collection `__ +- `java.lang.Iterable `__ +- `java.util.Collection `__ +- `java.lang.Iterable `__ 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, ``OrderedRealmCollection`` s allow duplicate elements, as compared to Sets, where elements have to be unique. @@ -205,7 +204,7 @@ Method Summary * - public :ref:`RealmResults ` - | :ref:`sort ` ( - | `java.lang.String[] `__ fieldNames, + | `java.lang.String[] `__ fieldNames, | :ref:`io.realm.Sort[] ` sortOrders | ) @@ -217,9 +216,9 @@ Method Summary * - public :ref:`RealmResults ` - | :ref:`sort ` ( - | `String `__ fieldName1, + | `String `__ fieldName1, | :ref:`Sort ` sortOrder1, - | `String `__ fieldName2, + | `String `__ fieldName2, | :ref:`Sort ` sortOrder2 | ) @@ -231,7 +230,7 @@ Method Summary * - public :ref:`RealmResults ` - | :ref:`sort ` ( - | `String `__ fieldName, + | `String `__ fieldName, | :ref:`Sort ` sortOrder | ) @@ -243,7 +242,7 @@ Method Summary * - public :ref:`RealmResults ` - | :ref:`sort ` ( - | `String `__ fieldName + | `String `__ fieldName | ) @@ -307,11 +306,11 @@ createSnapshot **Throws** - - `java.lang.IllegalStateException `__ - if the Realm is closed or the method is called from the wrong thread. + - `java.lang.IllegalStateException `__ - if the Realm is closed or the method is called from the wrong thread. - - `UnsupportedOperationException `__ - if the collection is unmanaged. + - `UnsupportedOperationException `__ - if the collection is unmanaged. @@ -382,11 +381,11 @@ deleteFirstFromRealm **Throws** - - `java.lang.IllegalStateException `__ - if the Realm is closed or the method is called on the wrong thread. + - `java.lang.IllegalStateException `__ - if the Realm is closed or the method is called on the wrong thread. - - `UnsupportedOperationException `__ - if the collection is unmanaged. + - `UnsupportedOperationException `__ - if the collection is unmanaged. @@ -451,17 +450,17 @@ deleteFromRealm **Throws** - - `IndexOutOfBoundsException `__ - if ``location < 0 || location >= size()`` . + - `IndexOutOfBoundsException `__ - if ``location < 0 || location >= size()`` . - - `java.lang.IllegalStateException `__ - if the Realm is closed or the method is called from the wrong thread. + - `java.lang.IllegalStateException `__ - if the Realm is closed or the method is called from the wrong thread. - - `UnsupportedOperationException `__ - if the collection is unmanaged. + - `UnsupportedOperationException `__ - if the collection is unmanaged. @@ -518,11 +517,11 @@ deleteLastFromRealm **Throws** - - `java.lang.IllegalStateException `__ - if the Realm is closed or the method is called from the wrong thread. + - `java.lang.IllegalStateException `__ - if the Realm is closed or the method is called from the wrong thread. - - `UnsupportedOperationException `__ - if the collection is unmanaged. + - `UnsupportedOperationException `__ - if the collection is unmanaged. @@ -612,7 +611,7 @@ first **Throws** - - `IndexOutOfBoundsException `__ - if the collection is empty. + - `IndexOutOfBoundsException `__ - if the collection is empty. @@ -702,7 +701,7 @@ last **Throws** - - `IndexOutOfBoundsException `__ - if the collection is empty. + - `IndexOutOfBoundsException `__ - if the collection is empty. @@ -846,7 +845,7 @@ sort :header-rows: 1 * - | public :ref:`RealmResults ` :ref:`sort ` ( - | `java.lang.String[] `__ fieldNames, + | `java.lang.String[] `__ fieldNames, | :ref:`io.realm.Sort[] ` sortOrders | ) @@ -883,11 +882,11 @@ sort **Throws** - - `java.lang.IllegalArgumentException `__ - if a field name does not exist or has an invalid type. + - `java.lang.IllegalArgumentException `__ - if a field name does not exist or has an invalid type. - - `java.lang.IllegalStateException `__ - if the Realm is closed, called on the wrong thread or the collection is an unmanaged collection. + - `java.lang.IllegalStateException `__ - if the Realm is closed, called on the wrong thread or the collection is an unmanaged collection. @@ -1094,9 +1093,9 @@ sort :header-rows: 1 * - | public :ref:`RealmResults ` :ref:`sort ` ( - | `String `__ fieldName1, + | `String `__ fieldName1, | :ref:`Sort ` sortOrder1, - | `String `__ fieldName2, + | `String `__ fieldName2, | :ref:`Sort ` sortOrder2 | ) @@ -1141,11 +1140,11 @@ sort **Throws** - - `java.lang.IllegalArgumentException `__ - if a field name does not exist or has an invalid type. + - `java.lang.IllegalArgumentException `__ - if a field name does not exist or has an invalid type. - - `java.lang.IllegalStateException `__ - if the Realm is closed, called on the wrong thread or the collection is an unmanaged collection. + - `java.lang.IllegalStateException `__ - if the Realm is closed, called on the wrong thread or the collection is an unmanaged collection. @@ -1208,7 +1207,7 @@ sort :header-rows: 1 * - | public :ref:`RealmResults ` :ref:`sort ` ( - | `String `__ fieldName, + | `String `__ fieldName, | :ref:`Sort ` sortOrder | ) @@ -1245,11 +1244,11 @@ sort **Throws** - - `java.lang.IllegalArgumentException `__ - if field name does not exist or has an invalid type. + - `java.lang.IllegalArgumentException `__ - if field name does not exist or has an invalid type. - - `java.lang.IllegalStateException `__ - if the Realm is closed, called on the wrong thread or the collection is an unmanaged collection. + - `java.lang.IllegalStateException `__ - if the Realm is closed, called on the wrong thread or the collection is an unmanaged collection. @@ -1276,7 +1275,7 @@ sort :header-rows: 1 * - | public :ref:`RealmResults ` :ref:`sort ` ( - | `String `__ fieldName + | `String `__ fieldName | ) @@ -1308,11 +1307,11 @@ sort **Throws** - - `java.lang.IllegalArgumentException `__ - if field name does not exist or it has an invalid type. + - `java.lang.IllegalArgumentException `__ - if field name does not exist or it has an invalid type. - - `java.lang.IllegalStateException `__ - if the Realm is closed, called on the wrong thread or the collection is an unmanaged collection. + - `java.lang.IllegalStateException `__ - if the Realm is closed, called on the wrong thread or the collection is an unmanaged collection. diff --git a/source/sdk/java/api/io/realm/OrderedRealmCollectionChangeListener.txt b/source/sdk/java/api/io/realm/OrderedRealmCollectionChangeListener.txt index 63de72987a..d3d6a1740a 100644 --- a/source/sdk/java/api/io/realm/OrderedRealmCollectionChangeListener.txt +++ b/source/sdk/java/api/io/realm/OrderedRealmCollectionChangeListener.txt @@ -17,7 +17,7 @@ Interface OrderedRealmCollectionChangeListener io.realm ======== -:ref:`OrderedRealmCollectionChangeListener ` can be registered with a :ref:`RealmResults ` to receive a notification with a :ref:`OrderedCollectionChangeSet ` to describe the details of what have been changed in the collection from last time. +:ref:`OrderedRealmCollectionChangeListener ` can be registered with a :ref:`RealmResults ` to receive a notification with a :ref:`OrderedCollectionChangeSet ` to describe the details of what have been changed in the collection since last time. Realm instances on a thread without an `android.os.Looper `__ cannot register a :ref:`OrderedRealmCollectionChangeListener ` . diff --git a/source/sdk/java/api/io/realm/OrderedRealmCollectionSnapshot.txt b/source/sdk/java/api/io/realm/OrderedRealmCollectionSnapshot.txt index f451f1af1f..78c96304ef 100644 --- a/source/sdk/java/api/io/realm/OrderedRealmCollectionSnapshot.txt +++ b/source/sdk/java/api/io/realm/OrderedRealmCollectionSnapshot.txt @@ -18,9 +18,9 @@ io.realm ======== - | `java.lang.Object `__ - | `java.util.AbstractCollection `__ - | `java.util.AbstractList `__ + | `java.lang.Object `__ + | `java.util.AbstractCollection `__ + | `java.util.AbstractList `__ | **io.realm.OrderedRealmCollectionImpl** | io.realm.OrderedRealmCollectionSnapshot @@ -125,7 +125,7 @@ Method Summary | - Returns a frozen snapshot of this collection. + @@ -135,7 +135,7 @@ Method Summary | - Returns whether or not this object is frozen. + @@ -172,7 +172,7 @@ Method Summary * - public :ref:`RealmResults ` - | :ref:`sort ` ( - | `java.lang.String[] `__ fieldNames, + | `java.lang.String[] `__ fieldNames, | :ref:`io.realm.Sort[] ` sortOrders | ) @@ -186,9 +186,9 @@ Method Summary * - public :ref:`RealmResults ` - | :ref:`sort ` ( - | `String `__ fieldName1, + | `String `__ fieldName1, | :ref:`Sort ` sortOrder1, - | `String `__ fieldName2, + | `String `__ fieldName2, | :ref:`Sort ` sortOrder2 | ) @@ -202,7 +202,7 @@ Method Summary * - public :ref:`RealmResults ` - | :ref:`sort ` ( - | `String `__ fieldName, + | `String `__ fieldName, | :ref:`Sort ` sortOrder | ) @@ -216,7 +216,7 @@ Method Summary * - public :ref:`RealmResults ` - | :ref:`sort ` ( - | `String `__ fieldName + | `String `__ fieldName | ) @@ -247,10 +247,10 @@ Inherited Methods -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` -- Methods inherited from class `java.util.AbstractCollection `__ : ``iterator`` , ``size`` , ``isEmpty`` , ``contains`` , ``toArray`` , ``toArray`` , ``add`` , ``remove`` , ``containsAll`` , ``addAll`` , ``removeAll`` , ``retainAll`` , ``clear`` , ``toString`` -- Methods inherited from class `java.util.AbstractList `__ : ``add`` , ``get`` , ``set`` , ``add`` , ``remove`` , ``indexOf`` , ``lastIndexOf`` , ``clear`` , ``addAll`` , ``iterator`` , ``listIterator`` , ``listIterator`` , ``subList`` , ``equals`` , ``hashCode`` , ``removeRange`` -- Methods inherited from class **io.realm.OrderedRealmCollectionImpl**: ``isValid`` , ``isManaged`` , ``contains`` , ``get`` , ``first`` , ``first`` , ``last`` , ``last`` , ``deleteFromRealm`` , ``deleteAllFromRealm`` , ``iterator`` , ``listIterator`` , ``listIterator`` , ``sort`` , ``sort`` , ``sort`` , ``sort`` , ``size`` , ``min`` , ``minDate`` , ``max`` , ``maxDate`` , ``sum`` , ``average`` , ``remove`` , ``remove`` , ``removeAll`` , ``set`` , ``retainAll`` , ``deleteLastFromRealm`` , ``deleteFirstFromRealm`` , ``clear`` , ``add`` , ``add`` , ``addAll`` , ``addAll`` , ``createSnapshot`` , ``getRealm`` +- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` +- Methods inherited from class `java.util.AbstractCollection `__ : ``iterator`` , ``size`` , ``isEmpty`` , ``contains`` , ``toArray`` , ``toArray`` , ``add`` , ``remove`` , ``containsAll`` , ``addAll`` , ``removeAll`` , ``retainAll`` , ``clear`` , ``toString`` +- Methods inherited from class `java.util.AbstractList `__ : ``add`` , ``get`` , ``set`` , ``add`` , ``remove`` , ``indexOf`` , ``lastIndexOf`` , ``clear`` , ``addAll`` , ``iterator`` , ``listIterator`` , ``listIterator`` , ``subList`` , ``equals`` , ``hashCode`` , ``removeRange`` +- Methods inherited from class **io.realm.OrderedRealmCollectionImpl**: ``isValid`` , ``isManaged`` , ``contains`` , ``get`` , ``first`` , ``first`` , ``last`` , ``last`` , ``deleteFromRealm`` , ``deleteAllFromRealm`` , ``iterator`` , ``listIterator`` , ``listIterator`` , ``sort`` , ``sort`` , ``sort`` , ``sort`` , ``size`` , ``min`` , ``minDate`` , ``max`` , ``maxDate`` , ``sum`` , ``average`` , ``remove`` , ``remove`` , ``removeAll`` , ``set`` , ``retainAll`` , ``deleteLastFromRealm`` , ``deleteFirstFromRealm`` , ``clear`` , ``add`` , ``add`` , ``addAll`` , ``addAll`` , ``createSnapshot`` , ``getRealm`` , ``getCollectionOperator`` @@ -355,11 +355,11 @@ deleteAllFromRealm **Throws** - - `IllegalStateException `__ - if the corresponding Realm is closed or in an incorrect thread. + - `IllegalStateException `__ - if the corresponding Realm is closed or in an incorrect thread. - - `java.lang.IllegalStateException `__ - if the Realm has been closed or called from an incorrect thread. + - `java.lang.IllegalStateException `__ - if the Realm has been closed or called from an incorrect thread. @@ -420,7 +420,7 @@ deleteFirstFromRealm **Throws** - - `java.lang.IllegalStateException `__ - if the Realm is closed or the method is called on the wrong thread. + - `java.lang.IllegalStateException `__ - if the Realm is closed or the method is called on the wrong thread. @@ -489,13 +489,13 @@ deleteFromRealm **Throws** - - `IndexOutOfBoundsException `__ - if ``location < 0 || location >= size()`` . + - `IndexOutOfBoundsException `__ - if ``location < 0 || location >= size()`` . - - `java.lang.IllegalStateException `__ - if the Realm is closed or the method is called from the wrong thread. + - `java.lang.IllegalStateException `__ - if the Realm is closed or the method is called from the wrong thread. @@ -556,7 +556,7 @@ deleteLastFromRealm **Throws** - - `java.lang.IllegalStateException `__ - if the Realm is closed or the method is called from the wrong thread. + - `java.lang.IllegalStateException `__ - if the Realm is closed or the method is called from the wrong thread. @@ -599,15 +599,8 @@ freeze - * - Returns a frozen snapshot of this collection. The frozen copy can be read and queried from any thread without throwing an `IllegalStateException `__ . - - Freezing a collection also creates a Realm which has its own lifecycle, but if the live Realm that spawned the original collection is fully closed (i.e. all instances across all threads are closed), the frozen Realm and this collection will be closed as well. - - Frozen collections can be queried as normal, but trying to mutate it in any way or attempting to register a listener will throw an `IllegalStateException `__ . - - + * - - Note: Keeping a large number of frozen collections with different versions alive can have a negative impact on the filesize of the Realm. In order to avoid such a situation, it is possible to set :ref:`RealmConfiguration.Builder.maxNumberOfActiveVersions(long) ` . @@ -618,16 +611,6 @@ freeze - **Returns** - - a frozen copy of this collection. - - - - - - - @@ -658,19 +641,12 @@ isFrozen - * - Returns whether or not this object is frozen. - + * - - **Returns** - - ``true`` if the object is frozen, ``false`` if it is not. - - - @@ -961,7 +937,7 @@ sort :header-rows: 1 * - | public :ref:`RealmResults ` :ref:`sort ` ( - | `java.lang.String[] `__ fieldNames, + | `java.lang.String[] `__ fieldNames, | :ref:`io.realm.Sort[] ` sortOrders | ) @@ -988,7 +964,7 @@ sort **Throws** - - `UnsupportedOperationException `__ - + - `UnsupportedOperationException `__ - @@ -1199,9 +1175,9 @@ sort :header-rows: 1 * - | public :ref:`RealmResults ` :ref:`sort ` ( - | `String `__ fieldName1, + | `String `__ fieldName1, | :ref:`Sort ` sortOrder1, - | `String `__ fieldName2, + | `String `__ fieldName2, | :ref:`Sort ` sortOrder2 | ) @@ -1228,7 +1204,7 @@ sort **Throws** - - `UnsupportedOperationException `__ - + - `UnsupportedOperationException `__ - @@ -1295,7 +1271,7 @@ sort :header-rows: 1 * - | public :ref:`RealmResults ` :ref:`sort ` ( - | `String `__ fieldName, + | `String `__ fieldName, | :ref:`Sort ` sortOrder | ) @@ -1322,7 +1298,7 @@ sort **Throws** - - `UnsupportedOperationException `__ - + - `UnsupportedOperationException `__ - @@ -1353,7 +1329,7 @@ sort :header-rows: 1 * - | public :ref:`RealmResults ` :ref:`sort ` ( - | `String `__ fieldName + | `String `__ fieldName | ) @@ -1379,7 +1355,7 @@ sort **Throws** - - `UnsupportedOperationException `__ - + - `UnsupportedOperationException `__ - @@ -1440,7 +1416,7 @@ where **Throws** - - `UnsupportedOperationException `__ - + - `UnsupportedOperationException `__ - diff --git a/source/sdk/java/api/io/realm/ProxyState.txt b/source/sdk/java/api/io/realm/ProxyState.txt index bac58bc1c1..ac05c97cfb 100644 --- a/source/sdk/java/api/io/realm/ProxyState.txt +++ b/source/sdk/java/api/io/realm/ProxyState.txt @@ -18,17 +18,10 @@ io.realm ======== - | `java.lang.Object `__ + | `java.lang.Object `__ | io.realm.ProxyState -**Implemented interfaces:** - - - -- **io.realm.internal.PendingRow.FrontEnd** - - This implements ``RealmObjectProxy`` interface, to eliminate copying logic between :ref:`RealmObject ` and :ref:`DynamicRealmObject ` . @@ -105,7 +98,7 @@ Method Summary - * - public `List `__ + * - public `List `__ - | :ref:`getExcludeFields$realm ` () | @@ -220,7 +213,7 @@ Method Summary * - public **void** - | :ref:`setExcludeFields$realm ` ( - | `java.util.List\ `__ excludeFields + | `java.util.List\ `__ excludeFields | ) @@ -259,7 +252,7 @@ Inherited Methods -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` +- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` @@ -513,7 +506,7 @@ getExcludeFields$realm .. list-table:: :header-rows: 1 - * - | public `List `__ :ref:`getExcludeFields$realm ` () + * - | public `List `__ :ref:`getExcludeFields$realm ` () | @@ -762,16 +755,10 @@ load onQueryFinished --------------- -.. _io_realm_ProxyState_onQueryFinished_io_realm_internal_Row_: - .. _io_realm_ProxyState_onQueryFinished_Row_: -.. _onQueryFinished_io_realm_internal_Row_: - .. _onQueryFinished_Row_: -.. _ProxyState_onQueryFinished_io_realm_internal_Row_: - .. _ProxyState_onQueryFinished_Row_: .. list-table:: @@ -1025,7 +1012,7 @@ setExcludeFields$realm :header-rows: 1 * - | public **void** :ref:`setExcludeFields$realm ` ( - | `java.util.List\ `__ excludeFields + | `java.util.List\ `__ excludeFields | ) @@ -1119,16 +1106,10 @@ setRealm$realm setRow$realm ------------ -.. _io_realm_ProxyState_setRow_realm_io_realm_internal_Row_: - .. _io_realm_ProxyState_setRow_realm_Row_: -.. _setRow_realm_io_realm_internal_Row_: - .. _setRow_realm_Row_: -.. _ProxyState_setRow_realm_io_realm_internal_Row_: - .. _ProxyState_setRow_realm_Row_: .. list-table:: diff --git a/source/sdk/java/api/io/realm/Realm.txt b/source/sdk/java/api/io/realm/Realm.txt index 7fead957b5..19633012f8 100644 --- a/source/sdk/java/api/io/realm/Realm.txt +++ b/source/sdk/java/api/io/realm/Realm.txt @@ -18,7 +18,7 @@ io.realm ======== - | `java.lang.Object `__ + | `java.lang.Object `__ | **io.realm.BaseRealm** | io.realm.Realm @@ -27,7 +27,7 @@ The Realm class is the storage and transactional manager of your object persiste The transactions ensure that multiple instances (on multiple threads) can access the same objects in a consistent state with full ACID guarantees. -It is important to remember to call the **close()** method when done with a Realm instance. Failing to do so can lead to `java.lang.OutOfMemoryError `__ as the native resources cannot be freed. +It is important to remember to call the **close()** method when done with a Realm instance. Failing to do so can lead to `java.lang.OutOfMemoryError `__ as the native resources cannot be freed. @@ -37,7 +37,7 @@ Realm instances cannot be used across different threads. This means that you hav For the UI thread this means that opening and closing Realms should occur in either onCreate/onDestroy or onStart/onStop. -Realm instances coordinate their state across threads using the `android.os.Handler `__ mechanism. This also means that Realm instances on threads without a `android.os.Looper `__ cannot receive updates unless **refresh()** is manually called. +Realm instances coordinate their state across threads using the `android.os.Handler `__ mechanism. This also means that Realm instances on threads without an `android.os.Looper `__ cannot receive updates unless **refresh()** is manually called. @@ -132,7 +132,7 @@ Field Summary * - Modifier and Type - Field and Description - * - public static final `String `__ + * - public static final `String `__ - :ref:`DEFAULT_REALM_NAME ` @@ -219,9 +219,9 @@ Method Summary - * - public `List `__ + * - public `List `__ - | :ref:`copyFromRealm ` <**E** >( - | `java.lang.Iterable\ `__ realmObjects, + | `java.lang.Iterable\ `__ realmObjects, | **int** maxDepth | ) @@ -231,9 +231,9 @@ Method Summary - * - public `List `__ + * - public `List `__ - | :ref:`copyFromRealm ` <**E** >( - | `java.lang.Iterable\ `__ realmObjects + | `java.lang.Iterable\ `__ realmObjects | ) @@ -242,9 +242,9 @@ Method Summary - * - public `List `__ + * - public `List `__ - | :ref:`copyToRealm ` <**E** >( - | `java.lang.Iterable\ `__ objects, + | `java.lang.Iterable\ `__ objects, | :ref:`io.realm.ImportFlag[] ` flags | ) @@ -266,9 +266,9 @@ Method Summary - * - public `List `__ + * - public `List `__ - | :ref:`copyToRealmOrUpdate ` <**E** >( - | `java.lang.Iterable\ `__ objects, + | `java.lang.Iterable\ `__ objects, | :ref:`io.realm.ImportFlag[] ` flags | ) @@ -296,31 +296,7 @@ Method Summary * - public **void** - | :ref:`createAllFromJson ` <**E** >( - | `java.lang.Class\ `__ clazz, - | `InputStream `__ inputStream - | ) - - - Creates a Realm object for each object in a JSON array. - - - - - * - public **void** - - | :ref:`createAllFromJson ` <**E** >( - | `java.lang.Class\ `__ clazz, - | `String `__ json - | ) - - - Creates a Realm object for each object in a JSON array. - - - - - * - public **void** - - | :ref:`createAllFromJson ` <**E** >( - | `java.lang.Class\ `__ clazz, + | `java.lang.Class\ `__ clazz, | **JSONArray** json | ) @@ -332,9 +308,9 @@ Method Summary * - public **E** - | :ref:`createEmbeddedObject ` <**E** >( - | `java.lang.Class\ `__ clazz, + | `java.lang.Class\ `__ clazz, | :ref:`RealmModel ` parentObject, - | `String `__ parentProperty + | `String `__ parentProperty | ) @@ -345,8 +321,8 @@ Method Summary * - public **E** - | :ref:`createObject ` <**E** >( - | `java.lang.Class\ `__ clazz, - | `Object `__ primaryKeyValue + | `java.lang.Class\ `__ clazz, + | `Object `__ primaryKeyValue | ) @@ -357,7 +333,7 @@ Method Summary * - public **E** - | :ref:`createObject ` <**E** >( - | `java.lang.Class\ `__ clazz + | `java.lang.Class\ `__ clazz | ) @@ -368,31 +344,7 @@ Method Summary * - public **E** - | :ref:`createObjectFromJson ` <**E** >( - | `java.lang.Class\ `__ clazz, - | `InputStream `__ inputStream - | ) - - - Creates a Realm object pre-filled with data from a JSON object. - - - - - * - public **E** - - | :ref:`createObjectFromJson ` <**E** >( - | `java.lang.Class\ `__ clazz, - | `String `__ json - | ) - - - Creates a Realm object pre-filled with data from a JSON object. - - - - - * - public **E** - - | :ref:`createObjectFromJson ` <**E** >( - | `java.lang.Class\ `__ clazz, + | `java.lang.Class\ `__ clazz, | **JSONObject** json | ) @@ -404,31 +356,7 @@ Method Summary * - public **void** - | :ref:`createOrUpdateAllFromJson ` <**E** >( - | `java.lang.Class\ `__ clazz, - | `InputStream `__ in - | ) - - - Tries to update a list of existing objects identified by their primary key with new JSON data. - - - - - * - public **void** - - | :ref:`createOrUpdateAllFromJson ` <**E** >( - | `java.lang.Class\ `__ clazz, - | `String `__ json - | ) - - - Tries to update a list of existing objects identified by their primary key with new JSON data. - - - - - * - public **void** - - | :ref:`createOrUpdateAllFromJson ` <**E** >( - | `java.lang.Class\ `__ clazz, + | `java.lang.Class\ `__ clazz, | **JSONArray** json | ) @@ -440,31 +368,7 @@ Method Summary * - public **E** - | :ref:`createOrUpdateObjectFromJson ` <**E** >( - | `java.lang.Class\ `__ clazz, - | `InputStream `__ in - | ) - - - Tries to update an existing object defined by its primary key with new JSON data. - - - - - * - public **E** - - | :ref:`createOrUpdateObjectFromJson ` <**E** >( - | `java.lang.Class\ `__ clazz, - | `String `__ json - | ) - - - Tries to update an existing object defined by its primary key with new JSON data. - - - - - * - public **E** - - | :ref:`createOrUpdateObjectFromJson ` <**E** >( - | `java.lang.Class\ `__ clazz, + | `java.lang.Class\ `__ clazz, | **JSONObject** json | ) @@ -476,7 +380,7 @@ Method Summary * - public **void** - | :ref:`delete ` ( - | `java.lang.Class\ `__ clazz + | `java.lang.Class\ `__ clazz | ) @@ -575,7 +479,7 @@ Method Summary - * - public static `Context `__ + * - public static **Context** - | :ref:`getApplicationContext ` () | @@ -611,7 +515,7 @@ Method Summary - * - public static `Object `__ + * - public static `Object `__ - | :ref:`getDefaultModule ` () | @@ -682,8 +586,8 @@ Method Summary * - public static synchronized **void** - | :ref:`init ` ( - | `Context `__ context, - | `String `__ userAgent + | **Context** context, + | `String `__ userAgent | ) @@ -694,7 +598,7 @@ Method Summary * - public static synchronized **void** - | :ref:`init ` ( - | `Context `__ context + | **Context** context | ) @@ -716,7 +620,7 @@ Method Summary * - public **void** - | :ref:`insert ` ( - | `java.util.Collection\ `__ objects + | `java.util.Collection\ `__ objects | ) @@ -738,7 +642,7 @@ Method Summary * - public **void** - | :ref:`insertOrUpdate ` ( - | `java.util.Collection\ `__ objects + | `java.util.Collection\ `__ objects | ) @@ -828,7 +732,7 @@ Method Summary * - public :ref:`RealmQuery ` - | :ref:`where ` <**E** >( - | `java.lang.Class\ `__ clazz + | `java.lang.Class\ `__ clazz | ) @@ -845,8 +749,8 @@ Inherited Methods -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` -- Methods inherited from class **io.realm.BaseRealm**: ``setAutoRefresh`` , ``isAutoRefresh`` , ``refresh`` , ``isInTransaction`` , ``addListener`` , ``removeListener`` , ``asFlowable`` , ``removeAllListeners`` , ``writeCopyTo`` , ``writeEncryptedCopyTo`` , ``waitForChange`` , ``stopWaitForChange`` , ``beginTransaction`` , ``commitTransaction`` , ``cancelTransaction`` , ``freeze`` , ``isFrozen`` , ``getNumberOfActiveVersions`` , ``checkIfValid`` , ``checkAllowQueriesOnUiThread`` , ``checkAllowWritesOnUiThread`` , ``checkIfInTransaction`` , ``checkIfValidAndInTransaction`` , ``getPath`` , ``getConfiguration`` , ``getVersion`` , ``close`` , ``isClosed`` , ``isEmpty`` , ``getSchema`` , ``deleteAll`` , ``migrateRealm`` , ``finalize`` +- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` +- Methods inherited from class **io.realm.BaseRealm**: ``setAutoRefresh`` , ``isAutoRefresh`` , ``refresh`` , ``isInTransaction`` , ``addListener`` , ``removeListener`` , ``asFlowable`` , ``removeAllListeners`` , ``writeCopyTo`` , ``writeEncryptedCopyTo`` , ``waitForChange`` , ``stopWaitForChange`` , ``beginTransaction`` , ``commitTransaction`` , ``cancelTransaction`` , ``freeze`` , ``isFrozen`` , ``getNumberOfActiveVersions`` , ``checkIfValid`` , ``checkAllowQueriesOnUiThread`` , ``checkAllowWritesOnUiThread`` , ``checkIfInTransaction`` , ``checkIfValidAndInTransaction`` , ``getPath`` , ``getConfiguration`` , ``getVersion`` , ``close`` , ``isClosed`` , ``isEmpty`` , ``getSchema`` , ``getSubscriptions`` , ``deleteAll`` , ``migrateRealm`` , ``finalize`` @@ -945,13 +849,13 @@ addChangeListener **Throws** - - `IllegalArgumentException `__ - if the change listener is ``null`` . + - `IllegalArgumentException `__ - if the change listener is ``null`` . - - `IllegalStateException `__ - if you try to register a listener from a non-Looper or `IntentService `__ thread. + - `IllegalStateException `__ - if you try to register a listener from a non-Looper or **IntentService** thread. @@ -1260,7 +1164,7 @@ copyFromRealm **Throws** - - `IllegalArgumentException `__ - if ``maxDepth < 0`` , the RealmObject is no longer accessible or it is a :ref:`DynamicRealmObject ` . + - `IllegalArgumentException `__ - if ``maxDepth < 0`` , the RealmObject is no longer accessible or it is a :ref:`DynamicRealmObject ` . @@ -1353,7 +1257,7 @@ copyFromRealm **Throws** - - `IllegalArgumentException `__ - if the RealmObject is no longer accessible or it is a :ref:`DynamicRealmObject ` . + - `IllegalArgumentException `__ - if the RealmObject is no longer accessible or it is a :ref:`DynamicRealmObject ` . @@ -1409,8 +1313,8 @@ copyFromRealm .. list-table:: :header-rows: 1 - * - | public `List `__ :ref:`copyFromRealm ` <**E** >( - | `java.lang.Iterable\ `__ realmObjects, + * - | public `List `__ :ref:`copyFromRealm ` <**E** >( + | `java.lang.Iterable\ `__ realmObjects, | **int** maxDepth | ) @@ -1461,7 +1365,7 @@ copyFromRealm **Throws** - - `IllegalArgumentException `__ - if ``maxDepth < 0`` , the RealmObject is no longer accessible or it is a :ref:`DynamicRealmObject ` . + - `IllegalArgumentException `__ - if ``maxDepth < 0`` , the RealmObject is no longer accessible or it is a :ref:`DynamicRealmObject ` . @@ -1505,8 +1409,8 @@ copyFromRealm .. list-table:: :header-rows: 1 - * - | public `List `__ :ref:`copyFromRealm ` <**E** >( - | `java.lang.Iterable\ `__ realmObjects + * - | public `List `__ :ref:`copyFromRealm ` <**E** >( + | `java.lang.Iterable\ `__ realmObjects | ) @@ -1550,7 +1454,7 @@ copyFromRealm **Throws** - - `IllegalArgumentException `__ - if the RealmObject is no longer accessible or it is a :ref:`DynamicRealmObject ` . + - `IllegalArgumentException `__ - if the RealmObject is no longer accessible or it is a :ref:`DynamicRealmObject ` . @@ -1673,8 +1577,8 @@ copyToRealm .. list-table:: :header-rows: 1 - * - | public `List `__ :ref:`copyToRealm ` <**E** >( - | `java.lang.Iterable\ `__ objects, + * - | public `List `__ :ref:`copyToRealm ` <**E** >( + | `java.lang.Iterable\ `__ objects, | :ref:`io.realm.ImportFlag[] ` flags | ) @@ -1715,7 +1619,7 @@ copyToRealm - - `java.lang.IllegalArgumentException `__ - if any of the elements in the input collection is ``null`` . + - `java.lang.IllegalArgumentException `__ - if any of the elements in the input collection is ``null`` . @@ -1843,7 +1747,7 @@ copyToRealm **Throws** - - `java.lang.IllegalArgumentException `__ - if the object is ``null`` or it belongs to a Realm instance in a different thread. + - `java.lang.IllegalArgumentException `__ - if the object is ``null`` or it belongs to a Realm instance in a different thread. @@ -1952,8 +1856,8 @@ copyToRealmOrUpdate .. list-table:: :header-rows: 1 - * - | public `List `__ :ref:`copyToRealmOrUpdate ` <**E** >( - | `java.lang.Iterable\ `__ objects, + * - | public `List `__ :ref:`copyToRealmOrUpdate ` <**E** >( + | `java.lang.Iterable\ `__ objects, | :ref:`io.realm.ImportFlag[] ` flags | ) @@ -1992,7 +1896,7 @@ copyToRealmOrUpdate **Throws** - - `java.lang.IllegalArgumentException `__ - if RealmObject is ``null`` or doesn't have a Primary key defined. + - `java.lang.IllegalArgumentException `__ - if RealmObject is ``null`` or doesn't have a Primary key defined. @@ -2136,7 +2040,7 @@ copyToRealmOrUpdate **Throws** - - `java.lang.IllegalArgumentException `__ - if the object is ``null`` or doesn't have a Primary key defined or it belongs to a Realm instance in a different thread. + - `java.lang.IllegalArgumentException `__ - if the object is ``null`` or doesn't have a Primary key defined or it belongs to a Realm instance in a different thread. @@ -2182,70 +2086,46 @@ copyToRealmOrUpdate createAllFromJson ----------------- -.. _io_realm_Realm_createAllFromJson_java_lang_Class_java_io_InputStream_: - -.. _io_realm_Realm_createAllFromJson_java_lang_Class__java_io_InputStream_: - -.. _io_realm_Realm_createAllFromJson_java_lang_Class_InputStream_: - -.. _io_realm_Realm_createAllFromJson_java_lang_Class__InputStream_: - -.. _io_realm_Realm_createAllFromJson_Class_java_io_InputStream_: - -.. _io_realm_Realm_createAllFromJson_Class__java_io_InputStream_: - -.. _io_realm_Realm_createAllFromJson_Class_InputStream_: - -.. _io_realm_Realm_createAllFromJson_Class__InputStream_: - -.. _createAllFromJson_java_lang_Class_java_io_InputStream_: - -.. _createAllFromJson_java_lang_Class__java_io_InputStream_: - -.. _createAllFromJson_java_lang_Class_InputStream_: - -.. _createAllFromJson_java_lang_Class__InputStream_: - -.. _createAllFromJson_Class_java_io_InputStream_: +.. _io_realm_Realm_createAllFromJson_java_lang_Class_JSONArray_: -.. _createAllFromJson_Class__java_io_InputStream_: +.. _io_realm_Realm_createAllFromJson_java_lang_Class__JSONArray_: -.. _createAllFromJson_Class_InputStream_: +.. _io_realm_Realm_createAllFromJson_Class_JSONArray_: -.. _createAllFromJson_Class__InputStream_: +.. _io_realm_Realm_createAllFromJson_Class__JSONArray_: -.. _Realm_createAllFromJson_java_lang_Class_java_io_InputStream_: +.. _createAllFromJson_java_lang_Class_JSONArray_: -.. _Realm_createAllFromJson_java_lang_Class__java_io_InputStream_: +.. _createAllFromJson_java_lang_Class__JSONArray_: -.. _Realm_createAllFromJson_java_lang_Class_InputStream_: +.. _createAllFromJson_Class_JSONArray_: -.. _Realm_createAllFromJson_java_lang_Class__InputStream_: +.. _createAllFromJson_Class__JSONArray_: -.. _Realm_createAllFromJson_Class_java_io_InputStream_: +.. _Realm_createAllFromJson_java_lang_Class_JSONArray_: -.. _Realm_createAllFromJson_Class__java_io_InputStream_: +.. _Realm_createAllFromJson_java_lang_Class__JSONArray_: -.. _Realm_createAllFromJson_Class_InputStream_: +.. _Realm_createAllFromJson_Class_JSONArray_: -.. _Realm_createAllFromJson_Class__InputStream_: +.. _Realm_createAllFromJson_Class__JSONArray_: -.. _io_realm_Realm_createAllFromJson_Class_E___InputStream_: +.. _io_realm_Realm_createAllFromJson_Class_E___JSONArray_: .. list-table:: :header-rows: 1 * - | public **void** :ref:`createAllFromJson ` <**E** >( - | `java.lang.Class\ `__ clazz, - | `InputStream `__ inputStream + | `java.lang.Class\ `__ clazz, + | **JSONArray** json | ) - * - Creates a Realm object for each object in a JSON array. This must be done within a transaction. JSON properties with unknown properties will be ignored. If a :ref:`RealmObject ` field is not present in the JSON object the :ref:`RealmObject ` field will be set to the default value for that type. + * - Creates a Realm object for each object in a JSON array. This must be done within a transaction.JSON properties with unknown properties will be ignored. If a :ref:`RealmObject ` field is not present in the JSON object the :ref:`RealmObject ` field will be set to the default value for that type. + - This API is only available in API level 11 or later. This method currently does not support value list field. @@ -2256,11 +2136,11 @@ createAllFromJson **Parameters** - - ``clazz`` - type of Realm objects created. + - ``clazz`` - type of Realm objects to create. - - ``inputStream`` - the JSON array as a InputStream. All objects in the array must be of the specified class. + - ``json`` - an array where each JSONObject must map to the specified class. @@ -2276,13 +2156,15 @@ createAllFromJson - - `IllegalArgumentException `__ - if the JSON object doesn't have a primary key property but the corresponding :ref:`RealmObjectSchema ` has a :ref:`io.realm.annotations.PrimaryKey ` defined. + - `IllegalArgumentException `__ - if the JSON object doesn't have a primary key property but the corresponding :ref:`RealmObjectSchema ` has a :ref:`io.realm.annotations.PrimaryKey ` defined. + + + - `UnsupportedOperationException `__ - if the object to insert contains a :ref:`RealmDictionary ` or a :ref:`RealmSet ` . - - `IOException `__ - if something was wrong with the input stream. @@ -2291,72 +2173,160 @@ createAllFromJson + + .. seealso:: + + + + - :ref:`RealmSet ` + + + + - :ref:`RealmDictionary ` + + + + - :ref:`RealmMap ` + + + + + + + + -.. _io_realm_Realm_createAllFromJson_java_lang_Class_java_lang_String_: -.. _io_realm_Realm_createAllFromJson_java_lang_Class__java_lang_String_: -.. _io_realm_Realm_createAllFromJson_java_lang_Class_String_: +.. _createEmbeddedObject: + +.. _createEmbeddedObject__: + +.. _Realm_createEmbeddedObject: + +.. _Realm_createEmbeddedObject__: + +.. _io_realm_Realm_createEmbeddedObject: + +.. _io_realm_Realm_createEmbeddedObject__: + + + +createEmbeddedObject +-------------------- + +.. _io_realm_Realm_createEmbeddedObject_java_lang_Class_io_realm_RealmModel_java_lang_String_: + +.. _io_realm_Realm_createEmbeddedObject_java_lang_Class__io_realm_RealmModel__java_lang_String_: + +.. _io_realm_Realm_createEmbeddedObject_java_lang_Class_io_realm_RealmModel_String_: + +.. _io_realm_Realm_createEmbeddedObject_java_lang_Class__io_realm_RealmModel__String_: + +.. _io_realm_Realm_createEmbeddedObject_java_lang_Class_RealmModel_java_lang_String_: + +.. _io_realm_Realm_createEmbeddedObject_java_lang_Class__RealmModel__java_lang_String_: + +.. _io_realm_Realm_createEmbeddedObject_java_lang_Class_RealmModel_String_: + +.. _io_realm_Realm_createEmbeddedObject_java_lang_Class__RealmModel__String_: + +.. _io_realm_Realm_createEmbeddedObject_Class_io_realm_RealmModel_java_lang_String_: + +.. _io_realm_Realm_createEmbeddedObject_Class__io_realm_RealmModel__java_lang_String_: + +.. _io_realm_Realm_createEmbeddedObject_Class_io_realm_RealmModel_String_: + +.. _io_realm_Realm_createEmbeddedObject_Class__io_realm_RealmModel__String_: + +.. _io_realm_Realm_createEmbeddedObject_Class_RealmModel_java_lang_String_: + +.. _io_realm_Realm_createEmbeddedObject_Class__RealmModel__java_lang_String_: + +.. _io_realm_Realm_createEmbeddedObject_Class_RealmModel_String_: + +.. _io_realm_Realm_createEmbeddedObject_Class__RealmModel__String_: + +.. _createEmbeddedObject_java_lang_Class_io_realm_RealmModel_java_lang_String_: + +.. _createEmbeddedObject_java_lang_Class__io_realm_RealmModel__java_lang_String_: + +.. _createEmbeddedObject_java_lang_Class_io_realm_RealmModel_String_: + +.. _createEmbeddedObject_java_lang_Class__io_realm_RealmModel__String_: + +.. _createEmbeddedObject_java_lang_Class_RealmModel_java_lang_String_: + +.. _createEmbeddedObject_java_lang_Class__RealmModel__java_lang_String_: + +.. _createEmbeddedObject_java_lang_Class_RealmModel_String_: + +.. _createEmbeddedObject_java_lang_Class__RealmModel__String_: + +.. _createEmbeddedObject_Class_io_realm_RealmModel_java_lang_String_: + +.. _createEmbeddedObject_Class__io_realm_RealmModel__java_lang_String_: + +.. _createEmbeddedObject_Class_io_realm_RealmModel_String_: -.. _io_realm_Realm_createAllFromJson_java_lang_Class__String_: +.. _createEmbeddedObject_Class__io_realm_RealmModel__String_: -.. _io_realm_Realm_createAllFromJson_Class_java_lang_String_: +.. _createEmbeddedObject_Class_RealmModel_java_lang_String_: -.. _io_realm_Realm_createAllFromJson_Class__java_lang_String_: +.. _createEmbeddedObject_Class__RealmModel__java_lang_String_: -.. _io_realm_Realm_createAllFromJson_Class_String_: +.. _createEmbeddedObject_Class_RealmModel_String_: -.. _io_realm_Realm_createAllFromJson_Class__String_: +.. _createEmbeddedObject_Class__RealmModel__String_: -.. _createAllFromJson_java_lang_Class_java_lang_String_: +.. _Realm_createEmbeddedObject_java_lang_Class_io_realm_RealmModel_java_lang_String_: -.. _createAllFromJson_java_lang_Class__java_lang_String_: +.. _Realm_createEmbeddedObject_java_lang_Class__io_realm_RealmModel__java_lang_String_: -.. _createAllFromJson_java_lang_Class_String_: +.. _Realm_createEmbeddedObject_java_lang_Class_io_realm_RealmModel_String_: -.. _createAllFromJson_java_lang_Class__String_: +.. _Realm_createEmbeddedObject_java_lang_Class__io_realm_RealmModel__String_: -.. _createAllFromJson_Class_java_lang_String_: +.. _Realm_createEmbeddedObject_java_lang_Class_RealmModel_java_lang_String_: -.. _createAllFromJson_Class__java_lang_String_: +.. _Realm_createEmbeddedObject_java_lang_Class__RealmModel__java_lang_String_: -.. _createAllFromJson_Class_String_: +.. _Realm_createEmbeddedObject_java_lang_Class_RealmModel_String_: -.. _createAllFromJson_Class__String_: +.. _Realm_createEmbeddedObject_java_lang_Class__RealmModel__String_: -.. _Realm_createAllFromJson_java_lang_Class_java_lang_String_: +.. _Realm_createEmbeddedObject_Class_io_realm_RealmModel_java_lang_String_: -.. _Realm_createAllFromJson_java_lang_Class__java_lang_String_: +.. _Realm_createEmbeddedObject_Class__io_realm_RealmModel__java_lang_String_: -.. _Realm_createAllFromJson_java_lang_Class_String_: +.. _Realm_createEmbeddedObject_Class_io_realm_RealmModel_String_: -.. _Realm_createAllFromJson_java_lang_Class__String_: +.. _Realm_createEmbeddedObject_Class__io_realm_RealmModel__String_: -.. _Realm_createAllFromJson_Class_java_lang_String_: +.. _Realm_createEmbeddedObject_Class_RealmModel_java_lang_String_: -.. _Realm_createAllFromJson_Class__java_lang_String_: +.. _Realm_createEmbeddedObject_Class__RealmModel__java_lang_String_: -.. _Realm_createAllFromJson_Class_String_: +.. _Realm_createEmbeddedObject_Class_RealmModel_String_: -.. _Realm_createAllFromJson_Class__String_: +.. _Realm_createEmbeddedObject_Class__RealmModel__String_: -.. _io_realm_Realm_createAllFromJson_Class_E___String_: +.. _io_realm_Realm_createEmbeddedObject_Class_E___RealmModel__String_: .. list-table:: :header-rows: 1 - * - | public **void** :ref:`createAllFromJson ` <**E** >( - | `java.lang.Class\ `__ clazz, - | `String `__ json + * - | public **E** :ref:`createEmbeddedObject ` <**E** >( + | `java.lang.Class\ `__ clazz, + | :ref:`RealmModel ` parentObject, + | `String `__ parentProperty | ) - * - Creates a Realm object for each object in a JSON array. This must be done within a transaction. JSON properties with unknown properties will be ignored. If a :ref:`RealmObject ` field is not present in the JSON object the :ref:`RealmObject ` field will be set to the default value for that type. - - This method currently does not support value list field. + * - Instantiates and adds a new embedded object to the Realm.This method should only be used to create objects of types marked as embedded. @@ -2365,11 +2335,17 @@ createAllFromJson **Parameters** - - ``clazz`` - type of Realm objects to create. + - ``clazz`` - the Class of the object to create. It must be marked with ``@RealmClass(embedded = true)`` . + - - ``json`` - the JSON array as a String where each object can map to the specified class. + + - ``parentObject`` - The parent object which should hold a reference to the embedded object. + + + + - ``parentProperty`` - the property in the parent class which holds the reference. If the parent property is a list the embedded object will be added to the end of that list. @@ -2377,300 +2353,16 @@ createAllFromJson + **Returns** + + the newly created embedded object. + + **Throws** - - :ref:`RealmException ` - if mapping from JSON fails. - - - - - `IllegalArgumentException `__ - if the JSON object doesn't have a primary key property but the corresponding :ref:`RealmObjectSchema ` has a :ref:`io.realm.annotations.PrimaryKey ` defined. - - - - - - - - - - - - -.. _io_realm_Realm_createAllFromJson_java_lang_Class_org_json_JSONArray_: - -.. _io_realm_Realm_createAllFromJson_java_lang_Class__org_json_JSONArray_: - -.. _io_realm_Realm_createAllFromJson_java_lang_Class_JSONArray_: - -.. _io_realm_Realm_createAllFromJson_java_lang_Class__JSONArray_: - -.. _io_realm_Realm_createAllFromJson_Class_org_json_JSONArray_: - -.. _io_realm_Realm_createAllFromJson_Class__org_json_JSONArray_: - -.. _io_realm_Realm_createAllFromJson_Class_JSONArray_: - -.. _io_realm_Realm_createAllFromJson_Class__JSONArray_: - -.. _createAllFromJson_java_lang_Class_org_json_JSONArray_: - -.. _createAllFromJson_java_lang_Class__org_json_JSONArray_: - -.. _createAllFromJson_java_lang_Class_JSONArray_: - -.. _createAllFromJson_java_lang_Class__JSONArray_: - -.. _createAllFromJson_Class_org_json_JSONArray_: - -.. _createAllFromJson_Class__org_json_JSONArray_: - -.. _createAllFromJson_Class_JSONArray_: - -.. _createAllFromJson_Class__JSONArray_: - -.. _Realm_createAllFromJson_java_lang_Class_org_json_JSONArray_: - -.. _Realm_createAllFromJson_java_lang_Class__org_json_JSONArray_: - -.. _Realm_createAllFromJson_java_lang_Class_JSONArray_: - -.. _Realm_createAllFromJson_java_lang_Class__JSONArray_: - -.. _Realm_createAllFromJson_Class_org_json_JSONArray_: - -.. _Realm_createAllFromJson_Class__org_json_JSONArray_: - -.. _Realm_createAllFromJson_Class_JSONArray_: - -.. _Realm_createAllFromJson_Class__JSONArray_: - -.. _io_realm_Realm_createAllFromJson_Class_E___JSONArray_: - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`createAllFromJson ` <**E** >( - | `java.lang.Class\ `__ clazz, - | **JSONArray** json - | ) - - - - - * - Creates a Realm object for each object in a JSON array. This must be done within a transaction.JSON properties with unknown properties will be ignored. If a :ref:`RealmObject ` field is not present in the JSON object the :ref:`RealmObject ` field will be set to the default value for that type. - - - - This method currently does not support value list field. - - - - - - - **Parameters** - - - ``clazz`` - type of Realm objects to create. - - - - - ``json`` - an array where each JSONObject must map to the specified class. - - - - - - - - - - **Throws** - - - :ref:`RealmException ` - if mapping from JSON fails. - - - - - `IllegalArgumentException `__ - if the JSON object doesn't have a primary key property but the corresponding :ref:`RealmObjectSchema ` has a :ref:`io.realm.annotations.PrimaryKey ` defined. - - - - - - - - - - - - - - -.. _createEmbeddedObject: - -.. _createEmbeddedObject__: - -.. _Realm_createEmbeddedObject: - -.. _Realm_createEmbeddedObject__: - -.. _io_realm_Realm_createEmbeddedObject: - -.. _io_realm_Realm_createEmbeddedObject__: - - - -createEmbeddedObject --------------------- - -.. _io_realm_Realm_createEmbeddedObject_java_lang_Class_io_realm_RealmModel_java_lang_String_: - -.. _io_realm_Realm_createEmbeddedObject_java_lang_Class__io_realm_RealmModel__java_lang_String_: - -.. _io_realm_Realm_createEmbeddedObject_java_lang_Class_io_realm_RealmModel_String_: - -.. _io_realm_Realm_createEmbeddedObject_java_lang_Class__io_realm_RealmModel__String_: - -.. _io_realm_Realm_createEmbeddedObject_java_lang_Class_RealmModel_java_lang_String_: - -.. _io_realm_Realm_createEmbeddedObject_java_lang_Class__RealmModel__java_lang_String_: - -.. _io_realm_Realm_createEmbeddedObject_java_lang_Class_RealmModel_String_: - -.. _io_realm_Realm_createEmbeddedObject_java_lang_Class__RealmModel__String_: - -.. _io_realm_Realm_createEmbeddedObject_Class_io_realm_RealmModel_java_lang_String_: - -.. _io_realm_Realm_createEmbeddedObject_Class__io_realm_RealmModel__java_lang_String_: - -.. _io_realm_Realm_createEmbeddedObject_Class_io_realm_RealmModel_String_: - -.. _io_realm_Realm_createEmbeddedObject_Class__io_realm_RealmModel__String_: - -.. _io_realm_Realm_createEmbeddedObject_Class_RealmModel_java_lang_String_: - -.. _io_realm_Realm_createEmbeddedObject_Class__RealmModel__java_lang_String_: - -.. _io_realm_Realm_createEmbeddedObject_Class_RealmModel_String_: - -.. _io_realm_Realm_createEmbeddedObject_Class__RealmModel__String_: - -.. _createEmbeddedObject_java_lang_Class_io_realm_RealmModel_java_lang_String_: - -.. _createEmbeddedObject_java_lang_Class__io_realm_RealmModel__java_lang_String_: - -.. _createEmbeddedObject_java_lang_Class_io_realm_RealmModel_String_: - -.. _createEmbeddedObject_java_lang_Class__io_realm_RealmModel__String_: - -.. _createEmbeddedObject_java_lang_Class_RealmModel_java_lang_String_: - -.. _createEmbeddedObject_java_lang_Class__RealmModel__java_lang_String_: - -.. _createEmbeddedObject_java_lang_Class_RealmModel_String_: - -.. _createEmbeddedObject_java_lang_Class__RealmModel__String_: - -.. _createEmbeddedObject_Class_io_realm_RealmModel_java_lang_String_: - -.. _createEmbeddedObject_Class__io_realm_RealmModel__java_lang_String_: - -.. _createEmbeddedObject_Class_io_realm_RealmModel_String_: - -.. _createEmbeddedObject_Class__io_realm_RealmModel__String_: - -.. _createEmbeddedObject_Class_RealmModel_java_lang_String_: - -.. _createEmbeddedObject_Class__RealmModel__java_lang_String_: - -.. _createEmbeddedObject_Class_RealmModel_String_: - -.. _createEmbeddedObject_Class__RealmModel__String_: - -.. _Realm_createEmbeddedObject_java_lang_Class_io_realm_RealmModel_java_lang_String_: - -.. _Realm_createEmbeddedObject_java_lang_Class__io_realm_RealmModel__java_lang_String_: - -.. _Realm_createEmbeddedObject_java_lang_Class_io_realm_RealmModel_String_: - -.. _Realm_createEmbeddedObject_java_lang_Class__io_realm_RealmModel__String_: - -.. _Realm_createEmbeddedObject_java_lang_Class_RealmModel_java_lang_String_: - -.. _Realm_createEmbeddedObject_java_lang_Class__RealmModel__java_lang_String_: - -.. _Realm_createEmbeddedObject_java_lang_Class_RealmModel_String_: - -.. _Realm_createEmbeddedObject_java_lang_Class__RealmModel__String_: - -.. _Realm_createEmbeddedObject_Class_io_realm_RealmModel_java_lang_String_: - -.. _Realm_createEmbeddedObject_Class__io_realm_RealmModel__java_lang_String_: - -.. _Realm_createEmbeddedObject_Class_io_realm_RealmModel_String_: - -.. _Realm_createEmbeddedObject_Class__io_realm_RealmModel__String_: - -.. _Realm_createEmbeddedObject_Class_RealmModel_java_lang_String_: - -.. _Realm_createEmbeddedObject_Class__RealmModel__java_lang_String_: - -.. _Realm_createEmbeddedObject_Class_RealmModel_String_: - -.. _Realm_createEmbeddedObject_Class__RealmModel__String_: - -.. _io_realm_Realm_createEmbeddedObject_Class_E___RealmModel__String_: - -.. list-table:: - :header-rows: 1 - - * - | public **E** :ref:`createEmbeddedObject ` <**E** >( - | `java.lang.Class\ `__ clazz, - | :ref:`RealmModel ` parentObject, - | `String `__ parentProperty - | ) - - - - - * - Instantiates and adds a new embedded object to the Realm.This method should only be used to create objects of types marked as embedded. - - - - - - - **Parameters** - - - ``clazz`` - the Class of the object to create. It must be marked with ``@RealmClass(embedded = true)`` . - - - - - - - ``parentObject`` - The parent object which should hold a reference to the embedded object. If the parent property is a list the embedded object will be added to the end of that list. - - - - - ``parentProperty`` - the property in the parent class which holds the reference. - - - - - - - - **Returns** - - the newly created embedded object. - - - - - **Throws** - - - `IllegalArgumentException `__ - if ``clazz`` is not an embedded class or if the property in the parent class cannot hold objects of the appropriate type. + - `IllegalArgumentException `__ - if ``clazz`` is not an embedded class or if the property in the parent class cannot hold objects of the appropriate type. @@ -2770,8 +2462,8 @@ createObject :header-rows: 1 * - | public **E** :ref:`createObject ` <**E** >( - | `java.lang.Class\ `__ clazz, - | `Object `__ primaryKeyValue + | `java.lang.Class\ `__ clazz, + | `Object `__ primaryKeyValue | ) @@ -2813,11 +2505,11 @@ createObject - - `IllegalStateException `__ - if the model class does not have an primary key defined. + - `IllegalStateException `__ - if the model class does not have an primary key defined. - - `IllegalArgumentException `__ - if the ``primaryKeyValue`` doesn't have a value that can be converted to the expected value. + - `IllegalArgumentException `__ - if the ``primaryKeyValue`` doesn't have a value that can be converted to the expected value. @@ -2848,7 +2540,7 @@ createObject :header-rows: 1 * - | public **E** :ref:`createObject ` <**E** >( - | `java.lang.Class\ `__ clazz + | `java.lang.Class\ `__ clazz | ) @@ -2856,771 +2548,7 @@ createObject * - Instantiates and adds a new object to the Realm.This method is only available for model classes with no @PrimaryKey annotation. If you like to create an object that has a primary key, use :ref:`createObject(Class, Object) ` or :ref:`copyToRealm(RealmModel, ImportFlag...) ` instead. - - - - - - - - **Parameters** - - - ``clazz`` - the Class of the object to create. - - - - - - - - **Returns** - - the new object. - - - - - **Throws** - - - :ref:`RealmException ` - if the primary key is defined in the model class or an object cannot be created. - - - - - - - - - - .. seealso:: - - - - - :ref:`createObject(Class, Object) ` - - - - - - - - - - - - -.. _createObjectFromJson: - -.. _createObjectFromJson__: - -.. _Realm_createObjectFromJson: - -.. _Realm_createObjectFromJson__: - -.. _io_realm_Realm_createObjectFromJson: - -.. _io_realm_Realm_createObjectFromJson__: - - - -createObjectFromJson --------------------- - -.. _io_realm_Realm_createObjectFromJson_java_lang_Class_java_io_InputStream_: - -.. _io_realm_Realm_createObjectFromJson_java_lang_Class__java_io_InputStream_: - -.. _io_realm_Realm_createObjectFromJson_java_lang_Class_InputStream_: - -.. _io_realm_Realm_createObjectFromJson_java_lang_Class__InputStream_: - -.. _io_realm_Realm_createObjectFromJson_Class_java_io_InputStream_: - -.. _io_realm_Realm_createObjectFromJson_Class__java_io_InputStream_: - -.. _io_realm_Realm_createObjectFromJson_Class_InputStream_: - -.. _io_realm_Realm_createObjectFromJson_Class__InputStream_: - -.. _createObjectFromJson_java_lang_Class_java_io_InputStream_: - -.. _createObjectFromJson_java_lang_Class__java_io_InputStream_: - -.. _createObjectFromJson_java_lang_Class_InputStream_: - -.. _createObjectFromJson_java_lang_Class__InputStream_: - -.. _createObjectFromJson_Class_java_io_InputStream_: - -.. _createObjectFromJson_Class__java_io_InputStream_: - -.. _createObjectFromJson_Class_InputStream_: - -.. _createObjectFromJson_Class__InputStream_: - -.. _Realm_createObjectFromJson_java_lang_Class_java_io_InputStream_: - -.. _Realm_createObjectFromJson_java_lang_Class__java_io_InputStream_: - -.. _Realm_createObjectFromJson_java_lang_Class_InputStream_: - -.. _Realm_createObjectFromJson_java_lang_Class__InputStream_: - -.. _Realm_createObjectFromJson_Class_java_io_InputStream_: - -.. _Realm_createObjectFromJson_Class__java_io_InputStream_: - -.. _Realm_createObjectFromJson_Class_InputStream_: - -.. _Realm_createObjectFromJson_Class__InputStream_: - -.. _io_realm_Realm_createObjectFromJson_Class_E___InputStream_: - -.. list-table:: - :header-rows: 1 - - * - | public **E** :ref:`createObjectFromJson ` <**E** >( - | `java.lang.Class\ `__ clazz, - | `InputStream `__ inputStream - | ) - - - - - * - Creates a Realm object pre-filled with data from a JSON object. This must be done inside a transaction. JSON properties with unknown properties will be ignored. If a :ref:`RealmObject ` field is not present in the JSON object the :ref:`RealmObject ` field will be set to the default value for that type. - - This API is only available in API level 11 or later. - - This method currently does not support value list field. - - - - - - - **Parameters** - - - ``clazz`` - type of Realm object to create. - - - - - ``inputStream`` - the JSON object data as a InputStream. - - - - - - - - **Returns** - - created object or ``null`` if JSON string was empty or null. - - - - - - - **Throws** - - - :ref:`RealmException ` - if the mapping from JSON failed. - - - - - `IllegalArgumentException `__ - if the JSON object doesn't have a primary key property but the corresponding :ref:`RealmObjectSchema ` has a :ref:`io.realm.annotations.PrimaryKey ` defined. - - - - - - - `IOException `__ - if something went wrong with the input stream. - - - - - - - - - - -.. _io_realm_Realm_createObjectFromJson_java_lang_Class_java_lang_String_: - -.. _io_realm_Realm_createObjectFromJson_java_lang_Class__java_lang_String_: - -.. _io_realm_Realm_createObjectFromJson_java_lang_Class_String_: - -.. _io_realm_Realm_createObjectFromJson_java_lang_Class__String_: - -.. _io_realm_Realm_createObjectFromJson_Class_java_lang_String_: - -.. _io_realm_Realm_createObjectFromJson_Class__java_lang_String_: - -.. _io_realm_Realm_createObjectFromJson_Class_String_: - -.. _io_realm_Realm_createObjectFromJson_Class__String_: - -.. _createObjectFromJson_java_lang_Class_java_lang_String_: - -.. _createObjectFromJson_java_lang_Class__java_lang_String_: - -.. _createObjectFromJson_java_lang_Class_String_: - -.. _createObjectFromJson_java_lang_Class__String_: - -.. _createObjectFromJson_Class_java_lang_String_: - -.. _createObjectFromJson_Class__java_lang_String_: - -.. _createObjectFromJson_Class_String_: - -.. _createObjectFromJson_Class__String_: - -.. _Realm_createObjectFromJson_java_lang_Class_java_lang_String_: - -.. _Realm_createObjectFromJson_java_lang_Class__java_lang_String_: - -.. _Realm_createObjectFromJson_java_lang_Class_String_: - -.. _Realm_createObjectFromJson_java_lang_Class__String_: - -.. _Realm_createObjectFromJson_Class_java_lang_String_: - -.. _Realm_createObjectFromJson_Class__java_lang_String_: - -.. _Realm_createObjectFromJson_Class_String_: - -.. _Realm_createObjectFromJson_Class__String_: - -.. _io_realm_Realm_createObjectFromJson_Class_E___String_: - -.. list-table:: - :header-rows: 1 - - * - | public **E** :ref:`createObjectFromJson ` <**E** >( - | `java.lang.Class\ `__ clazz, - | `String `__ json - | ) - - - - - * - Creates a Realm object pre-filled with data from a JSON object. This must be done inside a transaction. JSON properties with unknown properties will be ignored. If a :ref:`RealmObject ` field is not present in the JSON object the :ref:`RealmObject ` field will be set to the default value for that type. - - This method currently does not support value list field. - - - - - - - **Parameters** - - - ``clazz`` - type of Realm object to create. - - - - - ``json`` - the JSON string with object data. - - - - - - - - **Returns** - - created object or ``null`` if JSON string was empty or null. - - - - - - - **Throws** - - - :ref:`RealmException ` - if mapping to json failed. - - - - - `IllegalArgumentException `__ - if the JSON object doesn't have a primary key property but the corresponding :ref:`RealmObjectSchema ` has a :ref:`io.realm.annotations.PrimaryKey ` defined. - - - - - - - - - - - - -.. _io_realm_Realm_createObjectFromJson_java_lang_Class_org_json_JSONObject_: - -.. _io_realm_Realm_createObjectFromJson_java_lang_Class__org_json_JSONObject_: - -.. _io_realm_Realm_createObjectFromJson_java_lang_Class_JSONObject_: - -.. _io_realm_Realm_createObjectFromJson_java_lang_Class__JSONObject_: - -.. _io_realm_Realm_createObjectFromJson_Class_org_json_JSONObject_: - -.. _io_realm_Realm_createObjectFromJson_Class__org_json_JSONObject_: - -.. _io_realm_Realm_createObjectFromJson_Class_JSONObject_: - -.. _io_realm_Realm_createObjectFromJson_Class__JSONObject_: - -.. _createObjectFromJson_java_lang_Class_org_json_JSONObject_: - -.. _createObjectFromJson_java_lang_Class__org_json_JSONObject_: - -.. _createObjectFromJson_java_lang_Class_JSONObject_: - -.. _createObjectFromJson_java_lang_Class__JSONObject_: - -.. _createObjectFromJson_Class_org_json_JSONObject_: - -.. _createObjectFromJson_Class__org_json_JSONObject_: - -.. _createObjectFromJson_Class_JSONObject_: - -.. _createObjectFromJson_Class__JSONObject_: - -.. _Realm_createObjectFromJson_java_lang_Class_org_json_JSONObject_: - -.. _Realm_createObjectFromJson_java_lang_Class__org_json_JSONObject_: - -.. _Realm_createObjectFromJson_java_lang_Class_JSONObject_: - -.. _Realm_createObjectFromJson_java_lang_Class__JSONObject_: - -.. _Realm_createObjectFromJson_Class_org_json_JSONObject_: - -.. _Realm_createObjectFromJson_Class__org_json_JSONObject_: - -.. _Realm_createObjectFromJson_Class_JSONObject_: - -.. _Realm_createObjectFromJson_Class__JSONObject_: - -.. _io_realm_Realm_createObjectFromJson_Class_E___JSONObject_: - -.. list-table:: - :header-rows: 1 - - * - | public **E** :ref:`createObjectFromJson ` <**E** >( - | `java.lang.Class\ `__ clazz, - | **JSONObject** json - | ) - - - - - * - Creates a Realm object pre-filled with data from a JSON object. This must be done inside a transaction. JSON properties with unknown properties will be ignored. If a :ref:`RealmObject ` field is not present in the JSON object the :ref:`RealmObject ` field will be set to the default value for that type. - - This method currently does not support value list field. - - - - - - - **Parameters** - - - ``clazz`` - type of Realm object to create. - - - - - ``json`` - the JSONObject with object data. - - - - - - - - **Returns** - - created object or ``null`` if no JSON data was provided. - - - - - - - **Throws** - - - :ref:`RealmException ` - if the mapping from JSON fails. - - - - - `IllegalArgumentException `__ - if the JSON object doesn't have a primary key property but the corresponding :ref:`RealmObjectSchema ` has a :ref:`io.realm.annotations.PrimaryKey ` defined. - - - - - - - - - - - - .. seealso:: - - - - - :ref:`createOrUpdateObjectFromJson(Class, org.json.JSONObject) ` - - - - - - - - - - - - -.. _createOrUpdateAllFromJson: - -.. _createOrUpdateAllFromJson__: - -.. _Realm_createOrUpdateAllFromJson: - -.. _Realm_createOrUpdateAllFromJson__: - -.. _io_realm_Realm_createOrUpdateAllFromJson: - -.. _io_realm_Realm_createOrUpdateAllFromJson__: - - - -createOrUpdateAllFromJson -------------------------- - -.. _io_realm_Realm_createOrUpdateAllFromJson_java_lang_Class_java_io_InputStream_: - -.. _io_realm_Realm_createOrUpdateAllFromJson_java_lang_Class__java_io_InputStream_: - -.. _io_realm_Realm_createOrUpdateAllFromJson_java_lang_Class_InputStream_: - -.. _io_realm_Realm_createOrUpdateAllFromJson_java_lang_Class__InputStream_: - -.. _io_realm_Realm_createOrUpdateAllFromJson_Class_java_io_InputStream_: - -.. _io_realm_Realm_createOrUpdateAllFromJson_Class__java_io_InputStream_: - -.. _io_realm_Realm_createOrUpdateAllFromJson_Class_InputStream_: - -.. _io_realm_Realm_createOrUpdateAllFromJson_Class__InputStream_: - -.. _createOrUpdateAllFromJson_java_lang_Class_java_io_InputStream_: - -.. _createOrUpdateAllFromJson_java_lang_Class__java_io_InputStream_: - -.. _createOrUpdateAllFromJson_java_lang_Class_InputStream_: - -.. _createOrUpdateAllFromJson_java_lang_Class__InputStream_: - -.. _createOrUpdateAllFromJson_Class_java_io_InputStream_: - -.. _createOrUpdateAllFromJson_Class__java_io_InputStream_: - -.. _createOrUpdateAllFromJson_Class_InputStream_: - -.. _createOrUpdateAllFromJson_Class__InputStream_: - -.. _Realm_createOrUpdateAllFromJson_java_lang_Class_java_io_InputStream_: - -.. _Realm_createOrUpdateAllFromJson_java_lang_Class__java_io_InputStream_: - -.. _Realm_createOrUpdateAllFromJson_java_lang_Class_InputStream_: - -.. _Realm_createOrUpdateAllFromJson_java_lang_Class__InputStream_: - -.. _Realm_createOrUpdateAllFromJson_Class_java_io_InputStream_: - -.. _Realm_createOrUpdateAllFromJson_Class__java_io_InputStream_: - -.. _Realm_createOrUpdateAllFromJson_Class_InputStream_: - -.. _Realm_createOrUpdateAllFromJson_Class__InputStream_: - -.. _io_realm_Realm_createOrUpdateAllFromJson_Class_E___InputStream_: - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`createOrUpdateAllFromJson ` <**E** >( - | `java.lang.Class\ `__ clazz, - | `InputStream `__ in - | ) - - - - - * - Tries to update a list of existing objects identified by their primary key with new JSON data. If an existing object could not be found in the Realm, a new object will be created. This must happen within a transaction. If updating a :ref:`RealmObject ` and a field is not found in the JSON object, that field will not be updated. If a new :ref:`RealmObject ` is created and a field is not found in the JSON object, that field will be assigned the default value for the field type. - - This API is only available in API level 11 or later. - - This method currently does not support value list field. - - - - - - - **Parameters** - - - ``clazz`` - type of :ref:`io.realm.RealmObject ` to create or update. It must have a primary key defined. - - - - - - - ``in`` - the InputStream with a list of object data in JSON format. - - - - - - - - - - **Throws** - - - `IllegalArgumentException `__ - if trying to update a class without a :ref:`io.realm.annotations.PrimaryKey ` . - - - - - - - `IllegalArgumentException `__ - if the JSON object doesn't have a primary key property but the corresponding :ref:`RealmObjectSchema ` has a :ref:`io.realm.annotations.PrimaryKey ` defined. - - - - - - - :ref:`RealmException ` - if unable to read JSON. - - - - - - - - - - .. seealso:: - - - - - :ref:`createOrUpdateAllFromJson(Class, java.io.InputStream) ` - - - - - - - - - - -.. _io_realm_Realm_createOrUpdateAllFromJson_java_lang_Class_java_lang_String_: - -.. _io_realm_Realm_createOrUpdateAllFromJson_java_lang_Class__java_lang_String_: - -.. _io_realm_Realm_createOrUpdateAllFromJson_java_lang_Class_String_: - -.. _io_realm_Realm_createOrUpdateAllFromJson_java_lang_Class__String_: - -.. _io_realm_Realm_createOrUpdateAllFromJson_Class_java_lang_String_: - -.. _io_realm_Realm_createOrUpdateAllFromJson_Class__java_lang_String_: - -.. _io_realm_Realm_createOrUpdateAllFromJson_Class_String_: - -.. _io_realm_Realm_createOrUpdateAllFromJson_Class__String_: - -.. _createOrUpdateAllFromJson_java_lang_Class_java_lang_String_: - -.. _createOrUpdateAllFromJson_java_lang_Class__java_lang_String_: - -.. _createOrUpdateAllFromJson_java_lang_Class_String_: - -.. _createOrUpdateAllFromJson_java_lang_Class__String_: - -.. _createOrUpdateAllFromJson_Class_java_lang_String_: - -.. _createOrUpdateAllFromJson_Class__java_lang_String_: - -.. _createOrUpdateAllFromJson_Class_String_: - -.. _createOrUpdateAllFromJson_Class__String_: - -.. _Realm_createOrUpdateAllFromJson_java_lang_Class_java_lang_String_: - -.. _Realm_createOrUpdateAllFromJson_java_lang_Class__java_lang_String_: - -.. _Realm_createOrUpdateAllFromJson_java_lang_Class_String_: - -.. _Realm_createOrUpdateAllFromJson_java_lang_Class__String_: - -.. _Realm_createOrUpdateAllFromJson_Class_java_lang_String_: - -.. _Realm_createOrUpdateAllFromJson_Class__java_lang_String_: - -.. _Realm_createOrUpdateAllFromJson_Class_String_: - -.. _Realm_createOrUpdateAllFromJson_Class__String_: - -.. _io_realm_Realm_createOrUpdateAllFromJson_Class_E___String_: - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`createOrUpdateAllFromJson ` <**E** >( - | `java.lang.Class\ `__ clazz, - | `String `__ json - | ) - - - - - * - Tries to update a list of existing objects identified by their primary key with new JSON data. If an existing object could not be found in the Realm, a new object will be created. This must happen within a transaction. If updating a :ref:`RealmObject ` and a field is not found in the JSON object, that field will not be updated. If a new :ref:`RealmObject ` is created and a field is not found in the JSON object, that field will be assigned the default value for the field type. - - This method currently does not support value list field. - - - - - - - **Parameters** - - - ``clazz`` - type of :ref:`io.realm.RealmObject ` to create or update. It must have a primary key defined. - - - - - - - ``json`` - string with an array of JSON objects. - - - - - - - - - - **Throws** - - - `IllegalArgumentException `__ - if trying to update a class without a :ref:`io.realm.annotations.PrimaryKey ` . - - - - - - - :ref:`RealmException ` - if unable to create a JSON array from the json string. - - - - - `IllegalArgumentException `__ - if the JSON object doesn't have a primary key property but the corresponding :ref:`RealmObjectSchema ` has a :ref:`io.realm.annotations.PrimaryKey ` defined. - - - - - - - - - - - - .. seealso:: - - - - - :ref:`createAllFromJson(Class, String) ` - - - - - - - - - - -.. _io_realm_Realm_createOrUpdateAllFromJson_java_lang_Class_org_json_JSONArray_: - -.. _io_realm_Realm_createOrUpdateAllFromJson_java_lang_Class__org_json_JSONArray_: - -.. _io_realm_Realm_createOrUpdateAllFromJson_java_lang_Class_JSONArray_: - -.. _io_realm_Realm_createOrUpdateAllFromJson_java_lang_Class__JSONArray_: - -.. _io_realm_Realm_createOrUpdateAllFromJson_Class_org_json_JSONArray_: - -.. _io_realm_Realm_createOrUpdateAllFromJson_Class__org_json_JSONArray_: - -.. _io_realm_Realm_createOrUpdateAllFromJson_Class_JSONArray_: - -.. _io_realm_Realm_createOrUpdateAllFromJson_Class__JSONArray_: - -.. _createOrUpdateAllFromJson_java_lang_Class_org_json_JSONArray_: - -.. _createOrUpdateAllFromJson_java_lang_Class__org_json_JSONArray_: - -.. _createOrUpdateAllFromJson_java_lang_Class_JSONArray_: - -.. _createOrUpdateAllFromJson_java_lang_Class__JSONArray_: - -.. _createOrUpdateAllFromJson_Class_org_json_JSONArray_: - -.. _createOrUpdateAllFromJson_Class__org_json_JSONArray_: - -.. _createOrUpdateAllFromJson_Class_JSONArray_: - -.. _createOrUpdateAllFromJson_Class__JSONArray_: - -.. _Realm_createOrUpdateAllFromJson_java_lang_Class_org_json_JSONArray_: - -.. _Realm_createOrUpdateAllFromJson_java_lang_Class__org_json_JSONArray_: - -.. _Realm_createOrUpdateAllFromJson_java_lang_Class_JSONArray_: - -.. _Realm_createOrUpdateAllFromJson_java_lang_Class__JSONArray_: - -.. _Realm_createOrUpdateAllFromJson_Class_org_json_JSONArray_: - -.. _Realm_createOrUpdateAllFromJson_Class__org_json_JSONArray_: - -.. _Realm_createOrUpdateAllFromJson_Class_JSONArray_: - -.. _Realm_createOrUpdateAllFromJson_Class__JSONArray_: - -.. _io_realm_Realm_createOrUpdateAllFromJson_Class_E___JSONArray_: - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`createOrUpdateAllFromJson ` <**E** >( - | `java.lang.Class\ `__ clazz, - | **JSONArray** json - | ) - - - - - * - Tries to update a list of existing objects identified by their primary key with new JSON data. If an existing object could not be found in the Realm, a new object will be created. This must happen within a transaction. If updating a :ref:`RealmObject ` and a field is not found in the JSON object, that field will not be updated. If a new :ref:`RealmObject ` is created and a field is not found in the JSON object, that field will be assigned the default value for the field type. - - This method currently does not support value list field. + @@ -3629,13 +2557,7 @@ createOrUpdateAllFromJson **Parameters** - - ``clazz`` - type of :ref:`io.realm.RealmObject ` to create or update. It must have a primary key defined. - - - - - - - ``json`` - array with object data. + - ``clazz`` - the Class of the object to create. @@ -3643,23 +2565,16 @@ createOrUpdateAllFromJson + **Returns** + + the new object. + + **Throws** - - `IllegalArgumentException `__ - if trying to update a class without a :ref:`io.realm.annotations.PrimaryKey ` . - - - - - - - `IllegalArgumentException `__ - if the JSON object doesn't have a primary key property but the corresponding :ref:`RealmObjectSchema ` has a :ref:`io.realm.annotations.PrimaryKey ` defined. - - - - - - - :ref:`RealmException ` - if unable to map JSON. + - :ref:`RealmException ` - if the primary key is defined in the model class or an object cannot be created. @@ -3673,7 +2588,7 @@ createOrUpdateAllFromJson - - :ref:`createAllFromJson(Class, org.json.JSONArray) ` + - :ref:`createObject(Class, Object) ` @@ -3686,87 +2601,61 @@ createOrUpdateAllFromJson -.. _createOrUpdateObjectFromJson: - -.. _createOrUpdateObjectFromJson__: - -.. _Realm_createOrUpdateObjectFromJson: - -.. _Realm_createOrUpdateObjectFromJson__: - -.. _io_realm_Realm_createOrUpdateObjectFromJson: - -.. _io_realm_Realm_createOrUpdateObjectFromJson__: - - - -createOrUpdateObjectFromJson ----------------------------- - -.. _io_realm_Realm_createOrUpdateObjectFromJson_java_lang_Class_java_io_InputStream_: - -.. _io_realm_Realm_createOrUpdateObjectFromJson_java_lang_Class__java_io_InputStream_: - -.. _io_realm_Realm_createOrUpdateObjectFromJson_java_lang_Class_InputStream_: - -.. _io_realm_Realm_createOrUpdateObjectFromJson_java_lang_Class__InputStream_: +.. _createObjectFromJson: -.. _io_realm_Realm_createOrUpdateObjectFromJson_Class_java_io_InputStream_: +.. _createObjectFromJson__: -.. _io_realm_Realm_createOrUpdateObjectFromJson_Class__java_io_InputStream_: +.. _Realm_createObjectFromJson: -.. _io_realm_Realm_createOrUpdateObjectFromJson_Class_InputStream_: +.. _Realm_createObjectFromJson__: -.. _io_realm_Realm_createOrUpdateObjectFromJson_Class__InputStream_: +.. _io_realm_Realm_createObjectFromJson: -.. _createOrUpdateObjectFromJson_java_lang_Class_java_io_InputStream_: +.. _io_realm_Realm_createObjectFromJson__: -.. _createOrUpdateObjectFromJson_java_lang_Class__java_io_InputStream_: -.. _createOrUpdateObjectFromJson_java_lang_Class_InputStream_: -.. _createOrUpdateObjectFromJson_java_lang_Class__InputStream_: +createObjectFromJson +-------------------- -.. _createOrUpdateObjectFromJson_Class_java_io_InputStream_: +.. _io_realm_Realm_createObjectFromJson_java_lang_Class_JSONObject_: -.. _createOrUpdateObjectFromJson_Class__java_io_InputStream_: +.. _io_realm_Realm_createObjectFromJson_java_lang_Class__JSONObject_: -.. _createOrUpdateObjectFromJson_Class_InputStream_: +.. _io_realm_Realm_createObjectFromJson_Class_JSONObject_: -.. _createOrUpdateObjectFromJson_Class__InputStream_: +.. _io_realm_Realm_createObjectFromJson_Class__JSONObject_: -.. _Realm_createOrUpdateObjectFromJson_java_lang_Class_java_io_InputStream_: +.. _createObjectFromJson_java_lang_Class_JSONObject_: -.. _Realm_createOrUpdateObjectFromJson_java_lang_Class__java_io_InputStream_: +.. _createObjectFromJson_java_lang_Class__JSONObject_: -.. _Realm_createOrUpdateObjectFromJson_java_lang_Class_InputStream_: +.. _createObjectFromJson_Class_JSONObject_: -.. _Realm_createOrUpdateObjectFromJson_java_lang_Class__InputStream_: +.. _createObjectFromJson_Class__JSONObject_: -.. _Realm_createOrUpdateObjectFromJson_Class_java_io_InputStream_: +.. _Realm_createObjectFromJson_java_lang_Class_JSONObject_: -.. _Realm_createOrUpdateObjectFromJson_Class__java_io_InputStream_: +.. _Realm_createObjectFromJson_java_lang_Class__JSONObject_: -.. _Realm_createOrUpdateObjectFromJson_Class_InputStream_: +.. _Realm_createObjectFromJson_Class_JSONObject_: -.. _Realm_createOrUpdateObjectFromJson_Class__InputStream_: +.. _Realm_createObjectFromJson_Class__JSONObject_: -.. _io_realm_Realm_createOrUpdateObjectFromJson_Class_E___InputStream_: +.. _io_realm_Realm_createObjectFromJson_Class_E___JSONObject_: .. list-table:: :header-rows: 1 - * - | public **E** :ref:`createOrUpdateObjectFromJson ` <**E** >( - | `java.lang.Class\ `__ clazz, - | `InputStream `__ in + * - | public **E** :ref:`createObjectFromJson ` <**E** >( + | `java.lang.Class\ `__ clazz, + | **JSONObject** json | ) - * - Tries to update an existing object defined by its primary key with new JSON data. If no existing object could be found a new object will be saved in the Realm. This must happen within a transaction. If updating a :ref:`RealmObject ` and a field is not found in the JSON object, that field will not be updated. If a new :ref:`RealmObject ` is created and a field is not found in the JSON object, that field will be assigned the default value for the field type. - - This API is only available in API level 11 or later. + * - Creates a Realm object pre-filled with data from a JSON object. This must be done inside a transaction. JSON properties with unknown properties will be ignored. If a :ref:`RealmObject ` field is not present in the JSON object the :ref:`RealmObject ` field will be set to the default value for that type. This method currently does not support value list field. @@ -3777,15 +2666,11 @@ createOrUpdateObjectFromJson **Parameters** - - ``clazz`` - type of :ref:`io.realm.RealmObject ` to create or update. It must have a primary key defined. - - - - + - ``clazz`` - type of Realm object to create. - - ``in`` - the `InputStream `__ with object data in JSON format. + - ``json`` - the JSONObject with object data. @@ -3795,7 +2680,7 @@ createOrUpdateObjectFromJson **Returns** - created or updated :ref:`io.realm.RealmObject ` . + created object or ``null`` if no JSON data was provided. @@ -3804,19 +2689,19 @@ createOrUpdateObjectFromJson **Throws** - - `IllegalArgumentException `__ - if trying to update a class without a :ref:`io.realm.annotations.PrimaryKey ` . + - :ref:`RealmException ` - if the mapping from JSON fails. + - `IllegalArgumentException `__ - if the JSON object doesn't have a primary key property but the corresponding :ref:`RealmObjectSchema ` has a :ref:`io.realm.annotations.PrimaryKey ` defined. - - `IllegalArgumentException `__ - if the JSON object doesn't have a primary key property but the corresponding :ref:`RealmObjectSchema ` has a :ref:`io.realm.annotations.PrimaryKey ` defined. + - `UnsupportedOperationException `__ - if the object to insert contains a :ref:`RealmDictionary ` or a :ref:`RealmSet ` . - - :ref:`RealmException ` - if failure to read JSON. @@ -3830,7 +2715,19 @@ createOrUpdateObjectFromJson - - :ref:`createObjectFromJson(Class, java.io.InputStream) ` + - **createOrUpdateObjectFromJson(Class, org.json.JSONObject)** + + + + - :ref:`RealmSet ` + + + + - :ref:`RealmDictionary ` + + + + - :ref:`RealmMap ` @@ -3841,68 +2738,63 @@ createOrUpdateObjectFromJson -.. _io_realm_Realm_createOrUpdateObjectFromJson_java_lang_Class_java_lang_String_: -.. _io_realm_Realm_createOrUpdateObjectFromJson_java_lang_Class__java_lang_String_: -.. _io_realm_Realm_createOrUpdateObjectFromJson_java_lang_Class_String_: - -.. _io_realm_Realm_createOrUpdateObjectFromJson_java_lang_Class__String_: +.. _createOrUpdateAllFromJson: -.. _io_realm_Realm_createOrUpdateObjectFromJson_Class_java_lang_String_: +.. _createOrUpdateAllFromJson__: -.. _io_realm_Realm_createOrUpdateObjectFromJson_Class__java_lang_String_: +.. _Realm_createOrUpdateAllFromJson: -.. _io_realm_Realm_createOrUpdateObjectFromJson_Class_String_: +.. _Realm_createOrUpdateAllFromJson__: -.. _io_realm_Realm_createOrUpdateObjectFromJson_Class__String_: +.. _io_realm_Realm_createOrUpdateAllFromJson: -.. _createOrUpdateObjectFromJson_java_lang_Class_java_lang_String_: +.. _io_realm_Realm_createOrUpdateAllFromJson__: -.. _createOrUpdateObjectFromJson_java_lang_Class__java_lang_String_: -.. _createOrUpdateObjectFromJson_java_lang_Class_String_: -.. _createOrUpdateObjectFromJson_java_lang_Class__String_: +createOrUpdateAllFromJson +------------------------- -.. _createOrUpdateObjectFromJson_Class_java_lang_String_: +.. _io_realm_Realm_createOrUpdateAllFromJson_java_lang_Class_JSONArray_: -.. _createOrUpdateObjectFromJson_Class__java_lang_String_: +.. _io_realm_Realm_createOrUpdateAllFromJson_java_lang_Class__JSONArray_: -.. _createOrUpdateObjectFromJson_Class_String_: +.. _io_realm_Realm_createOrUpdateAllFromJson_Class_JSONArray_: -.. _createOrUpdateObjectFromJson_Class__String_: +.. _io_realm_Realm_createOrUpdateAllFromJson_Class__JSONArray_: -.. _Realm_createOrUpdateObjectFromJson_java_lang_Class_java_lang_String_: +.. _createOrUpdateAllFromJson_java_lang_Class_JSONArray_: -.. _Realm_createOrUpdateObjectFromJson_java_lang_Class__java_lang_String_: +.. _createOrUpdateAllFromJson_java_lang_Class__JSONArray_: -.. _Realm_createOrUpdateObjectFromJson_java_lang_Class_String_: +.. _createOrUpdateAllFromJson_Class_JSONArray_: -.. _Realm_createOrUpdateObjectFromJson_java_lang_Class__String_: +.. _createOrUpdateAllFromJson_Class__JSONArray_: -.. _Realm_createOrUpdateObjectFromJson_Class_java_lang_String_: +.. _Realm_createOrUpdateAllFromJson_java_lang_Class_JSONArray_: -.. _Realm_createOrUpdateObjectFromJson_Class__java_lang_String_: +.. _Realm_createOrUpdateAllFromJson_java_lang_Class__JSONArray_: -.. _Realm_createOrUpdateObjectFromJson_Class_String_: +.. _Realm_createOrUpdateAllFromJson_Class_JSONArray_: -.. _Realm_createOrUpdateObjectFromJson_Class__String_: +.. _Realm_createOrUpdateAllFromJson_Class__JSONArray_: -.. _io_realm_Realm_createOrUpdateObjectFromJson_Class_E___String_: +.. _io_realm_Realm_createOrUpdateAllFromJson_Class_E___JSONArray_: .. list-table:: :header-rows: 1 - * - | public **E** :ref:`createOrUpdateObjectFromJson ` <**E** >( - | `java.lang.Class\ `__ clazz, - | `String `__ json + * - | public **void** :ref:`createOrUpdateAllFromJson ` <**E** >( + | `java.lang.Class\ `__ clazz, + | **JSONArray** json | ) - * - Tries to update an existing object defined by its primary key with new JSON data. If no existing object could be found a new object will be saved in the Realm. This must happen within a transaction. If updating a :ref:`RealmObject ` and a field is not found in the JSON object, that field will not be updated. If a new :ref:`RealmObject ` is created and a field is not found in the JSON object, that field will be assigned the default value for the field type. + * - Tries to update a list of existing objects identified by their primary key with new JSON data. If an existing object could not be found in the Realm, a new object will be created. This must happen within a transaction. If updating a :ref:`RealmObject ` and a field is not found in the JSON object, that field will not be updated. If a new :ref:`RealmObject ` is created and a field is not found in the JSON object, that field will be assigned the default value for the field type. This method currently does not support value list field. @@ -3919,7 +2811,7 @@ createOrUpdateObjectFromJson - - ``json`` - string with object data in JSON format. + - ``json`` - array with object data. @@ -3927,30 +2819,29 @@ createOrUpdateObjectFromJson - **Returns** - - created or updated :ref:`io.realm.RealmObject ` . - - - - **Throws** - - `IllegalArgumentException `__ - if trying to update a class without a :ref:`io.realm.annotations.PrimaryKey ` . + - `IllegalArgumentException `__ - if trying to update a class without a :ref:`io.realm.annotations.PrimaryKey ` . + + + + - `IllegalArgumentException `__ - if the JSON object doesn't have a primary key property but the corresponding :ref:`RealmObjectSchema ` has a :ref:`io.realm.annotations.PrimaryKey ` defined. - - `IllegalArgumentException `__ - if the JSON object doesn't have a primary key property but the corresponding :ref:`RealmObjectSchema ` has a :ref:`io.realm.annotations.PrimaryKey ` defined. + - :ref:`RealmException ` - if unable to map JSON. + + - `UnsupportedOperationException `__ - if the object to insert contains a :ref:`RealmDictionary ` or a :ref:`RealmSet ` . + - - :ref:`RealmException ` - if JSON object cannot be mapped from the string parameter. @@ -3964,7 +2855,19 @@ createOrUpdateObjectFromJson - - :ref:`createObjectFromJson(Class, String) ` + - **createAllFromJson(Class, org.json.JSONArray)** + + + + - :ref:`RealmSet ` + + + + - :ref:`RealmDictionary ` + + + + - :ref:`RealmMap ` @@ -3975,50 +2878,45 @@ createOrUpdateObjectFromJson -.. _io_realm_Realm_createOrUpdateObjectFromJson_java_lang_Class_org_json_JSONObject_: -.. _io_realm_Realm_createOrUpdateObjectFromJson_java_lang_Class__org_json_JSONObject_: -.. _io_realm_Realm_createOrUpdateObjectFromJson_java_lang_Class_JSONObject_: +.. _createOrUpdateObjectFromJson: -.. _io_realm_Realm_createOrUpdateObjectFromJson_java_lang_Class__JSONObject_: +.. _createOrUpdateObjectFromJson__: -.. _io_realm_Realm_createOrUpdateObjectFromJson_Class_org_json_JSONObject_: +.. _Realm_createOrUpdateObjectFromJson: -.. _io_realm_Realm_createOrUpdateObjectFromJson_Class__org_json_JSONObject_: +.. _Realm_createOrUpdateObjectFromJson__: -.. _io_realm_Realm_createOrUpdateObjectFromJson_Class_JSONObject_: +.. _io_realm_Realm_createOrUpdateObjectFromJson: -.. _io_realm_Realm_createOrUpdateObjectFromJson_Class__JSONObject_: +.. _io_realm_Realm_createOrUpdateObjectFromJson__: -.. _createOrUpdateObjectFromJson_java_lang_Class_org_json_JSONObject_: -.. _createOrUpdateObjectFromJson_java_lang_Class__org_json_JSONObject_: -.. _createOrUpdateObjectFromJson_java_lang_Class_JSONObject_: +createOrUpdateObjectFromJson +---------------------------- -.. _createOrUpdateObjectFromJson_java_lang_Class__JSONObject_: +.. _io_realm_Realm_createOrUpdateObjectFromJson_java_lang_Class_JSONObject_: + +.. _io_realm_Realm_createOrUpdateObjectFromJson_java_lang_Class__JSONObject_: -.. _createOrUpdateObjectFromJson_Class_org_json_JSONObject_: +.. _io_realm_Realm_createOrUpdateObjectFromJson_Class_JSONObject_: -.. _createOrUpdateObjectFromJson_Class__org_json_JSONObject_: +.. _io_realm_Realm_createOrUpdateObjectFromJson_Class__JSONObject_: -.. _createOrUpdateObjectFromJson_Class_JSONObject_: +.. _createOrUpdateObjectFromJson_java_lang_Class_JSONObject_: -.. _createOrUpdateObjectFromJson_Class__JSONObject_: +.. _createOrUpdateObjectFromJson_java_lang_Class__JSONObject_: -.. _Realm_createOrUpdateObjectFromJson_java_lang_Class_org_json_JSONObject_: +.. _createOrUpdateObjectFromJson_Class_JSONObject_: -.. _Realm_createOrUpdateObjectFromJson_java_lang_Class__org_json_JSONObject_: +.. _createOrUpdateObjectFromJson_Class__JSONObject_: .. _Realm_createOrUpdateObjectFromJson_java_lang_Class_JSONObject_: .. _Realm_createOrUpdateObjectFromJson_java_lang_Class__JSONObject_: -.. _Realm_createOrUpdateObjectFromJson_Class_org_json_JSONObject_: - -.. _Realm_createOrUpdateObjectFromJson_Class__org_json_JSONObject_: - .. _Realm_createOrUpdateObjectFromJson_Class_JSONObject_: .. _Realm_createOrUpdateObjectFromJson_Class__JSONObject_: @@ -4029,7 +2927,7 @@ createOrUpdateObjectFromJson :header-rows: 1 * - | public **E** :ref:`createOrUpdateObjectFromJson ` <**E** >( - | `java.lang.Class\ `__ clazz, + | `java.lang.Class\ `__ clazz, | **JSONObject** json | ) @@ -4074,13 +2972,13 @@ createOrUpdateObjectFromJson **Throws** - - `IllegalArgumentException `__ - if trying to update a class without a :ref:`io.realm.annotations.PrimaryKey ` . + - `IllegalArgumentException `__ - if trying to update a class without a :ref:`io.realm.annotations.PrimaryKey ` . - - `IllegalArgumentException `__ - if the JSON object doesn't have a primary key property but the corresponding :ref:`RealmObjectSchema ` has a :ref:`io.realm.annotations.PrimaryKey ` defined. + - `IllegalArgumentException `__ - if the JSON object doesn't have a primary key property but the corresponding :ref:`RealmObjectSchema ` has a :ref:`io.realm.annotations.PrimaryKey ` defined. @@ -4090,6 +2988,12 @@ createOrUpdateObjectFromJson + - `UnsupportedOperationException `__ - if the object to insert contains a :ref:`RealmDictionary ` or a :ref:`RealmSet ` . + + + + + @@ -4100,7 +3004,19 @@ createOrUpdateObjectFromJson - - :ref:`createObjectFromJson(Class, org.json.JSONObject) ` + - **createObjectFromJson(Class, org.json.JSONObject)** + + + + - :ref:`RealmSet ` + + + + - :ref:`RealmDictionary ` + + + + - :ref:`RealmMap ` @@ -4154,7 +3070,7 @@ delete :header-rows: 1 * - | public **void** :ref:`delete ` ( - | `java.lang.Class\ `__ clazz + | `java.lang.Class\ `__ clazz | ) @@ -4179,7 +3095,7 @@ delete **Throws** - - `IllegalStateException `__ - if the Realm is closed or called from an incorrect thread. + - `IllegalStateException `__ - if the Realm is closed or called from an incorrect thread. @@ -4267,7 +3183,7 @@ deleteRealm **Throws** - - `IllegalStateException `__ - if there are Realm instances opened on other threads or other processes. + - `IllegalStateException `__ - if there are Realm instances opened on other threads or other processes. @@ -4352,7 +3268,7 @@ executeTransaction **Throws** - - `IllegalArgumentException `__ - if the ``transaction`` is ``null`` . + - `IllegalArgumentException `__ - if the ``transaction`` is ``null`` . @@ -4768,7 +3684,7 @@ executeTransactionAsync **Throws** - - `IllegalArgumentException `__ - if the ``transaction`` is ``null`` , or if the realm is opened from another thread. + - `IllegalArgumentException `__ - if the ``transaction`` is ``null`` , or if the realm is opened from another thread. @@ -4934,7 +3850,7 @@ executeTransactionAsync **Throws** - - `IllegalArgumentException `__ - if the ``transaction`` is ``null`` , or if the realm is opened from another thread. + - `IllegalArgumentException `__ - if the ``transaction`` is ``null`` , or if the realm is opened from another thread. @@ -5100,7 +4016,7 @@ executeTransactionAsync **Throws** - - `IllegalArgumentException `__ - if the ``transaction`` is ``null`` , or if the realm is opened from another thread. + - `IllegalArgumentException `__ - if the ``transaction`` is ``null`` , or if the realm is opened from another thread. @@ -5171,7 +4087,7 @@ executeTransactionAsync **Throws** - - `IllegalArgumentException `__ - if the ``transaction`` is ``null`` , or if the Realm is opened from another thread. + - `IllegalArgumentException `__ - if the ``transaction`` is ``null`` , or if the Realm is opened from another thread. @@ -5212,9 +4128,9 @@ freeze - * - Returns a frozen snapshot of the current Realm. This Realm can be read and queried from any thread without throwing an `IllegalStateException `__ . A frozen Realm has its own lifecycle and can be closed by calling **close()**, but fully closing the Realm that spawned the frozen copy will also close the frozen Realm. + * - Returns a frozen snapshot of the current Realm. This Realm can be read and queried from any thread without throwing an `IllegalStateException `__ . A frozen Realm has its own lifecycle and can be closed by calling **close()**, but fully closing the Realm that spawned the frozen copy will also close the frozen Realm. - Frozen data can be queried as normal, but trying to mutate it in any way or attempting to register any listener will throw an `IllegalStateException `__ . + Frozen data can be queried as normal, but trying to mutate it in any way or attempting to register any listener will throw an `IllegalStateException `__ . @@ -5267,7 +4183,7 @@ getApplicationContext .. list-table:: :header-rows: 1 - * - | public static `Context `__ :ref:`getApplicationContext ` () + * - | public static **Context** :ref:`getApplicationContext ` () | @@ -5393,7 +4309,7 @@ getDefaultInstance **Throws** - - `java.lang.NullPointerException `__ - if no default configuration has been defined. + - `java.lang.NullPointerException `__ - if no default configuration has been defined. @@ -5434,7 +4350,7 @@ getDefaultModule .. list-table:: :header-rows: 1 - * - | public static `Object `__ :ref:`getDefaultModule ` () + * - | public static `Object `__ :ref:`getDefaultModule ` () | @@ -5630,7 +4546,7 @@ getInstance - - `IllegalArgumentException `__ - if a null :ref:`RealmConfiguration ` is provided. + - `IllegalArgumentException `__ - if a null :ref:`RealmConfiguration ` is provided. @@ -5793,13 +4709,13 @@ getInstanceAsync **Throws** - - `IllegalArgumentException `__ - if a null :ref:`RealmConfiguration ` or a null :ref:`Callback ` is provided. + - `IllegalArgumentException `__ - if a null :ref:`RealmConfiguration ` or a null :ref:`Callback ` is provided. - - `IllegalStateException `__ - if it is called from a non-Looper or `IntentService `__ thread. + - `IllegalStateException `__ - if it is called from a non-Looper or **IntentService** thread. @@ -5924,7 +4840,7 @@ getSchema - * - Returns the schema for this Realm. The schema is immutable. Any attempt to modify it will result in an `UnsupportedOperationException `__ . + * - Returns the schema for this Realm. The schema is immutable. Any attempt to modify it will result in an `UnsupportedOperationException `__ . The schema can only be modified using :ref:`DynamicRealm.getSchema() ` or through an migration. @@ -5974,14 +4890,6 @@ getSchema init ---- -.. _io_realm_Realm_init_android_content_Context_java_lang_String_: - -.. _io_realm_Realm_init_android_content_Context__java_lang_String_: - -.. _io_realm_Realm_init_android_content_Context_String_: - -.. _io_realm_Realm_init_android_content_Context__String_: - .. _io_realm_Realm_init_Context_java_lang_String_: .. _io_realm_Realm_init_Context__java_lang_String_: @@ -5990,14 +4898,6 @@ init .. _io_realm_Realm_init_Context__String_: -.. _init_android_content_Context_java_lang_String_: - -.. _init_android_content_Context__java_lang_String_: - -.. _init_android_content_Context_String_: - -.. _init_android_content_Context__String_: - .. _init_Context_java_lang_String_: .. _init_Context__java_lang_String_: @@ -6006,14 +4906,6 @@ init .. _init_Context__String_: -.. _Realm_init_android_content_Context_java_lang_String_: - -.. _Realm_init_android_content_Context__java_lang_String_: - -.. _Realm_init_android_content_Context_String_: - -.. _Realm_init_android_content_Context__String_: - .. _Realm_init_Context_java_lang_String_: .. _Realm_init_Context__java_lang_String_: @@ -6026,8 +4918,8 @@ init :header-rows: 1 * - | public static synchronized **void** :ref:`init ` ( - | `Context `__ context, - | `String `__ userAgent + | **Context** context, + | `String `__ userAgent | ) @@ -6099,13 +4991,13 @@ init **Throws** - - `IllegalArgumentException `__ - if a ``null`` context or userAgent is provided. + - `IllegalArgumentException `__ - if a ``null`` context or userAgent is provided. - - `IllegalStateException `__ - if `Context.getFilesDir() `__ could not be found. + - `IllegalStateException `__ - if **Context.getFilesDir()** could not be found. @@ -6132,23 +5024,17 @@ init -.. _io_realm_Realm_init_android_content_Context_: - .. _io_realm_Realm_init_Context_: -.. _init_android_content_Context_: - .. _init_Context_: -.. _Realm_init_android_content_Context_: - .. _Realm_init_Context_: .. list-table:: :header-rows: 1 * - | public static synchronized **void** :ref:`init ` ( - | `Context `__ context + | **Context** context | ) @@ -6214,13 +5100,13 @@ init **Throws** - - `IllegalArgumentException `__ - if a ``null`` context is provided. + - `IllegalArgumentException `__ - if a ``null`` context is provided. - - `IllegalStateException `__ - if `Context.getFilesDir() `__ could not be found. + - `IllegalStateException `__ - if **Context.getFilesDir()** could not be found. @@ -6330,7 +5216,7 @@ insert **Throws** - - `IllegalStateException `__ - if the corresponding Realm is closed, called from an incorrect thread or not in a transaction. + - `IllegalStateException `__ - if the corresponding Realm is closed, called from an incorrect thread or not in a transaction. @@ -6343,20 +5229,6 @@ insert - - .. seealso:: - - - - - :ref:`copyToRealm(RealmModel, ImportFlag...) ` - - - - - - - - .. _io_realm_Realm_insert_java_util_Collection_: @@ -6383,7 +5255,7 @@ insert :header-rows: 1 * - | public **void** :ref:`insert ` ( - | `java.util.Collection\ `__ objects + | `java.util.Collection\ `__ objects | ) @@ -6431,7 +5303,7 @@ insert **Throws** - - `IllegalStateException `__ - if the corresponding Realm is closed, called from an incorrect thread or not in a transaction. + - `IllegalStateException `__ - if the corresponding Realm is closed, called from an incorrect thread or not in a transaction. @@ -6440,20 +5312,6 @@ insert - - .. seealso:: - - - - - :ref:`copyToRealm(Iterable, ImportFlag...) ` - - - - - - - - @@ -6539,7 +5397,7 @@ insertOrUpdate **Throws** - - `IllegalStateException `__ - if the corresponding Realm is closed, called from an incorrect thread or not in a transaction. + - `IllegalStateException `__ - if the corresponding Realm is closed, called from an incorrect thread or not in a transaction. @@ -6548,20 +5406,6 @@ insertOrUpdate - - .. seealso:: - - - - - :ref:`copyToRealmOrUpdate(RealmModel, ImportFlag...) ` - - - - - - - - .. _io_realm_Realm_insertOrUpdate_java_util_Collection_: @@ -6588,7 +5432,7 @@ insertOrUpdate :header-rows: 1 * - | public **void** :ref:`insertOrUpdate ` ( - | `java.util.Collection\ `__ objects + | `java.util.Collection\ `__ objects | ) @@ -6636,7 +5480,7 @@ insertOrUpdate **Throws** - - `IllegalStateException `__ - if the corresponding Realm is closed, called from an incorrect thread or not in a transaction. + - `IllegalStateException `__ - if the corresponding Realm is closed, called from an incorrect thread or not in a transaction. @@ -6649,20 +5493,6 @@ insertOrUpdate - - .. seealso:: - - - - - :ref:`copyToRealmOrUpdate(Iterable, ImportFlag...) ` - - - - - - - - @@ -6825,7 +5655,7 @@ migrateRealm **Throws** - - `FileNotFoundException `__ - if the Realm file doesn't exist. + - `FileNotFoundException `__ - if the Realm file doesn't exist. @@ -6879,7 +5709,7 @@ migrateRealm **Throws** - - `FileNotFoundException `__ - if the Realm file doesn't exist. + - `FileNotFoundException `__ - if the Realm file doesn't exist. @@ -6929,7 +5759,7 @@ removeAllChangeListeners **Throws** - - `IllegalStateException `__ - if you try to remove listeners from a non-Looper Thread. + - `IllegalStateException `__ - if you try to remove listeners from a non-Looper Thread. @@ -7016,13 +5846,13 @@ removeChangeListener **Throws** - - `IllegalArgumentException `__ - if the change listener is ``null`` . + - `IllegalArgumentException `__ - if the change listener is ``null`` . - - `IllegalStateException `__ - if you try to remove a listener from a non-Looper Thread. + - `IllegalStateException `__ - if you try to remove a listener from a non-Looper Thread. @@ -7155,7 +5985,7 @@ setDefaultConfiguration **Throws** - - `IllegalArgumentException `__ - if a null :ref:`RealmConfiguration ` is provided. + - `IllegalArgumentException `__ - if a null :ref:`RealmConfiguration ` is provided. @@ -7219,7 +6049,7 @@ where :header-rows: 1 * - | public :ref:`RealmQuery ` :ref:`where ` <**E** >( - | `java.lang.Class\ `__ clazz + | `java.lang.Class\ `__ clazz | ) diff --git a/source/sdk/java/api/io/realm/Realm/Callback.txt b/source/sdk/java/api/io/realm/Realm/Callback.txt index 0a4306b3cd..c324ef21dd 100644 --- a/source/sdk/java/api/io/realm/Realm/Callback.txt +++ b/source/sdk/java/api/io/realm/Realm/Callback.txt @@ -18,7 +18,7 @@ io.realm ======== - | `java.lang.Object `__ + | `java.lang.Object `__ | **io.realm.BaseRealm.InstanceCallback** | io.realm.Realm.Callback @@ -67,7 +67,7 @@ Method Summary * - public **void** - | :ref:`onError ` ( - | `Throwable `__ exception + | `Throwable `__ exception | ) @@ -97,7 +97,7 @@ Inherited Methods -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` +- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` - Methods inherited from class **io.realm.BaseRealm.InstanceCallback**: ``onSuccess`` , ``onError`` @@ -177,7 +177,7 @@ onError :header-rows: 1 * - | public **void** :ref:`onError ` ( - | `Throwable `__ exception + | `Throwable `__ exception | ) diff --git a/source/sdk/java/api/io/realm/Realm/Transaction.txt b/source/sdk/java/api/io/realm/Realm/Transaction.txt index 6473510dab..388751c75b 100644 --- a/source/sdk/java/api/io/realm/Realm/Transaction.txt +++ b/source/sdk/java/api/io/realm/Realm/Transaction.txt @@ -25,7 +25,7 @@ io.realm -Encapsulates a Realm transaction.Using this class will automatically handle **beginTransaction()** and **commitTransaction()** If any exception is thrown during the transaction **cancelTransaction()** will be called instead of **commitTransaction()**. +Encapsulates a Realm transaction.Using this class will automatically handle **io.realm.Realm.beginTransaction()** and **io.realm.Realm.commitTransaction()** If any exception is thrown during the transaction **io.realm.Realm.cancelTransaction()** will be called instead of **io.realm.Realm.commitTransaction()**. diff --git a/source/sdk/java/api/io/realm/Realm/Transaction/Callback.txt b/source/sdk/java/api/io/realm/Realm/Transaction/Callback.txt index 9b3dd40cae..da30f154cd 100644 --- a/source/sdk/java/api/io/realm/Realm/Transaction/Callback.txt +++ b/source/sdk/java/api/io/realm/Realm/Transaction/Callback.txt @@ -18,7 +18,7 @@ io.realm ======== - | `java.lang.Object `__ + | `java.lang.Object `__ | io.realm.Realm.Transaction.Callback @@ -64,7 +64,7 @@ Method Summary * - public **void** - | :ref:`onError ` ( - | `Exception `__ ignore + | `Exception `__ ignore | ) @@ -91,7 +91,7 @@ Inherited Methods -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` +- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` @@ -170,7 +170,7 @@ onError :header-rows: 1 * - | public **void** :ref:`onError ` ( - | `Exception `__ ignore + | `Exception `__ ignore | ) diff --git a/source/sdk/java/api/io/realm/Realm/Transaction/OnError.txt b/source/sdk/java/api/io/realm/Realm/Transaction/OnError.txt index 90aef1fa50..eb85864f27 100644 --- a/source/sdk/java/api/io/realm/Realm/Transaction/OnError.txt +++ b/source/sdk/java/api/io/realm/Realm/Transaction/OnError.txt @@ -41,7 +41,7 @@ Method Summary * - public **void** - | :ref:`onError ` ( - | `Throwable `__ error + | `Throwable `__ error | ) @@ -93,7 +93,7 @@ onError :header-rows: 1 * - | public **void** :ref:`onError ` ( - | `Throwable `__ error + | `Throwable `__ error | ) diff --git a/source/sdk/java/api/io/realm/RealmAny.txt b/source/sdk/java/api/io/realm/RealmAny.txt new file mode 100644 index 0000000000..042a6630df --- /dev/null +++ b/source/sdk/java/api/io/realm/RealmAny.txt @@ -0,0 +1,2368 @@ + +.. contents:: On this page + :local: + :backlinks: none + :depth: 2 + :class: singlecol + + + +Class RealmAny +^^^^^^^^^^^^^^ + +.. _io_realm_RealmAny: + + + +io.realm +======== + + + | `java.lang.Object `__ + | io.realm.RealmAny + + +:ref:`io.realm.RealmAny ` is used to represent a polymorphic Realm value. + +At any particular moment an instance of this class stores a definite value of a definite type. If, for instance, that is an double value, you may call asDouble() to extract that value. You may call getType() to discover what type of value is currently stored. Calling asDouble() on an instance that does not store an double would raise a `java.lang.ClassCastException `__ . + + + +RealmAny behaves like a value type on all the supported types except on Realm objects. It means that Realm will not persist any change to the RealmAny value except when the type is Realm object. When a RealmAny holds a Realm object, it just holds the reference to it, not a copy of the object. So modifications to the Realm object are reflected in the RealmAny value, including if the object is deleted. Because RealmAny instances are immutable, a new instance is needed to update a RealmAny attribute. + + + +.. code-block:: java + + + anObject.realmAnyAttribute = RealmAny.valueOf(5); + anObject.realmAnyAttribute = RealmAny.valueOf(10.f); + + + +It is crucial to understand that the act of extracting a value of a particular type requires definite knowledge about the stored type. Calling a getter method for any particular type, that is not the same type as the stored value, would raise an exception.Our recommendation to handle the RealmAny polymorphism is to write a switch case around the RealmAny type and its inner value class. + + + +.. code-block:: java + + + RealmAny realmAny = aRealmObject.realmAnyAttribute; + + switch (realmAny.getType()) { + case OBJECT: + if (realmAny.getValueClass().equals(DogRealmModel.class)) { + DogRealmModel value = realmAny.asRealmModel(DogRealmModel.class); + } + case INTEGER: + performAction(realmAny.asInteger()); + break; + case BOOLEAN: + performAction(realmAny.asBoolean()); + break; + case STRING: + performAction(realmAny.asString()); + break; + case BINARY: + performAction(realmAny.asBinary()); + break; + case DATE: + performAction(realmAny.asDate()); + break; + case FLOAT: + performAction(realmAny.asFloat()); + break; + case DOUBLE: + performAction(realmAny.asDouble()); + break; + case DECIMAL128: + performAction(realmAny.asDecimal128()); + break; + case OBJECT_ID: + performAction(realmAny.asObjectId()); + break; + case UUID: + performAction(realmAny.asUUID()); + break; + case NULL: + performNullAction(); + break; + } + + + +getValueClass() returns the Java class that represents the inner value wrapped by the RealmAny instance. If the resulting class is a realization of :ref:`io.realm.RealmModel ` asRealmModel() can be called to cast the RealmAny value to a Realm object reference. + + + +RealmAny values can also be sorted. The sorting order used between different RealmAny types, from lowest to highest, is: + + + +1. Boolean + + +#. Byte/Short/Integer/Long/Float/Double/Decimal128 + + +#. byte[]/String + + +#. Date + + +#. ObjectId + + +#. UUID + + +#. RealmObject + + + + +This has implications on how :ref:`RealmQuery.sort(String) ` , :ref:`RealmQuery.minRealmAny(String) ` and :ref:`RealmQuery.maxRealmAny(String) ` work. Especially ``min()`` and ``max()`` will not only take numeric fields into account, but will use the sorting order to determine the "largest" or "lowest" value. + + + + +Nested Class Summary +==================== + +.. list-table:: + :header-rows: 1 + + * - Modifier and Type + - Class and Description + + * - ``public static final`` + - :ref:`RealmAny.Type ` + + + + + +Method Summary +============== + +.. list-table:: + :header-rows: 1 + + * - Modifier and Type + - Method and Description + + * - public **byte** + - | :ref:`asBinary ` () + | + + + Gets this value as a byte[] if it is one, otherwise throws exception. + + + + + * - public `Boolean `__ + - | :ref:`asBoolean ` () + | + + + Gets this value as a Boolean if it is one, otherwise throws exception. + + + + + * - public `Byte `__ + - | :ref:`asByte ` () + | + + + Gets this value as a Byte if it is one, otherwise throws exception. + + + + + * - public `Date `__ + - | :ref:`asDate ` () + | + + + Gets this value as a Date if it is one, otherwise throws exception. + + + + + * - public **Decimal128** + - | :ref:`asDecimal128 ` () + | + + + Gets this value as a Decimal128 if it is one, otherwise throws exception. + + + + + * - public `Double `__ + - | :ref:`asDouble ` () + | + + + Gets this value as a Double if it is one, otherwise throws exception. + + + + + * - public `Float `__ + - | :ref:`asFloat ` () + | + + + Gets this value as a Float if it is one, otherwise throws exception. + + + + + * - public `Integer `__ + - | :ref:`asInteger ` () + | + + + Gets this value as a Integer if it is one, otherwise throws exception. + + + + + * - public `Long `__ + - | :ref:`asLong ` () + | + + + Gets this value as a Long if it is one, otherwise throws exception. + + + + + * - public **ObjectId** + - | :ref:`asObjectId ` () + | + + + Gets this value as a ObjectId if it is one, otherwise throws exception. + + + + + * - public **T** + - | :ref:`asRealmModel ` <**T** >( + | `java.lang.Class\ `__ clazz + | ) + + + Gets this value as a RealmModel if it is one, otherwise throws exception. + + + + + * - public `Short `__ + - | :ref:`asShort ` () + | + + + Gets this value as a Short if it is one, otherwise throws exception. + + + + + * - public `String `__ + - | :ref:`asString ` () + | + + + Gets this value as a String if it is one, otherwise throws exception. + + + + + * - public `UUID `__ + - | :ref:`asUUID ` () + | + + + Gets this value as a UUID if it is one, otherwise throws exception. + + + + + * - public final **boolean** + - | :ref:`coercedEquals ` ( + | :ref:`RealmAny ` other + | ) + + + + + + + + * - public final **boolean** + - | :ref:`equals ` ( + | `Object `__ other + | ) + + + Two ``RealmAny`` s are ``.equals`` if and only if their contents are equal. + + + + + + + * - public :ref:`RealmAny.Type ` + - | :ref:`getType ` () + | + + + Gets the inner type of this RealmAny object. + + + + + * - public `Class `__ + - | :ref:`getValueClass ` () + | + + + Returns the Java class that represents the inner value wrapped by this RealmAny value. + + + + + * - public final **int** + - | :ref:`hashCode ` () + | + + + A ``RealmAny`` 's hash code is, exactly, the hash code of its value. + + + + + + + * - public **boolean** + - | :ref:`isNull ` () + | + + + Returns true if the inner value is null, false otherwise. + + + + + * - public static :ref:`RealmAny ` + - | :ref:`nullValue ` () + | + + + Creates a new RealmAny of a null value. + + + + + * - public `String `__ + - | :ref:`toString ` () + | + + + + + + + + * - public static :ref:`RealmAny ` + - | :ref:`valueOf ` ( + | **Decimal128** value + | ) + + + Creates a new RealmAny with the specified value. + + + + + * - public static :ref:`RealmAny ` + - | :ref:`valueOf ` ( + | **ObjectId** value + | ) + + + Creates a new RealmAny with the specified value. + + + + + * - public static :ref:`RealmAny ` + - | :ref:`valueOf ` ( + | `Date `__ value + | ) + + + Creates a new RealmAny with the specified value. + + + + + * - public static :ref:`RealmAny ` + - | :ref:`valueOf ` ( + | **byte[]** value + | ) + + + Creates a new RealmAny with the specified value. + + + + + * - public static :ref:`RealmAny ` + - | :ref:`valueOf ` ( + | `String `__ value + | ) + + + Creates a new RealmAny with the specified value. + + + + + * - public static :ref:`RealmAny ` + - | :ref:`valueOf ` ( + | `Double `__ value + | ) + + + Creates a new RealmAny with the specified value. + + + + + * - public static :ref:`RealmAny ` + - | :ref:`valueOf ` ( + | `Float `__ value + | ) + + + Creates a new RealmAny with the specified value. + + + + + * - public static :ref:`RealmAny ` + - | :ref:`valueOf ` ( + | `Boolean `__ value + | ) + + + Creates a new RealmAny with the specified value. + + + + + * - public static :ref:`RealmAny ` + - | :ref:`valueOf ` ( + | `Long `__ value + | ) + + + Creates a new RealmAny with the specified value. + + + + + * - public static :ref:`RealmAny ` + - | :ref:`valueOf ` ( + | `Integer `__ value + | ) + + + Creates a new RealmAny with the specified value. + + + + + * - public static :ref:`RealmAny ` + - | :ref:`valueOf ` ( + | `Short `__ value + | ) + + + Creates a new RealmAny with the specified value. + + + + + * - public static :ref:`RealmAny ` + - | :ref:`valueOf ` ( + | `Byte `__ value + | ) + + + Creates a new RealmAny with the specified value. + + + + + + + +Inherited Methods +================= + + + +- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` + + + + +Method Detail +============= + +.. _asBinary: + +.. _asBinary__: + +.. _RealmAny_asBinary: + +.. _RealmAny_asBinary__: + +.. _io_realm_RealmAny_asBinary: + +.. _io_realm_RealmAny_asBinary__: + + + +asBinary +-------- + +.. list-table:: + :header-rows: 1 + + * - | public **byte** :ref:`asBinary ` () + | + + + + + * - Gets this value as a byte[] if it is one, otherwise throws exception. + + + + + + + **Returns** + + a byte[]. + + + + + **Throws** + + - `java.lang.ClassCastException `__ - if this value is not of the expected type. + + + + + + + + + + + + +.. _asBoolean: + +.. _asBoolean__: + +.. _RealmAny_asBoolean: + +.. _RealmAny_asBoolean__: + +.. _io_realm_RealmAny_asBoolean: + +.. _io_realm_RealmAny_asBoolean__: + + + +asBoolean +--------- + +.. list-table:: + :header-rows: 1 + + * - | public `Boolean `__ :ref:`asBoolean ` () + | + + + + + * - Gets this value as a Boolean if it is one, otherwise throws exception. + + + + + + + **Returns** + + a Boolean. + + + + + **Throws** + + - `java.lang.ClassCastException `__ - if this value is not of the expected type. + + + + + + + + + + + + +.. _asByte: + +.. _asByte__: + +.. _RealmAny_asByte: + +.. _RealmAny_asByte__: + +.. _io_realm_RealmAny_asByte: + +.. _io_realm_RealmAny_asByte__: + + + +asByte +------ + +.. list-table:: + :header-rows: 1 + + * - | public `Byte `__ :ref:`asByte ` () + | + + + + + * - Gets this value as a Byte if it is one, otherwise throws exception. + + + + + + + **Returns** + + a Byte. + + + + + **Throws** + + - `java.lang.ClassCastException `__ - if this value is not of the expected type. + + + + + + + + + + + + +.. _asDate: + +.. _asDate__: + +.. _RealmAny_asDate: + +.. _RealmAny_asDate__: + +.. _io_realm_RealmAny_asDate: + +.. _io_realm_RealmAny_asDate__: + + + +asDate +------ + +.. list-table:: + :header-rows: 1 + + * - | public `Date `__ :ref:`asDate ` () + | + + + + + * - Gets this value as a Date if it is one, otherwise throws exception. + + + + + + + **Returns** + + a Date. + + + + + **Throws** + + - `java.lang.ClassCastException `__ - if this value is not of the expected type. + + + + + + + + + + + + +.. _asDecimal128: + +.. _asDecimal128__: + +.. _RealmAny_asDecimal128: + +.. _RealmAny_asDecimal128__: + +.. _io_realm_RealmAny_asDecimal128: + +.. _io_realm_RealmAny_asDecimal128__: + + + +asDecimal128 +------------ + +.. list-table:: + :header-rows: 1 + + * - | public **Decimal128** :ref:`asDecimal128 ` () + | + + + + + * - Gets this value as a Decimal128 if it is one, otherwise throws exception. + + + + + + + **Returns** + + a Decimal128. + + + + + **Throws** + + - `java.lang.ClassCastException `__ - if this value is not of the expected type. + + + + + + + + + + + + +.. _asDouble: + +.. _asDouble__: + +.. _RealmAny_asDouble: + +.. _RealmAny_asDouble__: + +.. _io_realm_RealmAny_asDouble: + +.. _io_realm_RealmAny_asDouble__: + + + +asDouble +-------- + +.. list-table:: + :header-rows: 1 + + * - | public `Double `__ :ref:`asDouble ` () + | + + + + + * - Gets this value as a Double if it is one, otherwise throws exception. + + + + + + + **Returns** + + a Double. + + + + + **Throws** + + - `java.lang.ClassCastException `__ - if this value is not of the expected type. + + + + + + + + + + + + +.. _asFloat: + +.. _asFloat__: + +.. _RealmAny_asFloat: + +.. _RealmAny_asFloat__: + +.. _io_realm_RealmAny_asFloat: + +.. _io_realm_RealmAny_asFloat__: + + + +asFloat +------- + +.. list-table:: + :header-rows: 1 + + * - | public `Float `__ :ref:`asFloat ` () + | + + + + + * - Gets this value as a Float if it is one, otherwise throws exception. + + + + + + + **Returns** + + a Float. + + + + + **Throws** + + - `java.lang.ClassCastException `__ - if this value is not of the expected type. + + + + + + + + + + + + +.. _asInteger: + +.. _asInteger__: + +.. _RealmAny_asInteger: + +.. _RealmAny_asInteger__: + +.. _io_realm_RealmAny_asInteger: + +.. _io_realm_RealmAny_asInteger__: + + + +asInteger +--------- + +.. list-table:: + :header-rows: 1 + + * - | public `Integer `__ :ref:`asInteger ` () + | + + + + + * - Gets this value as a Integer if it is one, otherwise throws exception. + + + + + + + **Returns** + + an Integer. + + + + + **Throws** + + - `java.lang.ClassCastException `__ - if this value is not of the expected type. + + + + + + + + + + + + +.. _asLong: + +.. _asLong__: + +.. _RealmAny_asLong: + +.. _RealmAny_asLong__: + +.. _io_realm_RealmAny_asLong: + +.. _io_realm_RealmAny_asLong__: + + + +asLong +------ + +.. list-table:: + :header-rows: 1 + + * - | public `Long `__ :ref:`asLong ` () + | + + + + + * - Gets this value as a Long if it is one, otherwise throws exception. + + + + + + + **Returns** + + a Long. + + + + + **Throws** + + - `java.lang.ClassCastException `__ - if this value is not of the expected type. + + + + + + + + + + + + +.. _asObjectId: + +.. _asObjectId__: + +.. _RealmAny_asObjectId: + +.. _RealmAny_asObjectId__: + +.. _io_realm_RealmAny_asObjectId: + +.. _io_realm_RealmAny_asObjectId__: + + + +asObjectId +---------- + +.. list-table:: + :header-rows: 1 + + * - | public **ObjectId** :ref:`asObjectId ` () + | + + + + + * - Gets this value as a ObjectId if it is one, otherwise throws exception. + + + + + + + **Returns** + + an ObjectId. + + + + + **Throws** + + - `java.lang.ClassCastException `__ - if this value is not of the expected type. + + + + + + + + + + + + +.. _asRealmModel: + +.. _asRealmModel__: + +.. _RealmAny_asRealmModel: + +.. _RealmAny_asRealmModel__: + +.. _io_realm_RealmAny_asRealmModel: + +.. _io_realm_RealmAny_asRealmModel__: + + + +asRealmModel +------------ + +.. _io_realm_RealmAny_asRealmModel_java_lang_Class_: + +.. _io_realm_RealmAny_asRealmModel_Class_: + +.. _asRealmModel_java_lang_Class_: + +.. _asRealmModel_Class_: + +.. _RealmAny_asRealmModel_java_lang_Class_: + +.. _RealmAny_asRealmModel_Class_: + +.. _io_realm_RealmAny_asRealmModel_Class_T__: + +.. list-table:: + :header-rows: 1 + + * - | public **T** :ref:`asRealmModel ` <**T** >( + | `java.lang.Class\ `__ clazz + | ) + + + + + * - Gets this value as a RealmModel if it is one, otherwise throws exception. + + + **Type Parameters** + + - ``T`` - the RealmModel type to cast the inner value to. + + + + + + + + + + **Returns** + + a RealmModel of the T type. + + + + + **Throws** + + - `java.lang.ClassCastException `__ - if this value is not of the expected type. + + + + + + + + + + + + +.. _asShort: + +.. _asShort__: + +.. _RealmAny_asShort: + +.. _RealmAny_asShort__: + +.. _io_realm_RealmAny_asShort: + +.. _io_realm_RealmAny_asShort__: + + + +asShort +------- + +.. list-table:: + :header-rows: 1 + + * - | public `Short `__ :ref:`asShort ` () + | + + + + + * - Gets this value as a Short if it is one, otherwise throws exception. + + + + + + + **Returns** + + a Short. + + + + + **Throws** + + - `java.lang.ClassCastException `__ - if this value is not of the expected type. + + + + + + + + + + + + +.. _asString: + +.. _asString__: + +.. _RealmAny_asString: + +.. _RealmAny_asString__: + +.. _io_realm_RealmAny_asString: + +.. _io_realm_RealmAny_asString__: + + + +asString +-------- + +.. list-table:: + :header-rows: 1 + + * - | public `String `__ :ref:`asString ` () + | + + + + + * - Gets this value as a String if it is one, otherwise throws exception. + + + + + + + **Returns** + + a String. + + + + + **Throws** + + - `java.lang.ClassCastException `__ - if this value is not of the expected type. + + + + + + + + + + + + +.. _asUUID: + +.. _asUUID__: + +.. _RealmAny_asUUID: + +.. _RealmAny_asUUID__: + +.. _io_realm_RealmAny_asUUID: + +.. _io_realm_RealmAny_asUUID__: + + + +asUUID +------ + +.. list-table:: + :header-rows: 1 + + * - | public `UUID `__ :ref:`asUUID ` () + | + + + + + * - Gets this value as a UUID if it is one, otherwise throws exception. + + + + + + + **Returns** + + an UUID. + + + + + **Throws** + + - `java.lang.ClassCastException `__ - if this value is not of the expected type. + + + + + + + + + + + + +.. _coercedEquals: + +.. _coercedEquals__: + +.. _RealmAny_coercedEquals: + +.. _RealmAny_coercedEquals__: + +.. _io_realm_RealmAny_coercedEquals: + +.. _io_realm_RealmAny_coercedEquals__: + + + +coercedEquals +------------- + +.. _io_realm_RealmAny_coercedEquals_io_realm_RealmAny_: + +.. _io_realm_RealmAny_coercedEquals_RealmAny_: + +.. _coercedEquals_io_realm_RealmAny_: + +.. _coercedEquals_RealmAny_: + +.. _RealmAny_coercedEquals_io_realm_RealmAny_: + +.. _RealmAny_coercedEquals_RealmAny_: + +.. list-table:: + :header-rows: 1 + + * - | public final **boolean** :ref:`coercedEquals ` ( + | :ref:`RealmAny ` other + | ) + + + + + * - + + + + + + + + + + + + + + + +.. _equals: + +.. _equals__: + +.. _RealmAny_equals: + +.. _RealmAny_equals__: + +.. _io_realm_RealmAny_equals: + +.. _io_realm_RealmAny_equals__: + + + +equals +------ + +.. _io_realm_RealmAny_equals_java_lang_Object_: + +.. _io_realm_RealmAny_equals_Object_: + +.. _equals_java_lang_Object_: + +.. _equals_Object_: + +.. _RealmAny_equals_java_lang_Object_: + +.. _RealmAny_equals_Object_: + +.. list-table:: + :header-rows: 1 + + * - | public final **boolean** :ref:`equals ` ( + | `Object `__ other + | ) + + + + + * - Two ``RealmAny`` s are ``.equals`` if and only if their contents are equal. + + + + + + + **Parameters** + + - ``other`` - compare target + + + + + + + + **Returns** + + true if the target has the same value + + + + + + + **Overrides** + + ``equals`` in class `Object `__ + + + + + + +.. _getType: + +.. _getType__: + +.. _RealmAny_getType: + +.. _RealmAny_getType__: + +.. _io_realm_RealmAny_getType: + +.. _io_realm_RealmAny_getType__: + + + +getType +------- + +.. list-table:: + :header-rows: 1 + + * - | public :ref:`RealmAny.Type ` :ref:`getType ` () + | + + + + + * - Gets the inner type of this RealmAny object. + + + + + + + **Returns** + + the inner RealmAny.Type + + + + + + + + + + + +.. _getValueClass: + +.. _getValueClass__: + +.. _RealmAny_getValueClass: + +.. _RealmAny_getValueClass__: + +.. _io_realm_RealmAny_getValueClass: + +.. _io_realm_RealmAny_getValueClass__: + + + +getValueClass +------------- + +.. list-table:: + :header-rows: 1 + + * - | public `Class `__ :ref:`getValueClass ` () + | + + + + + * - Returns the Java class that represents the inner value wrapped by this RealmAny value. + + + + + + + **Returns** + + the class that represents the inner value wrapped by this RealmAny value. + + + + + + + + + + + +.. _hashCode: + +.. _hashCode__: + +.. _RealmAny_hashCode: + +.. _RealmAny_hashCode__: + +.. _io_realm_RealmAny_hashCode: + +.. _io_realm_RealmAny_hashCode__: + + + +hashCode +-------- + +.. list-table:: + :header-rows: 1 + + * - | public final **int** :ref:`hashCode ` () + | + + + + + * - A ``RealmAny`` 's hash code is, exactly, the hash code of its value. + + + + + + + + + **Returns** + + true if the target has the same value + + + + + **Throws** + + - `NullPointerException `__ - if the inner value is null + + + + + + + + **Overrides** + + ``hashCode`` in class `Object `__ + + + + + + +.. _isNull: + +.. _isNull__: + +.. _RealmAny_isNull: + +.. _RealmAny_isNull__: + +.. _io_realm_RealmAny_isNull: + +.. _io_realm_RealmAny_isNull__: + + + +isNull +------ + +.. list-table:: + :header-rows: 1 + + * - | public **boolean** :ref:`isNull ` () + | + + + + + * - Returns true if the inner value is null, false otherwise. + + + + + + + **Returns** + + true if the inner value is null, false otherwise. + + + + + + + + + + + +.. _nullValue: + +.. _nullValue__: + +.. _RealmAny_nullValue: + +.. _RealmAny_nullValue__: + +.. _io_realm_RealmAny_nullValue: + +.. _io_realm_RealmAny_nullValue__: + + + +nullValue +--------- + +.. list-table:: + :header-rows: 1 + + * - | public static :ref:`RealmAny ` :ref:`nullValue ` () + | + + + + + * - Creates a new RealmAny of a null value. + + + + + + + **Returns** + + a new RealmAny instance of a null value. + + + + + + + + + + + +.. _toString: + +.. _toString__: + +.. _RealmAny_toString: + +.. _RealmAny_toString__: + +.. _io_realm_RealmAny_toString: + +.. _io_realm_RealmAny_toString__: + + + +toString +-------- + +.. list-table:: + :header-rows: 1 + + * - | public `String `__ :ref:`toString ` () + | + + + + + * - + + + + + + + + + + + **Overrides** + + ``toString`` in class `Object `__ + + + + + + +.. _valueOf: + +.. _valueOf__: + +.. _RealmAny_valueOf: + +.. _RealmAny_valueOf__: + +.. _io_realm_RealmAny_valueOf: + +.. _io_realm_RealmAny_valueOf__: + + + +valueOf +------- + +.. _io_realm_RealmAny_valueOf_Decimal128_: + +.. _valueOf_Decimal128_: + +.. _RealmAny_valueOf_Decimal128_: + +.. list-table:: + :header-rows: 1 + + * - | public static :ref:`RealmAny ` :ref:`valueOf ` ( + | **Decimal128** value + | ) + + + + + * - Creates a new RealmAny with the specified value. If the value is not null the type will be :ref:`RealmAny.Type.DECIMAL128 ` , :ref:`RealmAny.Type.NULL ` otherwise. + + + + + + + **Parameters** + + - ``value`` - the RealmAny value. + + + + + + + + **Returns** + + a new RealmAny of a Decimal128. + + + + + + + + + +.. _io_realm_RealmAny_valueOf_ObjectId_: + +.. _valueOf_ObjectId_: + +.. _RealmAny_valueOf_ObjectId_: + +.. list-table:: + :header-rows: 1 + + * - | public static :ref:`RealmAny ` :ref:`valueOf ` ( + | **ObjectId** value + | ) + + + + + * - Creates a new RealmAny with the specified value. If the value is not null the type will be :ref:`RealmAny.Type.OBJECT_ID ` , :ref:`RealmAny.Type.NULL ` otherwise. + + + + + + + **Parameters** + + - ``value`` - the RealmAny value. + + + + + + + + **Returns** + + a new RealmAny of an ObjectId. + + + + + + + + + +.. _io_realm_RealmAny_valueOf_java_util_Date_: + +.. _io_realm_RealmAny_valueOf_Date_: + +.. _valueOf_java_util_Date_: + +.. _valueOf_Date_: + +.. _RealmAny_valueOf_java_util_Date_: + +.. _RealmAny_valueOf_Date_: + +.. list-table:: + :header-rows: 1 + + * - | public static :ref:`RealmAny ` :ref:`valueOf ` ( + | `Date `__ value + | ) + + + + + * - Creates a new RealmAny with the specified value. If the value is not null the type will be :ref:`RealmAny.Type.DATE ` , :ref:`RealmAny.Type.NULL ` otherwise. + + + + + + + **Parameters** + + - ``value`` - the RealmAny value. + + + + + + + + **Returns** + + a new RealmAny of a Date. + + + + + + + + + +.. _io_realm_RealmAny_valueOf_byte_: + +.. _io_realm_RealmAny_valueOf_byte____: + +.. _valueOf_byte_: + +.. _valueOf_byte____: + +.. _RealmAny_valueOf_byte_: + +.. _RealmAny_valueOf_byte____: + +.. _io_realm_RealmAny_valueOf_byte[]_: + +.. list-table:: + :header-rows: 1 + + * - | public static :ref:`RealmAny ` :ref:`valueOf ` ( + | **byte[]** value + | ) + + + + + * - Creates a new RealmAny with the specified value. If the value is not null the type will be :ref:`RealmAny.Type.BINARY ` , :ref:`RealmAny.Type.NULL ` otherwise. + + + + + + + **Parameters** + + - ``value`` - the RealmAny value. + + + + + + + + **Returns** + + a new RealmAny of a byte[]. + + + + + + + + + +.. _io_realm_RealmAny_valueOf_java_lang_String_: + +.. _io_realm_RealmAny_valueOf_String_: + +.. _valueOf_java_lang_String_: + +.. _valueOf_String_: + +.. _RealmAny_valueOf_java_lang_String_: + +.. _RealmAny_valueOf_String_: + +.. list-table:: + :header-rows: 1 + + * - | public static :ref:`RealmAny ` :ref:`valueOf ` ( + | `String `__ value + | ) + + + + + * - Creates a new RealmAny with the specified value. If the value is not null the type will be :ref:`RealmAny.Type.STRING ` , :ref:`RealmAny.Type.NULL ` otherwise. + + + + + + + **Parameters** + + - ``value`` - the RealmAny value. + + + + + + + + **Returns** + + a new RealmAny of a String. + + + + + + + + + +.. _io_realm_RealmAny_valueOf_java_lang_Double_: + +.. _io_realm_RealmAny_valueOf_Double_: + +.. _valueOf_java_lang_Double_: + +.. _valueOf_Double_: + +.. _RealmAny_valueOf_java_lang_Double_: + +.. _RealmAny_valueOf_Double_: + +.. list-table:: + :header-rows: 1 + + * - | public static :ref:`RealmAny ` :ref:`valueOf ` ( + | `Double `__ value + | ) + + + + + * - Creates a new RealmAny with the specified value. If the value is not null the type will be :ref:`RealmAny.Type.DOUBLE ` , :ref:`RealmAny.Type.NULL ` otherwise. + + + + + + + **Parameters** + + - ``value`` - the RealmAny value. + + + + + + + + **Returns** + + a new RealmAny of a Double. + + + + + + + + + +.. _io_realm_RealmAny_valueOf_java_lang_Float_: + +.. _io_realm_RealmAny_valueOf_Float_: + +.. _valueOf_java_lang_Float_: + +.. _valueOf_Float_: + +.. _RealmAny_valueOf_java_lang_Float_: + +.. _RealmAny_valueOf_Float_: + +.. list-table:: + :header-rows: 1 + + * - | public static :ref:`RealmAny ` :ref:`valueOf ` ( + | `Float `__ value + | ) + + + + + * - Creates a new RealmAny with the specified value. If the value is not null the type will be :ref:`RealmAny.Type.FLOAT ` , :ref:`RealmAny.Type.NULL ` otherwise. + + + + + + + **Parameters** + + - ``value`` - the RealmAny value. + + + + + + + + **Returns** + + a new RealmAny of a Float. + + + + + + + + + +.. _io_realm_RealmAny_valueOf_java_lang_Boolean_: + +.. _io_realm_RealmAny_valueOf_Boolean_: + +.. _valueOf_java_lang_Boolean_: + +.. _valueOf_Boolean_: + +.. _RealmAny_valueOf_java_lang_Boolean_: + +.. _RealmAny_valueOf_Boolean_: + +.. list-table:: + :header-rows: 1 + + * - | public static :ref:`RealmAny ` :ref:`valueOf ` ( + | `Boolean `__ value + | ) + + + + + * - Creates a new RealmAny with the specified value. If the value is not null the type will be :ref:`RealmAny.Type.BOOLEAN ` , :ref:`RealmAny.Type.NULL ` otherwise. + + + + + + + **Parameters** + + - ``value`` - the RealmAny value. + + + + + + + + **Returns** + + a new RealmAny of a Boolean. + + + + + + + + + +.. _io_realm_RealmAny_valueOf_java_lang_Long_: + +.. _io_realm_RealmAny_valueOf_Long_: + +.. _valueOf_java_lang_Long_: + +.. _valueOf_Long_: + +.. _RealmAny_valueOf_java_lang_Long_: + +.. _RealmAny_valueOf_Long_: + +.. list-table:: + :header-rows: 1 + + * - | public static :ref:`RealmAny ` :ref:`valueOf ` ( + | `Long `__ value + | ) + + + + + * - Creates a new RealmAny with the specified value. If the value is not null the type will be :ref:`RealmAny.Type.INTEGER ` , :ref:`RealmAny.Type.NULL ` otherwise. + + + + + + + **Parameters** + + - ``value`` - the RealmAny value. + + + + + + + + **Returns** + + a new RealmAny of a Long. + + + + + + + + + +.. _io_realm_RealmAny_valueOf_java_lang_Integer_: + +.. _io_realm_RealmAny_valueOf_Integer_: + +.. _valueOf_java_lang_Integer_: + +.. _valueOf_Integer_: + +.. _RealmAny_valueOf_java_lang_Integer_: + +.. _RealmAny_valueOf_Integer_: + +.. list-table:: + :header-rows: 1 + + * - | public static :ref:`RealmAny ` :ref:`valueOf ` ( + | `Integer `__ value + | ) + + + + + * - Creates a new RealmAny with the specified value. If the value is not null the type will be :ref:`RealmAny.Type.INTEGER ` , :ref:`RealmAny.Type.NULL ` otherwise. + + + + + + + **Parameters** + + - ``value`` - the RealmAny value. + + + + + + + + **Returns** + + a new RealmAny of a Integer. + + + + + + + + + +.. _io_realm_RealmAny_valueOf_java_lang_Short_: + +.. _io_realm_RealmAny_valueOf_Short_: + +.. _valueOf_java_lang_Short_: + +.. _valueOf_Short_: + +.. _RealmAny_valueOf_java_lang_Short_: + +.. _RealmAny_valueOf_Short_: + +.. list-table:: + :header-rows: 1 + + * - | public static :ref:`RealmAny ` :ref:`valueOf ` ( + | `Short `__ value + | ) + + + + + * - Creates a new RealmAny with the specified value. If the value is not null the type will be :ref:`RealmAny.Type.INTEGER ` , :ref:`RealmAny.Type.NULL ` otherwise. + + + + + + + **Parameters** + + - ``value`` - the RealmAny value. + + + + + + + + **Returns** + + a new RealmAny of a Short. + + + + + + + + + +.. _io_realm_RealmAny_valueOf_java_lang_Byte_: + +.. _io_realm_RealmAny_valueOf_Byte_: + +.. _valueOf_java_lang_Byte_: + +.. _valueOf_Byte_: + +.. _RealmAny_valueOf_java_lang_Byte_: + +.. _RealmAny_valueOf_Byte_: + +.. list-table:: + :header-rows: 1 + + * - | public static :ref:`RealmAny ` :ref:`valueOf ` ( + | `Byte `__ value + | ) + + + + + * - Creates a new RealmAny with the specified value. If the value is not null the type will be :ref:`RealmAny.Type.INTEGER ` , :ref:`RealmAny.Type.NULL ` otherwise. + + + + + + + **Parameters** + + - ``value`` - the RealmAny value. + + + + + + + + **Returns** + + a new RealmAny containing a Byte value. + + + + + + + + + + + + diff --git a/source/sdk/java/api/io/realm/RealmAny/Type.txt b/source/sdk/java/api/io/realm/RealmAny/Type.txt new file mode 100644 index 0000000000..29c3ba197c --- /dev/null +++ b/source/sdk/java/api/io/realm/RealmAny/Type.txt @@ -0,0 +1,589 @@ + +.. contents:: On this page + :local: + :backlinks: none + :depth: 2 + :class: singlecol + + + +Enum RealmAny.Type +^^^^^^^^^^^^^^^^^^ + +.. _io_realm_RealmAny_Type: + + + +io.realm +======== + + + | `java.lang.Object `__ + | `java.lang.Enum `__ + | io.realm.RealmAny.Type + + + + +**Enclosing class:** + +:ref:`RealmAny ` + + + +Enum describing all the types supported by RealmAny. + + +Enum Constant Summary +===================== + +.. list-table:: + :header-rows: 1 + + * - Enum Constant and Description + + * - :ref:`BINARY ` + + + + + + + * - :ref:`BOOLEAN ` + + + + + + + * - :ref:`DATE ` + + + + + + + * - :ref:`DECIMAL128 ` + + + + + + + * - :ref:`DOUBLE ` + + + + + + + * - :ref:`FLOAT ` + + + + + + + * - :ref:`INTEGER ` + + + + + + + * - :ref:`NULL ` + + + + + + + * - :ref:`OBJECT ` + + + + + + + * - :ref:`OBJECT_ID ` + + + + + + + * - :ref:`STRING ` + + + + + + + * - :ref:`UUID ` + + + + + + + + + +Method Summary +============== + +.. list-table:: + :header-rows: 1 + + * - Modifier and Type + - Method and Description + + * - public static :ref:`RealmAny.Type ` + - | :ref:`fromNativeValue ` ( + | **int** realmFieldType + | ) + + + + + + + + * - public `Class `__ + - | :ref:`getTypedClass ` () + | + + + + + + + + * - public static :ref:`RealmAny.Type ` + - | :ref:`valueOf ` ( + | `String `__ name + | ) + + + + + + + + * - public static :ref:`RealmAny.Type ` + - | :ref:`values ` () + | + + + + + + + + + + +Inherited Methods +================= + + + +- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` +- Methods inherited from class `java.lang.Enum `__ : ``name`` , ``ordinal`` , ``toString`` , ``equals`` , ``hashCode`` , ``clone`` , ``compareTo`` , ``getDeclaringClass`` , ``valueOf`` , ``finalize`` + + + + +Enum Constant Detail +==================== + + +.. _io_realm_RealmAny_Type_BINARY: + +.. _RealmAny_Type_BINARY: + + + +``BINARY`` +----------- + +public static final :ref:`RealmAny.Type ` + + + + + +.. _io_realm_RealmAny_Type_BOOLEAN: + +.. _RealmAny_Type_BOOLEAN: + + + +``BOOLEAN`` +------------ + +public static final :ref:`RealmAny.Type ` + + + + + +.. _io_realm_RealmAny_Type_DATE: + +.. _RealmAny_Type_DATE: + + + +``DATE`` +--------- + +public static final :ref:`RealmAny.Type ` + + + + + +.. _io_realm_RealmAny_Type_DECIMAL128: + +.. _RealmAny_Type_DECIMAL128: + + + +``DECIMAL128`` +--------------- + +public static final :ref:`RealmAny.Type ` + + + + + +.. _io_realm_RealmAny_Type_DOUBLE: + +.. _RealmAny_Type_DOUBLE: + + + +``DOUBLE`` +----------- + +public static final :ref:`RealmAny.Type ` + + + + + +.. _io_realm_RealmAny_Type_FLOAT: + +.. _RealmAny_Type_FLOAT: + + + +``FLOAT`` +---------- + +public static final :ref:`RealmAny.Type ` + + + + + +.. _io_realm_RealmAny_Type_INTEGER: + +.. _RealmAny_Type_INTEGER: + + + +``INTEGER`` +------------ + +public static final :ref:`RealmAny.Type ` + + + + + +.. _io_realm_RealmAny_Type_NULL: + +.. _RealmAny_Type_NULL: + + + +``NULL`` +--------- + +public static final :ref:`RealmAny.Type ` + + + + + +.. _io_realm_RealmAny_Type_OBJECT: + +.. _RealmAny_Type_OBJECT: + + + +``OBJECT`` +----------- + +public static final :ref:`RealmAny.Type ` + + + + + +.. _io_realm_RealmAny_Type_OBJECT_ID: + +.. _RealmAny_Type_OBJECT_ID: + + + +``OBJECT_ID`` +-------------- + +public static final :ref:`RealmAny.Type ` + + + + + +.. _io_realm_RealmAny_Type_STRING: + +.. _RealmAny_Type_STRING: + + + +``STRING`` +----------- + +public static final :ref:`RealmAny.Type ` + + + + + +.. _io_realm_RealmAny_Type_UUID: + +.. _RealmAny_Type_UUID: + + + +``UUID`` +--------- + +public static final :ref:`RealmAny.Type ` + + + + + + +Method Detail +============= + +.. _fromNativeValue: + +.. _fromNativeValue__: + +.. _Type_fromNativeValue: + +.. _Type_fromNativeValue__: + +.. _RealmAny_Type_fromNativeValue: + +.. _RealmAny_Type_fromNativeValue__: + +.. _io_realm_RealmAny_Type_fromNativeValue: + +.. _io_realm_RealmAny_Type_fromNativeValue__: + + + +fromNativeValue +--------------- + +.. _io_realm_RealmAny_Type_fromNativeValue_int_: + +.. _fromNativeValue_int_: + +.. _RealmAny_Type_fromNativeValue_int_: + +.. list-table:: + :header-rows: 1 + + * - | public static :ref:`RealmAny.Type ` :ref:`fromNativeValue ` ( + | **int** realmFieldType + | ) + + + + + * - + + + + + + + + + + + + + + + +.. _getTypedClass: + +.. _getTypedClass__: + +.. _Type_getTypedClass: + +.. _Type_getTypedClass__: + +.. _RealmAny_Type_getTypedClass: + +.. _RealmAny_Type_getTypedClass__: + +.. _io_realm_RealmAny_Type_getTypedClass: + +.. _io_realm_RealmAny_Type_getTypedClass__: + + + +getTypedClass +------------- + +.. list-table:: + :header-rows: 1 + + * - | public `Class `__ :ref:`getTypedClass ` () + | + + + + + * - + + + + + + + + + + + + + + + +.. _valueOf: + +.. _valueOf__: + +.. _Type_valueOf: + +.. _Type_valueOf__: + +.. _RealmAny_Type_valueOf: + +.. _RealmAny_Type_valueOf__: + +.. _io_realm_RealmAny_Type_valueOf: + +.. _io_realm_RealmAny_Type_valueOf__: + + + +valueOf +------- + +.. _io_realm_RealmAny_Type_valueOf_java_lang_String_: + +.. _io_realm_RealmAny_Type_valueOf_String_: + +.. _valueOf_java_lang_String_: + +.. _valueOf_String_: + +.. _RealmAny_Type_valueOf_java_lang_String_: + +.. _RealmAny_Type_valueOf_String_: + +.. list-table:: + :header-rows: 1 + + * - | public static :ref:`RealmAny.Type ` :ref:`valueOf ` ( + | `String `__ name + | ) + + + + + * - + + + + + + + + + + + + + + + +.. _values: + +.. _values__: + +.. _Type_values: + +.. _Type_values__: + +.. _RealmAny_Type_values: + +.. _RealmAny_Type_values__: + +.. _io_realm_RealmAny_Type_values: + +.. _io_realm_RealmAny_Type_values__: + + + +values +------ + +.. list-table:: + :header-rows: 1 + + * - | public static :ref:`RealmAny.Type ` :ref:`values ` () + | + + + + + * - + + + + + + + + + + + + + + + + diff --git a/source/sdk/java/api/io/realm/RealmAnyNativeFunctionsImpl.txt b/source/sdk/java/api/io/realm/RealmAnyNativeFunctionsImpl.txt new file mode 100644 index 0000000000..8029b18716 --- /dev/null +++ b/source/sdk/java/api/io/realm/RealmAnyNativeFunctionsImpl.txt @@ -0,0 +1,394 @@ + +.. contents:: On this page + :local: + :backlinks: none + :depth: 2 + :class: singlecol + + + +Class RealmAnyNativeFunctionsImpl +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. _io_realm_RealmAnyNativeFunctionsImpl: + + + +io.realm +======== + + + | `java.lang.Object `__ + | io.realm.RealmAnyNativeFunctionsImpl + + + + + +Constructors +============ + +.. list-table:: + :header-rows: 1 + + * - Constructor and Description + + * - | :ref:`RealmAnyNativeFunctionsImpl ` () + | + + + + + + + + + + +Method Summary +============== + +.. list-table:: + :header-rows: 1 + + * - Modifier and Type + - Method and Description + + * - public **void** + - | :ref:`callRawPredicate ` ( + | **TableQuery** query, + | **OsKeyPathMapping** mapping, + | `String `__ predicate, + | :ref:`io.realm.RealmAny[] ` arguments + | ) + + + + + + + + * - public **void** + - | :ref:`handleItem ` ( + | **long** containerPtr, + | `java.util.Map.Entry\ `__ entry + | ) + + + + + + + + * - public **void** + - | :ref:`handleItem ` ( + | **long** listPtr, + | :ref:`RealmAny ` realmAny + | ) + + + + + + + + + + +Inherited Methods +================= + + + +- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` + + + + +Constructor Detail +================== + +.. _RealmAnyNativeFunctionsImpl: + +.. _RealmAnyNativeFunctionsImpl__: + +.. _io_realm_RealmAnyNativeFunctionsImpl: + +.. _io_realm_RealmAnyNativeFunctionsImpl__: + +.. list-table:: + :header-rows: 1 + + * - | public :ref:`RealmAnyNativeFunctionsImpl ` () + | + + + + + * - + + + + + + + + + + + + + +Method Detail +============= + +.. _callRawPredicate: + +.. _callRawPredicate__: + +.. _RealmAnyNativeFunctionsImpl_callRawPredicate: + +.. _RealmAnyNativeFunctionsImpl_callRawPredicate__: + +.. _io_realm_RealmAnyNativeFunctionsImpl_callRawPredicate: + +.. _io_realm_RealmAnyNativeFunctionsImpl_callRawPredicate__: + + + +callRawPredicate +---------------- + +.. _io_realm_RealmAnyNativeFunctionsImpl_callRawPredicate_TableQuery_OsKeyPathMapping_java_lang_String_io_realm_RealmAny_: + +.. _io_realm_RealmAnyNativeFunctionsImpl_callRawPredicate_TableQuery__OsKeyPathMapping__java_lang_String__io_realm_RealmAny_: + +.. _io_realm_RealmAnyNativeFunctionsImpl_callRawPredicate_TableQuery_OsKeyPathMapping_java_lang_String_RealmAny_: + +.. _io_realm_RealmAnyNativeFunctionsImpl_callRawPredicate_TableQuery__OsKeyPathMapping__java_lang_String__RealmAny_: + +.. _io_realm_RealmAnyNativeFunctionsImpl_callRawPredicate_TableQuery_OsKeyPathMapping_java_lang_String_RealmAny____: + +.. _io_realm_RealmAnyNativeFunctionsImpl_callRawPredicate_TableQuery__OsKeyPathMapping__java_lang_String__RealmAny____: + +.. _io_realm_RealmAnyNativeFunctionsImpl_callRawPredicate_TableQuery_OsKeyPathMapping_String_io_realm_RealmAny_: + +.. _io_realm_RealmAnyNativeFunctionsImpl_callRawPredicate_TableQuery__OsKeyPathMapping__String__io_realm_RealmAny_: + +.. _io_realm_RealmAnyNativeFunctionsImpl_callRawPredicate_TableQuery_OsKeyPathMapping_String_RealmAny_: + +.. _io_realm_RealmAnyNativeFunctionsImpl_callRawPredicate_TableQuery__OsKeyPathMapping__String__RealmAny_: + +.. _io_realm_RealmAnyNativeFunctionsImpl_callRawPredicate_TableQuery_OsKeyPathMapping_String_RealmAny____: + +.. _io_realm_RealmAnyNativeFunctionsImpl_callRawPredicate_TableQuery__OsKeyPathMapping__String__RealmAny____: + +.. _callRawPredicate_TableQuery_OsKeyPathMapping_java_lang_String_io_realm_RealmAny_: + +.. _callRawPredicate_TableQuery__OsKeyPathMapping__java_lang_String__io_realm_RealmAny_: + +.. _callRawPredicate_TableQuery_OsKeyPathMapping_java_lang_String_RealmAny_: + +.. _callRawPredicate_TableQuery__OsKeyPathMapping__java_lang_String__RealmAny_: + +.. _callRawPredicate_TableQuery_OsKeyPathMapping_java_lang_String_RealmAny____: + +.. _callRawPredicate_TableQuery__OsKeyPathMapping__java_lang_String__RealmAny____: + +.. _callRawPredicate_TableQuery_OsKeyPathMapping_String_io_realm_RealmAny_: + +.. _callRawPredicate_TableQuery__OsKeyPathMapping__String__io_realm_RealmAny_: + +.. _callRawPredicate_TableQuery_OsKeyPathMapping_String_RealmAny_: + +.. _callRawPredicate_TableQuery__OsKeyPathMapping__String__RealmAny_: + +.. _callRawPredicate_TableQuery_OsKeyPathMapping_String_RealmAny____: + +.. _callRawPredicate_TableQuery__OsKeyPathMapping__String__RealmAny____: + +.. _RealmAnyNativeFunctionsImpl_callRawPredicate_TableQuery_OsKeyPathMapping_java_lang_String_io_realm_RealmAny_: + +.. _RealmAnyNativeFunctionsImpl_callRawPredicate_TableQuery__OsKeyPathMapping__java_lang_String__io_realm_RealmAny_: + +.. _RealmAnyNativeFunctionsImpl_callRawPredicate_TableQuery_OsKeyPathMapping_java_lang_String_RealmAny_: + +.. _RealmAnyNativeFunctionsImpl_callRawPredicate_TableQuery__OsKeyPathMapping__java_lang_String__RealmAny_: + +.. _RealmAnyNativeFunctionsImpl_callRawPredicate_TableQuery_OsKeyPathMapping_java_lang_String_RealmAny____: + +.. _RealmAnyNativeFunctionsImpl_callRawPredicate_TableQuery__OsKeyPathMapping__java_lang_String__RealmAny____: + +.. _RealmAnyNativeFunctionsImpl_callRawPredicate_TableQuery_OsKeyPathMapping_String_io_realm_RealmAny_: + +.. _RealmAnyNativeFunctionsImpl_callRawPredicate_TableQuery__OsKeyPathMapping__String__io_realm_RealmAny_: + +.. _RealmAnyNativeFunctionsImpl_callRawPredicate_TableQuery_OsKeyPathMapping_String_RealmAny_: + +.. _RealmAnyNativeFunctionsImpl_callRawPredicate_TableQuery__OsKeyPathMapping__String__RealmAny_: + +.. _RealmAnyNativeFunctionsImpl_callRawPredicate_TableQuery_OsKeyPathMapping_String_RealmAny____: + +.. _RealmAnyNativeFunctionsImpl_callRawPredicate_TableQuery__OsKeyPathMapping__String__RealmAny____: + +.. list-table:: + :header-rows: 1 + + * - | public **void** :ref:`callRawPredicate ` ( + | **TableQuery** query, + | **OsKeyPathMapping** mapping, + | `String `__ predicate, + | :ref:`io.realm.RealmAny[] ` arguments + | ) + + + + + * - + + + + + + + + + + + + + + + +.. _handleItem: + +.. _handleItem__: + +.. _RealmAnyNativeFunctionsImpl_handleItem: + +.. _RealmAnyNativeFunctionsImpl_handleItem__: + +.. _io_realm_RealmAnyNativeFunctionsImpl_handleItem: + +.. _io_realm_RealmAnyNativeFunctionsImpl_handleItem__: + + + +handleItem +---------- + +.. _io_realm_RealmAnyNativeFunctionsImpl_handleItem_long_java_util_Map_Entry_: + +.. _io_realm_RealmAnyNativeFunctionsImpl_handleItem_long__java_util_Map_Entry_: + +.. _io_realm_RealmAnyNativeFunctionsImpl_handleItem_long_Entry_: + +.. _io_realm_RealmAnyNativeFunctionsImpl_handleItem_long__Entry_: + +.. _io_realm_RealmAnyNativeFunctionsImpl_handleItem_long_Map_Entry_: + +.. _io_realm_RealmAnyNativeFunctionsImpl_handleItem_long__Map_Entry_: + +.. _handleItem_long_java_util_Map_Entry_: + +.. _handleItem_long__java_util_Map_Entry_: + +.. _handleItem_long_Entry_: + +.. _handleItem_long__Entry_: + +.. _handleItem_long_Map_Entry_: + +.. _handleItem_long__Map_Entry_: + +.. _RealmAnyNativeFunctionsImpl_handleItem_long_java_util_Map_Entry_: + +.. _RealmAnyNativeFunctionsImpl_handleItem_long__java_util_Map_Entry_: + +.. _RealmAnyNativeFunctionsImpl_handleItem_long_Entry_: + +.. _RealmAnyNativeFunctionsImpl_handleItem_long__Entry_: + +.. _RealmAnyNativeFunctionsImpl_handleItem_long_Map_Entry_: + +.. _RealmAnyNativeFunctionsImpl_handleItem_long__Map_Entry_: + +.. _io_realm_RealmAnyNativeFunctionsImpl_handleItem_long__Map_Entry_String__RealmAny__: + +.. list-table:: + :header-rows: 1 + + * - | public **void** :ref:`handleItem ` ( + | **long** containerPtr, + | `java.util.Map.Entry\ `__ entry + | ) + + + + + * - + + + + + + + + + + + + + +.. _io_realm_RealmAnyNativeFunctionsImpl_handleItem_long_io_realm_RealmAny_: + +.. _io_realm_RealmAnyNativeFunctionsImpl_handleItem_long__io_realm_RealmAny_: + +.. _io_realm_RealmAnyNativeFunctionsImpl_handleItem_long_RealmAny_: + +.. _io_realm_RealmAnyNativeFunctionsImpl_handleItem_long__RealmAny_: + +.. _handleItem_long_io_realm_RealmAny_: + +.. _handleItem_long__io_realm_RealmAny_: + +.. _handleItem_long_RealmAny_: + +.. _handleItem_long__RealmAny_: + +.. _RealmAnyNativeFunctionsImpl_handleItem_long_io_realm_RealmAny_: + +.. _RealmAnyNativeFunctionsImpl_handleItem_long__io_realm_RealmAny_: + +.. _RealmAnyNativeFunctionsImpl_handleItem_long_RealmAny_: + +.. _RealmAnyNativeFunctionsImpl_handleItem_long__RealmAny_: + +.. list-table:: + :header-rows: 1 + + * - | public **void** :ref:`handleItem ` ( + | **long** listPtr, + | :ref:`RealmAny ` realmAny + | ) + + + + + * - + + + + + + + + + + + + + + + + diff --git a/source/sdk/java/api/io/realm/RealmAnyOperator.txt b/source/sdk/java/api/io/realm/RealmAnyOperator.txt new file mode 100644 index 0000000000..0cdb860ae0 --- /dev/null +++ b/source/sdk/java/api/io/realm/RealmAnyOperator.txt @@ -0,0 +1,171 @@ + +.. contents:: On this page + :local: + :backlinks: none + :depth: 2 + :class: singlecol + + + +Class RealmAnyOperator +^^^^^^^^^^^^^^^^^^^^^^ + +.. _io_realm_RealmAnyOperator: + + + +io.realm +======== + + + | `java.lang.Object `__ + | io.realm.RealmAnyOperator + + + + + +Method Summary +============== + +.. list-table:: + :header-rows: 1 + + * - Modifier and Type + - Method and Description + + * - public **void** + - | :ref:`checkValidObject ` ( + | **BaseRealm** realm + | ) + + + + + + + + * - protected abstract **NativeRealmAny** + - | :ref:`createNativeRealmAny ` () + | + + + + + + + + + + +Inherited Methods +================= + + + +- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` + + + + +Method Detail +============= + +.. _checkValidObject: + +.. _checkValidObject__: + +.. _RealmAnyOperator_checkValidObject: + +.. _RealmAnyOperator_checkValidObject__: + +.. _io_realm_RealmAnyOperator_checkValidObject: + +.. _io_realm_RealmAnyOperator_checkValidObject__: + + + +checkValidObject +---------------- + +.. _io_realm_RealmAnyOperator_checkValidObject_io_realm_BaseRealm_: + +.. _io_realm_RealmAnyOperator_checkValidObject_BaseRealm_: + +.. _checkValidObject_io_realm_BaseRealm_: + +.. _checkValidObject_BaseRealm_: + +.. _RealmAnyOperator_checkValidObject_io_realm_BaseRealm_: + +.. _RealmAnyOperator_checkValidObject_BaseRealm_: + +.. list-table:: + :header-rows: 1 + + * - | public **void** :ref:`checkValidObject ` ( + | **BaseRealm** realm + | ) + + + + + * - + + + + + + + + + + + + + + + +.. _createNativeRealmAny: + +.. _createNativeRealmAny__: + +.. _RealmAnyOperator_createNativeRealmAny: + +.. _RealmAnyOperator_createNativeRealmAny__: + +.. _io_realm_RealmAnyOperator_createNativeRealmAny: + +.. _io_realm_RealmAnyOperator_createNativeRealmAny__: + + + +createNativeRealmAny +-------------------- + +.. list-table:: + :header-rows: 1 + + * - | protected abstract **NativeRealmAny** :ref:`createNativeRealmAny ` () + | + + + + + * - + + + + + + + + + + + + + + + + diff --git a/source/sdk/java/api/io/realm/RealmChangeListener.txt b/source/sdk/java/api/io/realm/RealmChangeListener.txt index d7348f72d3..5d87fcc65f 100644 --- a/source/sdk/java/api/io/realm/RealmChangeListener.txt +++ b/source/sdk/java/api/io/realm/RealmChangeListener.txt @@ -19,7 +19,7 @@ io.realm RealmChangeListener can be registered with a :ref:`Realm ` , :ref:`RealmResults ` or :ref:`RealmObject ` to receive a notification about updates. -When registered against a ``Realm`` you'll get notified when a Realm instance has been updated. Register against a ``RealmResults`` or ``RealmObject`` to only get notified about changes to them. +When registered against a ``Realm`` you'll get notified when a Realm instance has been updated. Register against a ``RealmResults`` , ``RealmList`` , ``RealmDictionary`` or ``RealmObject`` to only get notified about changes to them. diff --git a/source/sdk/java/api/io/realm/RealmCollection.txt b/source/sdk/java/api/io/realm/RealmCollection.txt index f55f836401..1dd3c095d6 100644 --- a/source/sdk/java/api/io/realm/RealmCollection.txt +++ b/source/sdk/java/api/io/realm/RealmCollection.txt @@ -21,14 +21,13 @@ io.realm -- `java.util.Collection `__ -- **io.realm.internal.ManageableObject** -- `java.lang.Iterable `__ +- `java.util.Collection `__ +- `java.lang.Iterable `__ ``RealmCollection`` is the root of the collection hierarchy that Realm supports. It defines operations on data collections and the behavior that they will have in all implementations of ``RealmCollection`` s. -Realm collections are "live" views to the underlying data. This means that they automatically will be kept up to date. As a consequence, using methods like `Collections.unmodifiableCollection(Collection) `__ will not prevent a collection from being modified. +Realm collections are "live" views to the underlying data. This means that they automatically will be kept up to date. As a consequence, using methods like `Collections.unmodifiableCollection(Collection) `__ will not prevent a collection from being modified. @@ -46,7 +45,7 @@ Method Summary * - public **double** - | :ref:`average ` ( - | `String `__ fieldName + | `String `__ fieldName | ) @@ -57,7 +56,7 @@ Method Summary * - public **boolean** - | :ref:`contains ` ( - | `Object `__ object + | `Object `__ object | ) @@ -78,16 +77,6 @@ Method Summary - * - public :ref:`RealmCollection ` - - | :ref:`freeze ` () - | - - - Returns a frozen snapshot of this collection. - - - - * - public **boolean** - | :ref:`isLoaded ` () | @@ -130,9 +119,9 @@ Method Summary - * - public `Number `__ + * - public `Number `__ - | :ref:`max ` ( - | `String `__ fieldName + | `String `__ fieldName | ) @@ -141,9 +130,9 @@ Method Summary - * - public `Date `__ + * - public `Date `__ - | :ref:`maxDate ` ( - | `String `__ fieldName + | `String `__ fieldName | ) @@ -152,9 +141,9 @@ Method Summary - * - public `Number `__ + * - public `Number `__ - | :ref:`min ` ( - | `String `__ fieldName + | `String `__ fieldName | ) @@ -163,9 +152,9 @@ Method Summary - * - public `Date `__ + * - public `Date `__ - | :ref:`minDate ` ( - | `String `__ fieldName + | `String `__ fieldName | ) @@ -174,9 +163,9 @@ Method Summary - * - public `Number `__ + * - public `Number `__ - | :ref:`sum ` ( - | `String `__ fieldName + | `String `__ fieldName | ) @@ -241,7 +230,7 @@ average :header-rows: 1 * - | public **double** :ref:`average ` ( - | `String `__ fieldName + | `String `__ fieldName | ) @@ -273,11 +262,11 @@ average **Throws** - - `java.lang.IllegalArgumentException `__ - if the field is not a number type. + - `java.lang.IllegalArgumentException `__ - if the field is not a number type. - - `java.lang.IllegalStateException `__ - if the Realm has been closed or called from an incorrect thread. + - `java.lang.IllegalStateException `__ - if the Realm has been closed or called from an incorrect thread. @@ -323,7 +312,7 @@ contains :header-rows: 1 * - | public **boolean** :ref:`contains ` ( - | `Object `__ object + | `Object `__ object | ) @@ -357,7 +346,7 @@ contains **Throws** - - `NullPointerException `__ - if the object to look for is ``null`` and this ``Collection`` doesn't support ``null`` elements. + - `NullPointerException `__ - if the object to look for is ``null`` and this ``Collection`` doesn't support ``null`` elements. @@ -416,78 +405,11 @@ deleteAllFromRealm **Throws** - - `IllegalStateException `__ - if the corresponding Realm is closed or in an incorrect thread. - + - `IllegalStateException `__ - if the corresponding Realm is closed or in an incorrect thread. - - `java.lang.IllegalStateException `__ - if the Realm has been closed or called from an incorrect thread. - - - - - - - - - - - -.. _freeze: - -.. _freeze__: - -.. _RealmCollection_freeze: - -.. _RealmCollection_freeze__: - -.. _io_realm_RealmCollection_freeze: - -.. _io_realm_RealmCollection_freeze__: - - - -freeze ------- - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmCollection ` :ref:`freeze ` () - | - - - - - * - Returns a frozen snapshot of this collection. The frozen copy can be read and queried from any thread without throwing an `IllegalStateException `__ . - - Freezing a collection also creates a Realm which has its own lifecycle, but if the live Realm that spawned the original collection is fully closed (i.e. all instances across all threads are closed), the frozen Realm and this collection will be closed as well. - - Frozen collections can be queried as normal, but trying to mutate it in any way or attempting to register a listener will throw an `IllegalStateException `__ . - - - - Note: Keeping a large number of frozen collections with different versions alive can have a negative impact on the filesize of the Realm. In order to avoid such a situation, it is possible to set :ref:`RealmConfiguration.Builder.maxNumberOfActiveVersions(long) ` . - - - - - - - - - - - **Returns** - - a frozen copy of this collection. - - - - - **Throws** - - - `IllegalStateException `__ - if this method is called from inside a write transaction. + - `java.lang.IllegalStateException `__ - if the Realm has been closed or called from an incorrect thread. @@ -734,8 +656,8 @@ max .. list-table:: :header-rows: 1 - * - | public `Number `__ :ref:`max ` ( - | `String `__ fieldName + * - | public `Number `__ :ref:`max ` ( + | `String `__ fieldName | ) @@ -767,11 +689,11 @@ max **Throws** - - `java.lang.IllegalArgumentException `__ - if the field is not a number type. + - `java.lang.IllegalArgumentException `__ - if the field is not a number type. - - `java.lang.IllegalStateException `__ - if the Realm has been closed or called from an incorrect thread. + - `java.lang.IllegalStateException `__ - if the Realm has been closed or called from an incorrect thread. @@ -816,8 +738,8 @@ maxDate .. list-table:: :header-rows: 1 - * - | public `Date `__ :ref:`maxDate ` ( - | `String `__ fieldName + * - | public `Date `__ :ref:`maxDate ` ( + | `String `__ fieldName | ) @@ -849,11 +771,11 @@ maxDate **Throws** - - `java.lang.IllegalArgumentException `__ - if fieldName is not a Date field. + - `java.lang.IllegalArgumentException `__ - if fieldName is not a Date field. - - `java.lang.IllegalStateException `__ - if the Realm has been closed or called from an incorrect thread. + - `java.lang.IllegalStateException `__ - if the Realm has been closed or called from an incorrect thread. @@ -898,8 +820,8 @@ min .. list-table:: :header-rows: 1 - * - | public `Number `__ :ref:`min ` ( - | `String `__ fieldName + * - | public `Number `__ :ref:`min ` ( + | `String `__ fieldName | ) @@ -931,11 +853,11 @@ min **Throws** - - `java.lang.IllegalArgumentException `__ - if the field is not a number type. + - `java.lang.IllegalArgumentException `__ - if the field is not a number type. - - `java.lang.IllegalStateException `__ - if the Realm has been closed or called from an incorrect thread. + - `java.lang.IllegalStateException `__ - if the Realm has been closed or called from an incorrect thread. @@ -980,8 +902,8 @@ minDate .. list-table:: :header-rows: 1 - * - | public `Date `__ :ref:`minDate ` ( - | `String `__ fieldName + * - | public `Date `__ :ref:`minDate ` ( + | `String `__ fieldName | ) @@ -1013,11 +935,11 @@ minDate **Throws** - - `java.lang.IllegalArgumentException `__ - if fieldName is not a Date field. + - `java.lang.IllegalArgumentException `__ - if fieldName is not a Date field. - - `java.lang.IllegalStateException `__ - if the Realm has been closed or called from an incorrect thread. + - `java.lang.IllegalStateException `__ - if the Realm has been closed or called from an incorrect thread. @@ -1062,8 +984,8 @@ sum .. list-table:: :header-rows: 1 - * - | public `Number `__ :ref:`sum ` ( - | `String `__ fieldName + * - | public `Number `__ :ref:`sum ` ( + | `String `__ fieldName | ) @@ -1095,11 +1017,11 @@ sum **Throws** - - `java.lang.IllegalArgumentException `__ - if the field is not a number type. + - `java.lang.IllegalArgumentException `__ - if the field is not a number type. - - `java.lang.IllegalStateException `__ - if the Realm has been closed or called from an incorrect thread. + - `java.lang.IllegalStateException `__ - if the Realm has been closed or called from an incorrect thread. @@ -1156,7 +1078,7 @@ where **Throws** - - `IllegalStateException `__ - if the Realm instance has been closed or queries are not otherwise available. + - `IllegalStateException `__ - if the Realm instance has been closed or queries are not otherwise available. diff --git a/source/sdk/java/api/io/realm/RealmConfiguration.txt b/source/sdk/java/api/io/realm/RealmConfiguration.txt index 785e40b6a4..d7162e5eec 100644 --- a/source/sdk/java/api/io/realm/RealmConfiguration.txt +++ b/source/sdk/java/api/io/realm/RealmConfiguration.txt @@ -18,7 +18,7 @@ io.realm ======== - | `java.lang.Object `__ + | `java.lang.Object `__ | io.realm.RealmConfiguration @@ -79,7 +79,7 @@ Field Summary * - Modifier and Type - Field and Description - * - public static final `String `__ + * - public static final `String `__ - :ref:`DEFAULT_REALM_NAME ` @@ -101,8 +101,9 @@ Method Summary * - protected static **RealmProxyMediator** - | :ref:`createSchemaMediator ` ( - | `java.util.Set\ `__ modules, - | `java.util.Set\> `__ debugSchema + | `java.util.Set\ `__ modules, + | `java.util.Set\> `__ debugSchema, + | **boolean** excludeDebugSchema | ) @@ -113,7 +114,7 @@ Method Summary * - public **boolean** - | :ref:`equals ` ( - | `Object `__ obj + | `Object `__ obj | ) @@ -124,7 +125,7 @@ Method Summary * - protected static :ref:`RealmConfiguration ` - | :ref:`forRecovery ` ( - | `String `__ canonicalPath, + | `String `__ canonicalPath, | **byte[]** encryptionKey, | **RealmProxyMediator** schemaMediator | ) @@ -135,6 +136,16 @@ Method Summary + * - public `String `__ + - | :ref:`getAssetFilePath ` () + | + + + Returns the path to the Realm asset file. + + + + * - public :ref:`CompactOnLaunchCallback ` - | :ref:`getCompactOnLaunchCallback ` () | @@ -187,6 +198,17 @@ Method Summary + * - protected :ref:`Realm ` + - | :ref:`getInstance ` ( + | **OsSharedRealm.VersionID** version + | ) + + + + + + + * - public **long** - | :ref:`getMaxNumberOfActiveVersions ` () | @@ -207,7 +229,7 @@ Method Summary - * - public `String `__ + * - public `String `__ - | :ref:`getPath ` () | @@ -217,7 +239,7 @@ Method Summary - * - public `File `__ + * - public `File `__ - | :ref:`getRealmDirectory ` () | @@ -227,7 +249,7 @@ Method Summary - * - public `String `__ + * - public `String `__ - | :ref:`getRealmFileName ` () | @@ -237,12 +259,12 @@ Method Summary - * - public `Set `__ + * - public `Set `__ - | :ref:`getRealmObjectClasses ` () | - Returns the unmodifiable `Set `__ of model classes that make up the schema for this Realm. + Returns the unmodifiable `Set `__ of model classes that make up the schema for this Realm. @@ -281,6 +303,16 @@ Method Summary + * - public **boolean** + - | :ref:`hasAssetFile ` () + | + + + Indicates if an asset file has been configured for this configuration. + + + + * - public **int** - | :ref:`hashCode ` () | @@ -365,7 +397,7 @@ Method Summary - * - public `String `__ + * - public `String `__ - | :ref:`toString ` () | @@ -383,7 +415,7 @@ Inherited Methods -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` +- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` @@ -423,86 +455,87 @@ Method Detail createSchemaMediator -------------------- -.. _io_realm_RealmConfiguration_createSchemaMediator_java_util_Set_java_util_Set_: +.. _io_realm_RealmConfiguration_createSchemaMediator_java_util_Set_java_util_Set_boolean_: -.. _io_realm_RealmConfiguration_createSchemaMediator_java_util_Set__java_util_Set_: +.. _io_realm_RealmConfiguration_createSchemaMediator_java_util_Set__java_util_Set__boolean_: -.. _io_realm_RealmConfiguration_createSchemaMediator_java_util_Set_Set_: +.. _io_realm_RealmConfiguration_createSchemaMediator_java_util_Set_Set_boolean_: -.. _io_realm_RealmConfiguration_createSchemaMediator_java_util_Set__Set_: +.. _io_realm_RealmConfiguration_createSchemaMediator_java_util_Set__Set__boolean_: -.. _io_realm_RealmConfiguration_createSchemaMediator_java_util_Set_RealmModel___: +.. _io_realm_RealmConfiguration_createSchemaMediator_java_util_Set_RealmModel___boolean_: -.. _io_realm_RealmConfiguration_createSchemaMediator_java_util_Set__RealmModel___: +.. _io_realm_RealmConfiguration_createSchemaMediator_java_util_Set__RealmModel____boolean_: -.. _io_realm_RealmConfiguration_createSchemaMediator_Set_java_util_Set_: +.. _io_realm_RealmConfiguration_createSchemaMediator_Set_java_util_Set_boolean_: -.. _io_realm_RealmConfiguration_createSchemaMediator_Set__java_util_Set_: +.. _io_realm_RealmConfiguration_createSchemaMediator_Set__java_util_Set__boolean_: -.. _io_realm_RealmConfiguration_createSchemaMediator_Set_Set_: +.. _io_realm_RealmConfiguration_createSchemaMediator_Set_Set_boolean_: -.. _io_realm_RealmConfiguration_createSchemaMediator_Set__Set_: +.. _io_realm_RealmConfiguration_createSchemaMediator_Set__Set__boolean_: -.. _io_realm_RealmConfiguration_createSchemaMediator_Set_RealmModel___: +.. _io_realm_RealmConfiguration_createSchemaMediator_Set_RealmModel___boolean_: -.. _io_realm_RealmConfiguration_createSchemaMediator_Set__RealmModel___: +.. _io_realm_RealmConfiguration_createSchemaMediator_Set__RealmModel____boolean_: -.. _createSchemaMediator_java_util_Set_java_util_Set_: +.. _createSchemaMediator_java_util_Set_java_util_Set_boolean_: -.. _createSchemaMediator_java_util_Set__java_util_Set_: +.. _createSchemaMediator_java_util_Set__java_util_Set__boolean_: -.. _createSchemaMediator_java_util_Set_Set_: +.. _createSchemaMediator_java_util_Set_Set_boolean_: -.. _createSchemaMediator_java_util_Set__Set_: +.. _createSchemaMediator_java_util_Set__Set__boolean_: -.. _createSchemaMediator_java_util_Set_RealmModel___: +.. _createSchemaMediator_java_util_Set_RealmModel___boolean_: -.. _createSchemaMediator_java_util_Set__RealmModel___: +.. _createSchemaMediator_java_util_Set__RealmModel____boolean_: -.. _createSchemaMediator_Set_java_util_Set_: +.. _createSchemaMediator_Set_java_util_Set_boolean_: -.. _createSchemaMediator_Set__java_util_Set_: +.. _createSchemaMediator_Set__java_util_Set__boolean_: -.. _createSchemaMediator_Set_Set_: +.. _createSchemaMediator_Set_Set_boolean_: -.. _createSchemaMediator_Set__Set_: +.. _createSchemaMediator_Set__Set__boolean_: -.. _createSchemaMediator_Set_RealmModel___: +.. _createSchemaMediator_Set_RealmModel___boolean_: -.. _createSchemaMediator_Set__RealmModel___: +.. _createSchemaMediator_Set__RealmModel____boolean_: -.. _RealmConfiguration_createSchemaMediator_java_util_Set_java_util_Set_: +.. _RealmConfiguration_createSchemaMediator_java_util_Set_java_util_Set_boolean_: -.. _RealmConfiguration_createSchemaMediator_java_util_Set__java_util_Set_: +.. _RealmConfiguration_createSchemaMediator_java_util_Set__java_util_Set__boolean_: -.. _RealmConfiguration_createSchemaMediator_java_util_Set_Set_: +.. _RealmConfiguration_createSchemaMediator_java_util_Set_Set_boolean_: -.. _RealmConfiguration_createSchemaMediator_java_util_Set__Set_: +.. _RealmConfiguration_createSchemaMediator_java_util_Set__Set__boolean_: -.. _RealmConfiguration_createSchemaMediator_java_util_Set_RealmModel___: +.. _RealmConfiguration_createSchemaMediator_java_util_Set_RealmModel___boolean_: -.. _RealmConfiguration_createSchemaMediator_java_util_Set__RealmModel___: +.. _RealmConfiguration_createSchemaMediator_java_util_Set__RealmModel____boolean_: -.. _RealmConfiguration_createSchemaMediator_Set_java_util_Set_: +.. _RealmConfiguration_createSchemaMediator_Set_java_util_Set_boolean_: -.. _RealmConfiguration_createSchemaMediator_Set__java_util_Set_: +.. _RealmConfiguration_createSchemaMediator_Set__java_util_Set__boolean_: -.. _RealmConfiguration_createSchemaMediator_Set_Set_: +.. _RealmConfiguration_createSchemaMediator_Set_Set_boolean_: -.. _RealmConfiguration_createSchemaMediator_Set__Set_: +.. _RealmConfiguration_createSchemaMediator_Set__Set__boolean_: -.. _RealmConfiguration_createSchemaMediator_Set_RealmModel___: +.. _RealmConfiguration_createSchemaMediator_Set_RealmModel___boolean_: -.. _RealmConfiguration_createSchemaMediator_Set__RealmModel___: +.. _RealmConfiguration_createSchemaMediator_Set__RealmModel____boolean_: -.. _io_realm_RealmConfiguration_createSchemaMediator_Set_Object___Set_Class___extends_RealmModel___: +.. _io_realm_RealmConfiguration_createSchemaMediator_Set_Object___Set_Class___extends_RealmModel____boolean_: .. list-table:: :header-rows: 1 * - | protected static **RealmProxyMediator** :ref:`createSchemaMediator ` ( - | `java.util.Set\ `__ modules, - | `java.util.Set\> `__ debugSchema + | `java.util.Set\ `__ modules, + | `java.util.Set\> `__ debugSchema, + | **boolean** excludeDebugSchema | ) @@ -557,7 +590,7 @@ equals :header-rows: 1 * - | public **boolean** :ref:`equals ` ( - | `Object `__ obj + | `Object `__ obj | ) @@ -576,7 +609,7 @@ equals **Overrides** - ``equals`` in class `Object `__ + ``equals`` in class `Object `__ @@ -600,98 +633,50 @@ equals forRecovery ----------- -.. _io_realm_RealmConfiguration_forRecovery_java_lang_String_byte_io_realm_internal_RealmProxyMediator_: - -.. _io_realm_RealmConfiguration_forRecovery_java_lang_String__byte__io_realm_internal_RealmProxyMediator_: - .. _io_realm_RealmConfiguration_forRecovery_java_lang_String_byte_RealmProxyMediator_: .. _io_realm_RealmConfiguration_forRecovery_java_lang_String__byte__RealmProxyMediator_: -.. _io_realm_RealmConfiguration_forRecovery_java_lang_String_byte____io_realm_internal_RealmProxyMediator_: - -.. _io_realm_RealmConfiguration_forRecovery_java_lang_String__byte_____io_realm_internal_RealmProxyMediator_: - .. _io_realm_RealmConfiguration_forRecovery_java_lang_String_byte____RealmProxyMediator_: .. _io_realm_RealmConfiguration_forRecovery_java_lang_String__byte_____RealmProxyMediator_: -.. _io_realm_RealmConfiguration_forRecovery_String_byte_io_realm_internal_RealmProxyMediator_: - -.. _io_realm_RealmConfiguration_forRecovery_String__byte__io_realm_internal_RealmProxyMediator_: - .. _io_realm_RealmConfiguration_forRecovery_String_byte_RealmProxyMediator_: .. _io_realm_RealmConfiguration_forRecovery_String__byte__RealmProxyMediator_: -.. _io_realm_RealmConfiguration_forRecovery_String_byte____io_realm_internal_RealmProxyMediator_: - -.. _io_realm_RealmConfiguration_forRecovery_String__byte_____io_realm_internal_RealmProxyMediator_: - .. _io_realm_RealmConfiguration_forRecovery_String_byte____RealmProxyMediator_: .. _io_realm_RealmConfiguration_forRecovery_String__byte_____RealmProxyMediator_: -.. _forRecovery_java_lang_String_byte_io_realm_internal_RealmProxyMediator_: - -.. _forRecovery_java_lang_String__byte__io_realm_internal_RealmProxyMediator_: - .. _forRecovery_java_lang_String_byte_RealmProxyMediator_: .. _forRecovery_java_lang_String__byte__RealmProxyMediator_: -.. _forRecovery_java_lang_String_byte____io_realm_internal_RealmProxyMediator_: - -.. _forRecovery_java_lang_String__byte_____io_realm_internal_RealmProxyMediator_: - .. _forRecovery_java_lang_String_byte____RealmProxyMediator_: .. _forRecovery_java_lang_String__byte_____RealmProxyMediator_: -.. _forRecovery_String_byte_io_realm_internal_RealmProxyMediator_: - -.. _forRecovery_String__byte__io_realm_internal_RealmProxyMediator_: - .. _forRecovery_String_byte_RealmProxyMediator_: .. _forRecovery_String__byte__RealmProxyMediator_: -.. _forRecovery_String_byte____io_realm_internal_RealmProxyMediator_: - -.. _forRecovery_String__byte_____io_realm_internal_RealmProxyMediator_: - .. _forRecovery_String_byte____RealmProxyMediator_: .. _forRecovery_String__byte_____RealmProxyMediator_: -.. _RealmConfiguration_forRecovery_java_lang_String_byte_io_realm_internal_RealmProxyMediator_: - -.. _RealmConfiguration_forRecovery_java_lang_String__byte__io_realm_internal_RealmProxyMediator_: - .. _RealmConfiguration_forRecovery_java_lang_String_byte_RealmProxyMediator_: .. _RealmConfiguration_forRecovery_java_lang_String__byte__RealmProxyMediator_: -.. _RealmConfiguration_forRecovery_java_lang_String_byte____io_realm_internal_RealmProxyMediator_: - -.. _RealmConfiguration_forRecovery_java_lang_String__byte_____io_realm_internal_RealmProxyMediator_: - .. _RealmConfiguration_forRecovery_java_lang_String_byte____RealmProxyMediator_: .. _RealmConfiguration_forRecovery_java_lang_String__byte_____RealmProxyMediator_: -.. _RealmConfiguration_forRecovery_String_byte_io_realm_internal_RealmProxyMediator_: - -.. _RealmConfiguration_forRecovery_String__byte__io_realm_internal_RealmProxyMediator_: - .. _RealmConfiguration_forRecovery_String_byte_RealmProxyMediator_: .. _RealmConfiguration_forRecovery_String__byte__RealmProxyMediator_: -.. _RealmConfiguration_forRecovery_String_byte____io_realm_internal_RealmProxyMediator_: - -.. _RealmConfiguration_forRecovery_String__byte_____io_realm_internal_RealmProxyMediator_: - .. _RealmConfiguration_forRecovery_String_byte____RealmProxyMediator_: .. _RealmConfiguration_forRecovery_String__byte_____RealmProxyMediator_: @@ -702,7 +687,7 @@ forRecovery :header-rows: 1 * - | protected static :ref:`RealmConfiguration ` :ref:`forRecovery ` ( - | `String `__ canonicalPath, + | `String `__ canonicalPath, | **byte[]** encryptionKey, | **RealmProxyMediator** schemaMediator | ) @@ -726,6 +711,55 @@ forRecovery +.. _getAssetFilePath: + +.. _getAssetFilePath__: + +.. _RealmConfiguration_getAssetFilePath: + +.. _RealmConfiguration_getAssetFilePath__: + +.. _io_realm_RealmConfiguration_getAssetFilePath: + +.. _io_realm_RealmConfiguration_getAssetFilePath__: + + + +getAssetFilePath +---------------- + +.. list-table:: + :header-rows: 1 + + * - | public `String `__ :ref:`getAssetFilePath ` () + | + + + + + * - Returns the path to the Realm asset file. + + + + + + + **Returns** + + path to the asset file relative to the asset directory or ``null`` if not asset file was specified. + + + + + + + + + + + + + .. _getCompactOnLaunchCallback: .. _getCompactOnLaunchCallback__: @@ -901,7 +935,7 @@ getFlowFactory **Throws** - - `UnsupportedOperationException `__ - if the required coroutines framework is not on the classpath. + - `UnsupportedOperationException `__ - if the required coroutines framework is not on the classpath. @@ -961,6 +995,55 @@ getInitialDataTransaction +.. _getInstance: + +.. _getInstance__: + +.. _RealmConfiguration_getInstance: + +.. _RealmConfiguration_getInstance__: + +.. _io_realm_RealmConfiguration_getInstance: + +.. _io_realm_RealmConfiguration_getInstance__: + + + +getInstance +----------- + +.. _io_realm_RealmConfiguration_getInstance_OsSharedRealm_VersionID_: + +.. _getInstance_OsSharedRealm_VersionID_: + +.. _RealmConfiguration_getInstance_OsSharedRealm_VersionID_: + +.. list-table:: + :header-rows: 1 + + * - | protected :ref:`Realm ` :ref:`getInstance ` ( + | **OsSharedRealm.VersionID** version + | ) + + + + + * - + + + + + + + + + + + + + + + .. _getMaxNumberOfActiveVersions: .. _getMaxNumberOfActiveVersions__: @@ -1070,7 +1153,7 @@ getPath .. list-table:: :header-rows: 1 - * - | public `String `__ :ref:`getPath ` () + * - | public `String `__ :ref:`getPath ` () | @@ -1117,7 +1200,7 @@ getRealmDirectory .. list-table:: :header-rows: 1 - * - | public `File `__ :ref:`getRealmDirectory ` () + * - | public `File `__ :ref:`getRealmDirectory ` () | @@ -1159,7 +1242,7 @@ getRealmFileName .. list-table:: :header-rows: 1 - * - | public `String `__ :ref:`getRealmFileName ` () + * - | public `String `__ :ref:`getRealmFileName ` () | @@ -1201,13 +1284,13 @@ getRealmObjectClasses .. list-table:: :header-rows: 1 - * - | public `Set `__ :ref:`getRealmObjectClasses ` () + * - | public `Set `__ :ref:`getRealmObjectClasses ` () | - * - Returns the unmodifiable `Set `__ of model classes that make up the schema for this Realm. + * - Returns the unmodifiable `Set `__ of model classes that make up the schema for this Realm. @@ -1218,7 +1301,7 @@ getRealmObjectClasses **Returns** - unmodifiable `Set `__ of model classes. + unmodifiable `Set `__ of model classes. @@ -1276,7 +1359,7 @@ getRxFactory **Throws** - - `UnsupportedOperationException `__ - if the required RxJava framework is not on the classpath. + - `UnsupportedOperationException `__ - if the required RxJava framework is not on the classpath. @@ -1378,6 +1461,55 @@ getSchemaVersion +.. _hasAssetFile: + +.. _hasAssetFile__: + +.. _RealmConfiguration_hasAssetFile: + +.. _RealmConfiguration_hasAssetFile__: + +.. _io_realm_RealmConfiguration_hasAssetFile: + +.. _io_realm_RealmConfiguration_hasAssetFile__: + + + +hasAssetFile +------------ + +.. list-table:: + :header-rows: 1 + + * - | public **boolean** :ref:`hasAssetFile ` () + | + + + + + * - Indicates if an asset file has been configured for this configuration. + + + + + + + **Returns** + + ``true`` if there is asset file, ``false`` otherwise. + + + + + + + + + + + + + .. _hashCode: .. _hashCode__: @@ -1417,7 +1549,7 @@ hashCode **Overrides** - ``hashCode`` in class `Object `__ + ``hashCode`` in class `Object `__ @@ -1556,7 +1688,7 @@ isReadOnly - * - Returns whether this Realm is read-only or not. Read-only Realms cannot be modified and will throw an `IllegalStateException `__ if **Realm.beginTransaction()** is called on it. + * - Returns whether this Realm is read-only or not. Read-only Realms cannot be modified and will throw an `IllegalStateException `__ if **Realm.beginTransaction()** is called on it. @@ -1631,8 +1763,7 @@ isRecoveryConfiguration - - `ClientResetRequiredError `__ - + - **{@link ClientResetRequiredError}** @@ -1800,7 +1931,7 @@ toString .. list-table:: :header-rows: 1 - * - | public `String `__ :ref:`toString ` () + * - | public `String `__ :ref:`toString ` () | @@ -1819,7 +1950,7 @@ toString **Overrides** - ``toString`` in class `Object `__ + ``toString`` in class `Object `__ diff --git a/source/sdk/java/api/io/realm/RealmConfiguration/Builder.txt b/source/sdk/java/api/io/realm/RealmConfiguration/Builder.txt index cd99befa2c..e7e73393f4 100644 --- a/source/sdk/java/api/io/realm/RealmConfiguration/Builder.txt +++ b/source/sdk/java/api/io/realm/RealmConfiguration/Builder.txt @@ -18,7 +18,7 @@ io.realm ======== - | `java.lang.Object `__ + | `java.lang.Object `__ | io.realm.RealmConfiguration.Builder @@ -64,7 +64,7 @@ Method Summary * - public final :ref:`RealmConfiguration.Builder ` - | :ref:`addModule ` ( - | `Object `__ module + | `Object `__ module | ) @@ -101,7 +101,7 @@ Method Summary * - public :ref:`RealmConfiguration.Builder ` - | :ref:`assetFile ` ( - | `String `__ assetFile + | `String `__ assetFile | ) @@ -153,7 +153,7 @@ Method Summary * - public :ref:`RealmConfiguration.Builder ` - | :ref:`directory ` ( - | `File `__ directory + | `File `__ directory | ) @@ -215,7 +215,7 @@ Method Summary | ) - Sets the maximum number of live versions in the Realm file before an `IllegalStateException `__ is thrown when attempting to write more data. + Sets the maximum number of live versions in the Realm file before an `IllegalStateException `__ is thrown when attempting to write more data. @@ -237,8 +237,8 @@ Method Summary * - public :ref:`RealmConfiguration.Builder ` - | :ref:`modules ` ( - | `Object `__ baseModule, - | `java.lang.Object[] `__ additionalModules + | `Object `__ baseModule, + | `java.lang.Object[] `__ additionalModules | ) @@ -251,7 +251,7 @@ Method Summary * - public :ref:`RealmConfiguration.Builder ` - | :ref:`name ` ( - | `String `__ filename + | `String `__ filename | ) @@ -265,7 +265,7 @@ Method Summary | - Setting this will cause the Realm to become read only and all write transactions made against this Realm will fail with an `IllegalStateException `__ . + Setting this will cause the Realm to become read only and all write transactions made against this Realm will fail with an `IllegalStateException `__ . @@ -304,7 +304,7 @@ Inherited Methods -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` +- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` @@ -387,7 +387,7 @@ addModule :header-rows: 1 * - | public final :ref:`RealmConfiguration.Builder ` :ref:`addModule ` ( - | `Object `__ module + | `Object `__ module | ) @@ -564,7 +564,7 @@ assetFile :header-rows: 1 * - | public :ref:`RealmConfiguration.Builder ` :ref:`assetFile ` ( - | `String `__ assetFile + | `String `__ assetFile | ) @@ -597,7 +597,7 @@ assetFile **Throws** - - `IllegalStateException `__ - if this is configured to clear its schema by calling :ref:`deleteRealmIfMigrationNeeded() ` . + - `IllegalStateException `__ - if this is configured to clear its schema by calling :ref:`deleteRealmIfMigrationNeeded() ` . @@ -806,7 +806,7 @@ deleteRealmIfMigrationNeeded **Throws** - - `IllegalStateException `__ - if configured to use an asset file by calling :ref:`assetFile(String) ` previously. + - `IllegalStateException `__ - if configured to use an asset file by calling :ref:`assetFile(String) ` previously. @@ -858,7 +858,7 @@ directory :header-rows: 1 * - | public :ref:`RealmConfiguration.Builder ` :ref:`directory ` ( - | `File `__ directory + | `File `__ directory | ) @@ -885,7 +885,7 @@ directory **Throws** - - `IllegalArgumentException `__ - if ``directory`` is null, not writable or a file. + - `IllegalArgumentException `__ - if ``directory`` is null, not writable or a file. @@ -1192,7 +1192,7 @@ maxNumberOfActiveVersions - * - Sets the maximum number of live versions in the Realm file before an `IllegalStateException `__ is thrown when attempting to write more data. + * - Sets the maximum number of live versions in the Realm file before an `IllegalStateException `__ is thrown when attempting to write more data. Realm is capable of concurrently handling many different versions of Realm objects. This can e.g. happen if you have a Realm open on many different threads or are freezing objects while data is being written to the file. @@ -1223,7 +1223,7 @@ maxNumberOfActiveVersions - - `FAQ `__ + - `FAQ `__ @@ -1395,8 +1395,8 @@ modules :header-rows: 1 * - | public :ref:`RealmConfiguration.Builder ` :ref:`modules ` ( - | `Object `__ baseModule, - | `java.lang.Object[] `__ additionalModules + | `Object `__ baseModule, + | `java.lang.Object[] `__ additionalModules | ) @@ -1435,7 +1435,7 @@ modules **Throws** - - `IllegalArgumentException `__ - if any of the modules doesn't have the :ref:`RealmModule ` annotation. + - `IllegalArgumentException `__ - if any of the modules doesn't have the :ref:`RealmModule ` annotation. @@ -1501,7 +1501,7 @@ name :header-rows: 1 * - | public :ref:`RealmConfiguration.Builder ` :ref:`name ` ( - | `String `__ filename + | `String `__ filename | ) @@ -1553,9 +1553,9 @@ readOnly - * - Setting this will cause the Realm to become read only and all write transactions made against this Realm will fail with an `IllegalStateException `__ . + * - Setting this will cause the Realm to become read only and all write transactions made against this Realm will fail with an `IllegalStateException `__ . - This in particular mean that :ref:`initialData(Realm.Transaction) ` will not work in combination with a read only Realm and setting this will result in a `IllegalStateException `__ being thrown. + This in particular mean that :ref:`initialData(Realm.Transaction) ` will not work in combination with a read only Realm and setting this will result in a `IllegalStateException `__ being thrown. diff --git a/source/sdk/java/api/io/realm/RealmDictionary.txt b/source/sdk/java/api/io/realm/RealmDictionary.txt new file mode 100644 index 0000000000..2a43693bad --- /dev/null +++ b/source/sdk/java/api/io/realm/RealmDictionary.txt @@ -0,0 +1,154 @@ + +.. contents:: On this page + :local: + :backlinks: none + :depth: 2 + :class: singlecol + + + +Class RealmDictionary +^^^^^^^^^^^^^^^^^^^^^ + +.. _io_realm_RealmDictionary: + + + +io.realm +======== + + + | `java.lang.Object `__ + | :ref:`io.realm.RealmMap ` + | io.realm.RealmDictionary + + +Specialization of :ref:`RealmMap ` s whose keys are strings. + +Similarly to :ref:`RealmList ` s, a RealmDictionary can operate in managed and unmanaged modes. In managed mode a RealmDictionary persists all its contents inside a Realm whereas in unmanaged mode it functions like a `HashMap `__ . + + + +Managed RealmDictionaries can only be created by Realm and will automatically update its content whenever the underlying Realm is updated. Managed RealmDictionaries can only be accessed using the getter that points to a RealmDictionary field of a :ref:`RealmObject ` . + + + +Unmanaged RealmDictionaries can be created by the user and can contain both managed and unmanaged RealmObjects. This is useful when dealing with JSON deserializers like GSON or other frameworks that inject values into a class. Unmanaged RealmDictionaries can be added to a Realm using the :ref:`Realm.copyToRealm(Iterable, ImportFlag...) ` method. + + + + + + +Constructors +============ + +.. list-table:: + :header-rows: 1 + + * - Constructor and Description + + * - | :ref:`RealmDictionary ` () + | + + + Instantiates a RealmDictionary in unmanaged mode. + + + + + * - | :ref:`RealmDictionary ` ( + | `java.util.Map\ `__ map + | ) + + + Instantiates a RealmDictionary in unmanaged mode with an initial dictionary. + + + + + + + +Inherited Methods +================= + + + +- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` +- Methods inherited from class :ref:`io.realm.RealmMap ` : ``isManaged`` , ``isValid`` , ``isFrozen`` , ``size`` , ``isEmpty`` , ``containsKey`` , ``containsValue`` , ``get`` , ``put`` , ``remove`` , ``putAll`` , ``clear`` , ``keySet`` , ``values`` , ``entrySet`` , ``freeze`` , ``addChangeListener`` , ``addChangeListener`` , ``removeChangeListener`` , ``removeChangeListener`` , ``removeAllChangeListeners`` + + + + +Constructor Detail +================== + +.. _RealmDictionary: + +.. _RealmDictionary__: + +.. _io_realm_RealmDictionary: + +.. _io_realm_RealmDictionary__: + +.. list-table:: + :header-rows: 1 + + * - | public :ref:`RealmDictionary ` () + | + + + + + * - Instantiates a RealmDictionary in unmanaged mode. + + + + + + + + + + + +.. _RealmDictionary: + +.. _RealmDictionary__: + +.. _io_realm_RealmDictionary: + +.. _io_realm_RealmDictionary__: + +.. list-table:: + :header-rows: 1 + + * - | public :ref:`RealmDictionary ` ( + | `java.util.Map\ `__ map + | ) + + + + + * - Instantiates a RealmDictionary in unmanaged mode with an initial dictionary. + + + + + **Parameters** + + - ``map`` - initial dictionary + + + + + + + + + + + + + diff --git a/source/sdk/java/api/io/realm/RealmFieldType.txt b/source/sdk/java/api/io/realm/RealmFieldType.txt index d0f074bf9d..cbed096210 100644 --- a/source/sdk/java/api/io/realm/RealmFieldType.txt +++ b/source/sdk/java/api/io/realm/RealmFieldType.txt @@ -18,8 +18,8 @@ io.realm ======== - | `java.lang.Object `__ - | `java.lang.Enum `__ + | `java.lang.Object `__ + | `java.lang.Enum `__ | io.realm.RealmFieldType @@ -52,6 +52,13 @@ Enum Constant Summary + * - :ref:`BINARY_SET ` + + + + + + * - :ref:`BOOLEAN ` @@ -66,6 +73,13 @@ Enum Constant Summary + * - :ref:`BOOLEAN_SET ` + + + + + + * - :ref:`DATE ` @@ -80,6 +94,13 @@ Enum Constant Summary + * - :ref:`DATE_SET ` + + + + + + * - :ref:`DECIMAL128 ` @@ -94,6 +115,13 @@ Enum Constant Summary + * - :ref:`DECIMAL128_SET ` + + + + + + * - :ref:`DOUBLE ` @@ -108,6 +136,13 @@ Enum Constant Summary + * - :ref:`DOUBLE_SET ` + + + + + + * - :ref:`FLOAT ` @@ -122,6 +157,13 @@ Enum Constant Summary + * - :ref:`FLOAT_SET ` + + + + + + * - :ref:`INTEGER ` @@ -136,6 +178,13 @@ Enum Constant Summary + * - :ref:`INTEGER_SET ` + + + + + + * - :ref:`LINKING_OBJECTS ` @@ -143,6 +192,13 @@ Enum Constant Summary + * - :ref:`LINK_SET ` + + + + + + * - :ref:`LIST ` @@ -150,6 +206,27 @@ Enum Constant Summary + * - :ref:`MIXED ` + + + + + + + * - :ref:`MIXED_LIST ` + + + + + + + * - :ref:`MIXED_SET ` + + + + + + * - :ref:`OBJECT ` @@ -171,6 +248,13 @@ Enum Constant Summary + * - :ref:`OBJECT_ID_SET ` + + + + + + * - :ref:`STRING ` @@ -185,6 +269,125 @@ Enum Constant Summary + * - :ref:`STRING_SET ` + + + + + + + * - :ref:`STRING_TO_BINARY_MAP ` + + + + + + + * - :ref:`STRING_TO_BOOLEAN_MAP ` + + + + + + + * - :ref:`STRING_TO_DATE_MAP ` + + + + + + + * - :ref:`STRING_TO_DECIMAL128_MAP ` + + + + + + + * - :ref:`STRING_TO_DOUBLE_MAP ` + + + + + + + * - :ref:`STRING_TO_FLOAT_MAP ` + + + + + + + * - :ref:`STRING_TO_INTEGER_MAP ` + + + + + + + * - :ref:`STRING_TO_LINK_MAP ` + + + + + + + * - :ref:`STRING_TO_MIXED_MAP ` + + + + + + + * - :ref:`STRING_TO_OBJECT_ID_MAP ` + + + + + + + * - :ref:`STRING_TO_STRING_MAP ` + + + + + + + * - :ref:`STRING_TO_UUID_MAP ` + + + + + + + * - :ref:`TYPED_LINK ` + + + + + + + * - :ref:`UUID ` + + + + + + + * - :ref:`UUID_LIST ` + + + + + + + * - :ref:`UUID_SET ` + + + + + + @@ -220,7 +423,7 @@ Method Summary * - public **boolean** - | :ref:`isValid ` ( - | `Object `__ obj + | `Object `__ obj | ) @@ -231,7 +434,7 @@ Method Summary * - public static :ref:`RealmFieldType ` - | :ref:`valueOf ` ( - | `String `__ name + | `String `__ name | ) @@ -258,8 +461,8 @@ Inherited Methods -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` -- Methods inherited from class `java.lang.Enum `__ : ``name`` , ``ordinal`` , ``toString`` , ``equals`` , ``hashCode`` , ``clone`` , ``compareTo`` , ``getDeclaringClass`` , ``valueOf`` , ``finalize`` +- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` +- Methods inherited from class `java.lang.Enum `__ : ``name`` , ``ordinal`` , ``toString`` , ``equals`` , ``hashCode`` , ``clone`` , ``compareTo`` , ``getDeclaringClass`` , ``valueOf`` , ``finalize`` @@ -298,6 +501,21 @@ public static final :ref:`RealmFieldType ` +.. _io_realm_RealmFieldType_BINARY_SET: + +.. _RealmFieldType_BINARY_SET: + + + +``BINARY_SET`` +--------------- + +public static final :ref:`RealmFieldType ` + + + + + .. _io_realm_RealmFieldType_BOOLEAN: .. _RealmFieldType_BOOLEAN: @@ -328,6 +546,21 @@ public static final :ref:`RealmFieldType ` +.. _io_realm_RealmFieldType_BOOLEAN_SET: + +.. _RealmFieldType_BOOLEAN_SET: + + + +``BOOLEAN_SET`` +---------------- + +public static final :ref:`RealmFieldType ` + + + + + .. _io_realm_RealmFieldType_DATE: .. _RealmFieldType_DATE: @@ -358,6 +591,21 @@ public static final :ref:`RealmFieldType ` +.. _io_realm_RealmFieldType_DATE_SET: + +.. _RealmFieldType_DATE_SET: + + + +``DATE_SET`` +------------- + +public static final :ref:`RealmFieldType ` + + + + + .. _io_realm_RealmFieldType_DECIMAL128: .. _RealmFieldType_DECIMAL128: @@ -388,6 +636,21 @@ public static final :ref:`RealmFieldType ` +.. _io_realm_RealmFieldType_DECIMAL128_SET: + +.. _RealmFieldType_DECIMAL128_SET: + + + +``DECIMAL128_SET`` +------------------- + +public static final :ref:`RealmFieldType ` + + + + + .. _io_realm_RealmFieldType_DOUBLE: .. _RealmFieldType_DOUBLE: @@ -418,6 +681,21 @@ public static final :ref:`RealmFieldType ` +.. _io_realm_RealmFieldType_DOUBLE_SET: + +.. _RealmFieldType_DOUBLE_SET: + + + +``DOUBLE_SET`` +--------------- + +public static final :ref:`RealmFieldType ` + + + + + .. _io_realm_RealmFieldType_FLOAT: .. _RealmFieldType_FLOAT: @@ -448,6 +726,21 @@ public static final :ref:`RealmFieldType ` +.. _io_realm_RealmFieldType_FLOAT_SET: + +.. _RealmFieldType_FLOAT_SET: + + + +``FLOAT_SET`` +-------------- + +public static final :ref:`RealmFieldType ` + + + + + .. _io_realm_RealmFieldType_INTEGER: .. _RealmFieldType_INTEGER: @@ -478,6 +771,21 @@ public static final :ref:`RealmFieldType ` +.. _io_realm_RealmFieldType_INTEGER_SET: + +.. _RealmFieldType_INTEGER_SET: + + + +``INTEGER_SET`` +---------------- + +public static final :ref:`RealmFieldType ` + + + + + .. _io_realm_RealmFieldType_LINKING_OBJECTS: .. _RealmFieldType_LINKING_OBJECTS: @@ -493,6 +801,21 @@ public static final :ref:`RealmFieldType ` +.. _io_realm_RealmFieldType_LINK_SET: + +.. _RealmFieldType_LINK_SET: + + + +``LINK_SET`` +------------- + +public static final :ref:`RealmFieldType ` + + + + + .. _io_realm_RealmFieldType_LIST: .. _RealmFieldType_LIST: @@ -508,6 +831,51 @@ public static final :ref:`RealmFieldType ` +.. _io_realm_RealmFieldType_MIXED: + +.. _RealmFieldType_MIXED: + + + +``MIXED`` +---------- + +public static final :ref:`RealmFieldType ` + + + + + +.. _io_realm_RealmFieldType_MIXED_LIST: + +.. _RealmFieldType_MIXED_LIST: + + + +``MIXED_LIST`` +--------------- + +public static final :ref:`RealmFieldType ` + + + + + +.. _io_realm_RealmFieldType_MIXED_SET: + +.. _RealmFieldType_MIXED_SET: + + + +``MIXED_SET`` +-------------- + +public static final :ref:`RealmFieldType ` + + + + + .. _io_realm_RealmFieldType_OBJECT: .. _RealmFieldType_OBJECT: @@ -553,6 +921,21 @@ public static final :ref:`RealmFieldType ` +.. _io_realm_RealmFieldType_OBJECT_ID_SET: + +.. _RealmFieldType_OBJECT_ID_SET: + + + +``OBJECT_ID_SET`` +------------------ + +public static final :ref:`RealmFieldType ` + + + + + .. _io_realm_RealmFieldType_STRING: .. _RealmFieldType_STRING: @@ -583,6 +966,261 @@ public static final :ref:`RealmFieldType ` +.. _io_realm_RealmFieldType_STRING_SET: + +.. _RealmFieldType_STRING_SET: + + + +``STRING_SET`` +--------------- + +public static final :ref:`RealmFieldType ` + + + + + +.. _io_realm_RealmFieldType_STRING_TO_BINARY_MAP: + +.. _RealmFieldType_STRING_TO_BINARY_MAP: + + + +``STRING_TO_BINARY_MAP`` +------------------------- + +public static final :ref:`RealmFieldType ` + + + + + +.. _io_realm_RealmFieldType_STRING_TO_BOOLEAN_MAP: + +.. _RealmFieldType_STRING_TO_BOOLEAN_MAP: + + + +``STRING_TO_BOOLEAN_MAP`` +-------------------------- + +public static final :ref:`RealmFieldType ` + + + + + +.. _io_realm_RealmFieldType_STRING_TO_DATE_MAP: + +.. _RealmFieldType_STRING_TO_DATE_MAP: + + + +``STRING_TO_DATE_MAP`` +----------------------- + +public static final :ref:`RealmFieldType ` + + + + + +.. _io_realm_RealmFieldType_STRING_TO_DECIMAL128_MAP: + +.. _RealmFieldType_STRING_TO_DECIMAL128_MAP: + + + +``STRING_TO_DECIMAL128_MAP`` +----------------------------- + +public static final :ref:`RealmFieldType ` + + + + + +.. _io_realm_RealmFieldType_STRING_TO_DOUBLE_MAP: + +.. _RealmFieldType_STRING_TO_DOUBLE_MAP: + + + +``STRING_TO_DOUBLE_MAP`` +------------------------- + +public static final :ref:`RealmFieldType ` + + + + + +.. _io_realm_RealmFieldType_STRING_TO_FLOAT_MAP: + +.. _RealmFieldType_STRING_TO_FLOAT_MAP: + + + +``STRING_TO_FLOAT_MAP`` +------------------------ + +public static final :ref:`RealmFieldType ` + + + + + +.. _io_realm_RealmFieldType_STRING_TO_INTEGER_MAP: + +.. _RealmFieldType_STRING_TO_INTEGER_MAP: + + + +``STRING_TO_INTEGER_MAP`` +-------------------------- + +public static final :ref:`RealmFieldType ` + + + + + +.. _io_realm_RealmFieldType_STRING_TO_LINK_MAP: + +.. _RealmFieldType_STRING_TO_LINK_MAP: + + + +``STRING_TO_LINK_MAP`` +----------------------- + +public static final :ref:`RealmFieldType ` + + + + + +.. _io_realm_RealmFieldType_STRING_TO_MIXED_MAP: + +.. _RealmFieldType_STRING_TO_MIXED_MAP: + + + +``STRING_TO_MIXED_MAP`` +------------------------ + +public static final :ref:`RealmFieldType ` + + + + + +.. _io_realm_RealmFieldType_STRING_TO_OBJECT_ID_MAP: + +.. _RealmFieldType_STRING_TO_OBJECT_ID_MAP: + + + +``STRING_TO_OBJECT_ID_MAP`` +---------------------------- + +public static final :ref:`RealmFieldType ` + + + + + +.. _io_realm_RealmFieldType_STRING_TO_STRING_MAP: + +.. _RealmFieldType_STRING_TO_STRING_MAP: + + + +``STRING_TO_STRING_MAP`` +------------------------- + +public static final :ref:`RealmFieldType ` + + + + + +.. _io_realm_RealmFieldType_STRING_TO_UUID_MAP: + +.. _RealmFieldType_STRING_TO_UUID_MAP: + + + +``STRING_TO_UUID_MAP`` +----------------------- + +public static final :ref:`RealmFieldType ` + + + + + +.. _io_realm_RealmFieldType_TYPED_LINK: + +.. _RealmFieldType_TYPED_LINK: + + + +``TYPED_LINK`` +--------------- + +public static final :ref:`RealmFieldType ` + + + + + +.. _io_realm_RealmFieldType_UUID: + +.. _RealmFieldType_UUID: + + + +``UUID`` +--------- + +public static final :ref:`RealmFieldType ` + + + + + +.. _io_realm_RealmFieldType_UUID_LIST: + +.. _RealmFieldType_UUID_LIST: + + + +``UUID_LIST`` +-------------- + +public static final :ref:`RealmFieldType ` + + + + + +.. _io_realm_RealmFieldType_UUID_SET: + +.. _RealmFieldType_UUID_SET: + + + +``UUID_SET`` +------------- + +public static final :ref:`RealmFieldType ` + + + + + Method Detail ============= @@ -644,7 +1282,7 @@ fromNativeValue **Throws** - - `IllegalArgumentException `__ - if value isn't valid. + - `IllegalArgumentException `__ - if value isn't valid. @@ -737,7 +1375,7 @@ isValid :header-rows: 1 * - | public **boolean** :ref:`isValid ` ( - | `Object `__ obj + | `Object `__ obj | ) @@ -807,7 +1445,7 @@ valueOf :header-rows: 1 * - | public static :ref:`RealmFieldType ` :ref:`valueOf ` ( - | `String `__ name + | `String `__ name | ) diff --git a/source/sdk/java/api/io/realm/RealmList.txt b/source/sdk/java/api/io/realm/RealmList.txt index b032839ea2..51db4a91c8 100644 --- a/source/sdk/java/api/io/realm/RealmList.txt +++ b/source/sdk/java/api/io/realm/RealmList.txt @@ -18,9 +18,9 @@ io.realm ======== - | `java.lang.Object `__ - | `java.util.AbstractCollection `__ - | `java.util.AbstractList `__ + | `java.lang.Object `__ + | `java.util.AbstractCollection `__ + | `java.util.AbstractList `__ | io.realm.RealmList @@ -29,13 +29,12 @@ io.realm - :ref:`io.realm.OrderedRealmCollection ` -- `java.util.List `__ +- `java.util.List `__ - :ref:`io.realm.RealmCollection ` -- `java.util.Collection `__ -- `java.lang.Iterable `__ -- `java.util.Collection `__ -- **io.realm.internal.ManageableObject** -- `java.lang.Iterable `__ +- `java.util.Collection `__ +- `java.lang.Iterable `__ +- `java.util.Collection `__ +- `java.lang.Iterable `__ RealmList is used to model one-to-many relationships in a :ref:`io.realm.RealmObject ` . RealmList has two modes: A managed and unmanaged mode. In managed mode all objects are persisted inside a Realm, in unmanaged mode it works as a normal ArrayList. @@ -189,7 +188,7 @@ Method Summary * - public **double** - | :ref:`average ` ( - | `String `__ fieldName + | `String `__ fieldName | ) @@ -210,7 +209,7 @@ Method Summary * - public **boolean** - | :ref:`contains ` ( - | `Object `__ object + | `Object `__ object | ) @@ -300,7 +299,9 @@ Method Summary | - Returns a frozen snapshot of this collection. + + + @@ -333,7 +334,9 @@ Method Summary | - Returns whether or not this object is frozen. + + + @@ -370,7 +373,7 @@ Method Summary - * - public `Iterator `__ + * - public `Iterator `__ - | :ref:`iterator ` () | @@ -403,7 +406,7 @@ Method Summary - * - public `ListIterator `__ + * - public `ListIterator `__ - | :ref:`listIterator ` ( | **int** location | ) @@ -416,7 +419,7 @@ Method Summary - * - public `ListIterator `__ + * - public `ListIterator `__ - | :ref:`listIterator ` () | @@ -438,9 +441,9 @@ Method Summary - * - public `Number `__ + * - public `Number `__ - | :ref:`max ` ( - | `String `__ fieldName + | `String `__ fieldName | ) @@ -449,9 +452,9 @@ Method Summary - * - public `Date `__ + * - public `Date `__ - | :ref:`maxDate ` ( - | `String `__ fieldName + | `String `__ fieldName | ) @@ -460,9 +463,9 @@ Method Summary - * - public `Number `__ + * - public `Number `__ - | :ref:`min ` ( - | `String `__ fieldName + | `String `__ fieldName | ) @@ -471,9 +474,9 @@ Method Summary - * - public `Date `__ + * - public `Date `__ - | :ref:`minDate ` ( - | `String `__ fieldName + | `String `__ fieldName | ) @@ -496,7 +499,7 @@ Method Summary * - public **boolean** - | :ref:`remove ` ( - | `Object `__ object + | `Object `__ object | ) @@ -520,7 +523,7 @@ Method Summary * - public **boolean** - | :ref:`removeAll ` ( - | `java.util.Collection\ `__ collection + | `java.util.Collection\ `__ collection | ) @@ -589,7 +592,7 @@ Method Summary * - public :ref:`RealmResults ` - | :ref:`sort ` ( - | `java.lang.String[] `__ fieldNames, + | `java.lang.String[] `__ fieldNames, | :ref:`io.realm.Sort[] ` sortOrders | ) @@ -601,9 +604,9 @@ Method Summary * - public :ref:`RealmResults ` - | :ref:`sort ` ( - | `String `__ fieldName1, + | `String `__ fieldName1, | :ref:`Sort ` sortOrder1, - | `String `__ fieldName2, + | `String `__ fieldName2, | :ref:`Sort ` sortOrder2 | ) @@ -615,7 +618,7 @@ Method Summary * - public :ref:`RealmResults ` - | :ref:`sort ` ( - | `String `__ fieldName, + | `String `__ fieldName, | :ref:`Sort ` sortOrder | ) @@ -627,7 +630,7 @@ Method Summary * - public :ref:`RealmResults ` - | :ref:`sort ` ( - | `String `__ fieldName + | `String `__ fieldName | ) @@ -636,9 +639,9 @@ Method Summary - * - public `Number `__ + * - public `Number `__ - | :ref:`sum ` ( - | `String `__ fieldName + | `String `__ fieldName | ) @@ -647,7 +650,7 @@ Method Summary - * - public `String `__ + * - public `String `__ - | :ref:`toString ` () | @@ -675,9 +678,9 @@ Inherited Methods -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` -- Methods inherited from class `java.util.AbstractCollection `__ : ``iterator`` , ``size`` , ``isEmpty`` , ``contains`` , ``toArray`` , ``toArray`` , ``add`` , ``remove`` , ``containsAll`` , ``addAll`` , ``removeAll`` , ``retainAll`` , ``clear`` , ``toString`` -- Methods inherited from class `java.util.AbstractList `__ : ``add`` , ``get`` , ``set`` , ``add`` , ``remove`` , ``indexOf`` , ``lastIndexOf`` , ``clear`` , ``addAll`` , ``iterator`` , ``listIterator`` , ``listIterator`` , ``subList`` , ``equals`` , ``hashCode`` , ``removeRange`` +- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` +- Methods inherited from class `java.util.AbstractCollection `__ : ``iterator`` , ``size`` , ``isEmpty`` , ``contains`` , ``toArray`` , ``toArray`` , ``add`` , ``remove`` , ``containsAll`` , ``addAll`` , ``removeAll`` , ``retainAll`` , ``clear`` , ``toString`` +- Methods inherited from class `java.util.AbstractList `__ : ``add`` , ``get`` , ``set`` , ``add`` , ``remove`` , ``indexOf`` , ``lastIndexOf`` , ``clear`` , ``addAll`` , ``iterator`` , ``listIterator`` , ``listIterator`` , ``subList`` , ``equals`` , ``hashCode`` , ``removeRange`` @@ -721,7 +724,7 @@ Constructor Detail - * - Creates a RealmList in unmanaged mode, where the elements are not controlled by a Realm. This effectively makes the RealmList function as a `java.util.ArrayList `__ and it is not possible to query the objects in this state. + * - Creates a RealmList in unmanaged mode, where the elements are not controlled by a Realm. This effectively makes the RealmList function as a `java.util.ArrayList `__ and it is not possible to query the objects in this state. Use :ref:`io.realm.Realm.copyToRealm(Iterable, ImportFlag...) ` to properly persist its elements in Realm. @@ -757,7 +760,7 @@ Constructor Detail - * - Creates a RealmList in unmanaged mode with an initial list of elements. A RealmList in unmanaged mode function as a `java.util.ArrayList `__ and it is not possible to query the objects in this state. + * - Creates a RealmList in unmanaged mode with an initial list of elements. A RealmList in unmanaged mode function as a `java.util.ArrayList `__ and it is not possible to query the objects in this state. Use :ref:`io.realm.Realm.copyToRealm(Iterable, ImportFlag...) ` to properly persist all unmanaged elements in Realm. @@ -861,7 +864,7 @@ add **Throws** - - `IllegalStateException `__ - if Realm instance has been closed or parent object has been removed. + - `IllegalStateException `__ - if Realm instance has been closed or parent object has been removed. @@ -871,7 +874,7 @@ add **Overrides** - ``add`` in class `AbstractList `__ + ``add`` in class `AbstractList `__ @@ -936,11 +939,11 @@ add **Throws** - - `IllegalStateException `__ - if Realm instance has been closed or container object has been removed. + - `IllegalStateException `__ - if Realm instance has been closed or container object has been removed. - - `IndexOutOfBoundsException `__ - if ``location < 0 || location > size()`` . + - `IndexOutOfBoundsException `__ - if ``location < 0 || location > size()`` . @@ -952,7 +955,7 @@ add **Overrides** - ``add`` in class `AbstractList `__ + ``add`` in class `AbstractList `__ @@ -1049,13 +1052,13 @@ addChangeListener **Throws** - - `IllegalArgumentException `__ - if the change listener is ``null`` . + - `IllegalArgumentException `__ - if the change listener is ``null`` . - - `IllegalStateException `__ - if you try to add a listener from a non-Looper or `android.app.IntentService `__ thread. + - `IllegalStateException `__ - if you try to add a listener from a non-Looper or `android.app.IntentService `__ thread. @@ -1141,13 +1144,13 @@ addChangeListener **Throws** - - `IllegalArgumentException `__ - if the change listener is ``null`` . + - `IllegalArgumentException `__ - if the change listener is ``null`` . - - `IllegalStateException `__ - if you try to add a listener from a non-Looper or `android.app.IntentService `__ thread. + - `IllegalStateException `__ - if you try to add a listener from a non-Looper or `android.app.IntentService `__ thread. @@ -1233,11 +1236,11 @@ asChangesetObservable **Throws** - - `UnsupportedOperationException `__ - if the required RxJava framework is not on the classpath or the corresponding Realm instance doesn't support RxJava. + - `UnsupportedOperationException `__ - if the required RxJava framework is not on the classpath or the corresponding Realm instance doesn't support RxJava. - - `IllegalStateException `__ - if the Realm wasn't opened on a Looper thread. + - `IllegalStateException `__ - if the Realm wasn't opened on a Looper thread. @@ -1251,7 +1254,7 @@ asChangesetObservable - - `RxJava and Realm `__ + - `RxJava and Realm `__ @@ -1349,7 +1352,7 @@ asFlowable **Throws** - - `UnsupportedOperationException `__ - if the required RxJava framework is not on the classpath or the corresponding Realm instance doesn't support RxJava. + - `UnsupportedOperationException `__ - if the required RxJava framework is not on the classpath or the corresponding Realm instance doesn't support RxJava. @@ -1363,7 +1366,7 @@ asFlowable - - `RxJava and Realm `__ + - `RxJava and Realm `__ @@ -1410,7 +1413,7 @@ average :header-rows: 1 * - | public **double** :ref:`average ` ( - | `String `__ fieldName + | `String `__ fieldName | ) @@ -1476,7 +1479,7 @@ clear **Throws** - - `IllegalStateException `__ - if Realm instance has been closed or parent object has been removed. + - `IllegalStateException `__ - if Realm instance has been closed or parent object has been removed. @@ -1486,7 +1489,7 @@ clear **Overrides** - ``clear`` in class `AbstractList `__ + ``clear`` in class `AbstractList `__ @@ -1494,11 +1497,11 @@ clear - - `List.isEmpty `__ + - `List.isEmpty `__ - - `List.size `__ + - `List.size `__ @@ -1548,7 +1551,7 @@ contains :header-rows: 1 * - | public **boolean** :ref:`contains ` ( - | `Object `__ object + | `Object `__ object | ) @@ -1556,7 +1559,7 @@ contains * - Returns ``true`` if the list contains the specified element when attached to a Realm. This method will query the native Realm underlying storage engine to quickly find the specified element. - If the list is not attached to a Realm, the default `List.contains(Object) `__ implementation will occur. + If the list is not attached to a Realm, the default `List.contains(Object) `__ implementation will occur. @@ -1588,7 +1591,7 @@ contains **Overrides** - ``contains`` in class `AbstractCollection `__ + ``contains`` in class `AbstractCollection `__ @@ -1948,28 +1951,13 @@ freeze - * - Returns a frozen snapshot of this collection. The frozen copy can be read and queried from any thread without throwing an `IllegalStateException `__ . - - Freezing a collection also creates a Realm which has its own lifecycle, but if the live Realm that spawned the original collection is fully closed (i.e. all instances across all threads are closed), the frozen Realm and this collection will be closed as well. - - Frozen collections can be queried as normal, but trying to mutate it in any way or attempting to register a listener will throw an `IllegalStateException `__ . - - - - Note: Keeping a large number of frozen collections with different versions alive can have a negative impact on the filesize of the Realm. In order to avoid such a situation, it is possible to set :ref:`RealmConfiguration.Builder.maxNumberOfActiveVersions(long) ` . - - - - - + * - - **Returns** - a frozen copy of this collection. @@ -2038,11 +2026,11 @@ get **Throws** - - `IllegalStateException `__ - if Realm instance has been closed or parent object has been removed. + - `IllegalStateException `__ - if Realm instance has been closed or parent object has been removed. - - `IndexOutOfBoundsException `__ - if ``location < 0 || location >= size()`` . + - `IndexOutOfBoundsException `__ - if ``location < 0 || location >= size()`` . @@ -2054,7 +2042,7 @@ get **Overrides** - ``get`` in class `AbstractList `__ + ``get`` in class `AbstractList `__ @@ -2111,7 +2099,7 @@ getRealm **Throws** - - `IllegalStateException `__ - if the Realm is an instance of :ref:`DynamicRealm ` or the :ref:`Realm ` was already closed. + - `IllegalStateException `__ - if the Realm is an instance of :ref:`DynamicRealm ` or the :ref:`Realm ` was already closed. @@ -2152,16 +2140,11 @@ isFrozen - * - Returns whether or not this object is frozen. - - - + * - - **Returns** - ``true`` if the object is frozen, ``false`` if it is not. @@ -2348,7 +2331,7 @@ iterator .. list-table:: :header-rows: 1 - * - | public `Iterator `__ :ref:`iterator ` () + * - | public `Iterator `__ :ref:`iterator ` () | @@ -2369,7 +2352,7 @@ iterator **Overrides** - ``iterator`` in class `AbstractList `__ + ``iterator`` in class `AbstractList `__ @@ -2484,7 +2467,7 @@ listIterator .. list-table:: :header-rows: 1 - * - | public `ListIterator `__ :ref:`listIterator ` ( + * - | public `ListIterator `__ :ref:`listIterator ` ( | **int** location | ) @@ -2506,7 +2489,7 @@ listIterator **Overrides** - ``listIterator`` in class `AbstractList `__ + ``listIterator`` in class `AbstractList `__ @@ -2514,7 +2497,7 @@ listIterator .. list-table:: :header-rows: 1 - * - | public `ListIterator `__ :ref:`listIterator ` () + * - | public `ListIterator `__ :ref:`listIterator ` () | @@ -2535,7 +2518,7 @@ listIterator **Overrides** - ``listIterator`` in class `AbstractList `__ + ``listIterator`` in class `AbstractList `__ @@ -2623,8 +2606,8 @@ max .. list-table:: :header-rows: 1 - * - | public `Number `__ :ref:`max ` ( - | `String `__ fieldName + * - | public `Number `__ :ref:`max ` ( + | `String `__ fieldName | ) @@ -2685,8 +2668,8 @@ maxDate .. list-table:: :header-rows: 1 - * - | public `Date `__ :ref:`maxDate ` ( - | `String `__ fieldName + * - | public `Date `__ :ref:`maxDate ` ( + | `String `__ fieldName | ) @@ -2747,8 +2730,8 @@ min .. list-table:: :header-rows: 1 - * - | public `Number `__ :ref:`min ` ( - | `String `__ fieldName + * - | public `Number `__ :ref:`min ` ( + | `String `__ fieldName | ) @@ -2809,8 +2792,8 @@ minDate .. list-table:: :header-rows: 1 - * - | public `Date `__ :ref:`minDate ` ( - | `String `__ fieldName + * - | public `Date `__ :ref:`minDate ` ( + | `String `__ fieldName | ) @@ -2904,11 +2887,11 @@ move **Throws** - - `IllegalStateException `__ - if Realm instance has been closed or parent object has been removed. + - `IllegalStateException `__ - if Realm instance has been closed or parent object has been removed. - - `java.lang.IndexOutOfBoundsException `__ - if any position is outside [0, size()]. + - `java.lang.IndexOutOfBoundsException `__ - if any position is outside [0, size()]. @@ -2954,7 +2937,7 @@ remove :header-rows: 1 * - | public **boolean** :ref:`remove ` ( - | `Object `__ object + | `Object `__ object | ) @@ -2988,11 +2971,11 @@ remove **Throws** - - `ClassCastException `__ - if the object passed is not of the correct type. + - `ClassCastException `__ - if the object passed is not of the correct type. - - `NullPointerException `__ - if ``object`` is ``null`` . + - `NullPointerException `__ - if ``object`` is ``null`` . @@ -3004,7 +2987,7 @@ remove **Overrides** - ``remove`` in class `AbstractCollection `__ + ``remove`` in class `AbstractCollection `__ @@ -3049,11 +3032,11 @@ remove **Throws** - - `IllegalStateException `__ - if Realm instance has been closed or parent object has been removed. + - `IllegalStateException `__ - if Realm instance has been closed or parent object has been removed. - - `IndexOutOfBoundsException `__ - if ``location < 0 || location >= size()`` . + - `IndexOutOfBoundsException `__ - if ``location < 0 || location >= size()`` . @@ -3065,7 +3048,7 @@ remove **Overrides** - ``remove`` in class `AbstractList `__ + ``remove`` in class `AbstractList `__ @@ -3107,7 +3090,7 @@ removeAll :header-rows: 1 * - | public **boolean** :ref:`removeAll ` ( - | `java.util.Collection\ `__ collection + | `java.util.Collection\ `__ collection | ) @@ -3145,13 +3128,13 @@ removeAll **Throws** - - `ClassCastException `__ - if one or more elements of ``collection`` isn't of the correct type. + - `ClassCastException `__ - if one or more elements of ``collection`` isn't of the correct type. - - `NullPointerException `__ - if ``collection`` is ``null`` . + - `NullPointerException `__ - if ``collection`` is ``null`` . @@ -3163,7 +3146,7 @@ removeAll **Overrides** - ``removeAll`` in class `AbstractCollection `__ + ``removeAll`` in class `AbstractCollection `__ @@ -3207,7 +3190,7 @@ removeAllChangeListeners **Throws** - - `IllegalStateException `__ - if you try to remove listeners from a non-Looper Thread. + - `IllegalStateException `__ - if you try to remove listeners from a non-Looper Thread. @@ -3294,13 +3277,13 @@ removeChangeListener **Throws** - - `IllegalArgumentException `__ - if the change listener is ``null`` . + - `IllegalArgumentException `__ - if the change listener is ``null`` . - - `IllegalStateException `__ - if you try to remove a listener from a non-Looper Thread. + - `IllegalStateException `__ - if you try to remove a listener from a non-Looper Thread. @@ -3368,13 +3351,13 @@ removeChangeListener **Throws** - - `IllegalArgumentException `__ - if the change listener is ``null`` . + - `IllegalArgumentException `__ - if the change listener is ``null`` . - - `IllegalStateException `__ - if you try to remove a listener from a non-Looper Thread. + - `IllegalStateException `__ - if you try to remove a listener from a non-Looper Thread. @@ -3483,11 +3466,11 @@ set **Throws** - - `IllegalStateException `__ - if Realm instance has been closed or parent object has been removed. + - `IllegalStateException `__ - if Realm instance has been closed or parent object has been removed. - - `IndexOutOfBoundsException `__ - if ``location < 0 || location >= size()`` . + - `IndexOutOfBoundsException `__ - if ``location < 0 || location >= size()`` . @@ -3499,7 +3482,7 @@ set **Overrides** - ``set`` in class `AbstractList `__ + ``set`` in class `AbstractList `__ @@ -3552,7 +3535,7 @@ size **Throws** - - `IllegalStateException `__ - if Realm instance has been closed or parent object has been removed. + - `IllegalStateException `__ - if Realm instance has been closed or parent object has been removed. @@ -3562,7 +3545,7 @@ size **Overrides** - ``size`` in class `AbstractCollection `__ + ``size`` in class `AbstractCollection `__ @@ -3700,7 +3683,7 @@ sort :header-rows: 1 * - | public :ref:`RealmResults ` :ref:`sort ` ( - | `java.lang.String[] `__ fieldNames, + | `java.lang.String[] `__ fieldNames, | :ref:`io.realm.Sort[] ` sortOrders | ) @@ -3924,9 +3907,9 @@ sort :header-rows: 1 * - | public :ref:`RealmResults ` :ref:`sort ` ( - | `String `__ fieldName1, + | `String `__ fieldName1, | :ref:`Sort ` sortOrder1, - | `String `__ fieldName2, + | `String `__ fieldName2, | :ref:`Sort ` sortOrder2 | ) @@ -4006,7 +3989,7 @@ sort :header-rows: 1 * - | public :ref:`RealmResults ` :ref:`sort ` ( - | `String `__ fieldName, + | `String `__ fieldName, | :ref:`Sort ` sortOrder | ) @@ -4050,7 +4033,7 @@ sort :header-rows: 1 * - | public :ref:`RealmResults ` :ref:`sort ` ( - | `String `__ fieldName + | `String `__ fieldName | ) @@ -4111,8 +4094,8 @@ sum .. list-table:: :header-rows: 1 - * - | public `Number `__ :ref:`sum ` ( - | `String `__ fieldName + * - | public `Number `__ :ref:`sum ` ( + | `String `__ fieldName | ) @@ -4161,7 +4144,7 @@ toString .. list-table:: :header-rows: 1 - * - | public `String `__ :ref:`toString ` () + * - | public `String `__ :ref:`toString ` () | @@ -4180,7 +4163,7 @@ toString **Overrides** - ``toString`` in class `AbstractCollection `__ + ``toString`` in class `AbstractCollection `__ @@ -4229,7 +4212,7 @@ where **Throws** - - `IllegalStateException `__ - if Realm instance has been closed or parent object has been removed. + - `IllegalStateException `__ - if Realm instance has been closed or parent object has been removed. diff --git a/source/sdk/java/api/io/realm/RealmMap.txt b/source/sdk/java/api/io/realm/RealmMap.txt new file mode 100644 index 0000000000..6bf49f6b03 --- /dev/null +++ b/source/sdk/java/api/io/realm/RealmMap.txt @@ -0,0 +1,1502 @@ + +.. contents:: On this page + :local: + :backlinks: none + :depth: 2 + :class: singlecol + + + +Class RealmMap +^^^^^^^^^^^^^^ + +.. _io_realm_RealmMap: + + + +io.realm +======== + + + | `java.lang.Object `__ + | io.realm.RealmMap + + +**Implemented interfaces:** + + + +- `java.util.Map `__ + + +RealmMap is used to map keys to values. A RealmMap cannot contain duplicate keys and each key can map to at most one value. A RealmMap cannot have ``null`` keys but can have ``null`` values. + +Similarly to :ref:`RealmList ` s, a RealmDictionary can operate in managed and unmanaged modes. In managed mode a RealmDictionary persists all its contents inside a Realm whereas in unmanaged mode it functions like a `HashMap `__ . + + + +Managed RealmDictionaries can only be created by Realm and will automatically update its content whenever the underlying Realm is updated. Managed RealmDictionaries can only be accessed using the getter that points to a RealmDictionary field of a :ref:`RealmObject ` . + + + +Unmanaged RealmDictionaries can be created by the user and can contain both managed and unmanaged RealmObjects. This is useful when dealing with JSON deserializers like GSON or other frameworks that inject values into a class. Unmanaged RealmMaps can be added to a Realm using the :ref:`Realm.copyToRealm(Iterable, ImportFlag...) ` method. + + + + + + +Method Summary +============== + +.. list-table:: + :header-rows: 1 + + * - Modifier and Type + - Method and Description + + * - public **void** + - | :ref:`addChangeListener ` ( + | :ref:`io.realm.RealmChangeListener\> ` listener + | ) + + + Adds a change listener to this :ref:`RealmMap ` . + + + + + + + * - public **void** + - | :ref:`addChangeListener ` ( + | :ref:`io.realm.MapChangeListener\ ` listener + | ) + + + Adds a change listener to this :ref:`RealmMap ` . + + + + + + + * - public **void** + - | :ref:`clear ` () + | + + + + + + + + * - public **boolean** + - | :ref:`containsKey ` ( + | `Object `__ key + | ) + + + + + + + + * - public **boolean** + - | :ref:`containsValue ` ( + | `Object `__ value + | ) + + + + + + + + * - public `Set `__ + - | :ref:`entrySet ` () + | + + + + + + + + * - public :ref:`RealmMap ` + - | :ref:`freeze ` () + | + + + + + + + + * - public **V** + - | :ref:`get ` ( + | `Object `__ key + | ) + + + + + + + + * - public **boolean** + - | :ref:`isEmpty ` () + | + + + + + + + + * - public **boolean** + - | :ref:`isFrozen ` () + | + + + + + + + + + + * - public **boolean** + - | :ref:`isManaged ` () + | + + + + + + + + + + * - public **boolean** + - | :ref:`isValid ` () + | + + + + + + + + + + * - public `Set `__ + - | :ref:`keySet ` () + | + + + + + + + + * - public **V** + - | :ref:`put ` ( + | **K** key, + | **V** value + | ) + + + + + + + + * - public **void** + - | :ref:`putAll ` ( + | `java.util.Map\ `__ m + | ) + + + + + + + + * - public **V** + - | :ref:`remove ` ( + | `Object `__ key + | ) + + + + + + + + * - public **void** + - | :ref:`removeAllChangeListeners ` () + | + + + Removes all user-defined change listeners. + + + + + * - public **void** + - | :ref:`removeChangeListener ` ( + | :ref:`io.realm.RealmChangeListener\> ` listener + | ) + + + Removes the specified change listener. + + + + + * - public **void** + - | :ref:`removeChangeListener ` ( + | :ref:`io.realm.MapChangeListener\ ` listener + | ) + + + Removes the specified change listener. + + + + + * - public **int** + - | :ref:`size ` () + | + + + + + + + + * - public `Collection `__ + - | :ref:`values ` () + | + + + + + + + + + + +Inherited Methods +================= + + + +- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` + + + + +Method Detail +============= + +.. _addChangeListener: + +.. _addChangeListener__: + +.. _RealmMap_addChangeListener: + +.. _RealmMap_addChangeListener__: + +.. _io_realm_RealmMap_addChangeListener: + +.. _io_realm_RealmMap_addChangeListener__: + + + +addChangeListener +----------------- + +.. _io_realm_RealmMap_addChangeListener_io_realm_RealmChangeListener_: + +.. _io_realm_RealmMap_addChangeListener_RealmChangeListener_: + +.. _addChangeListener_io_realm_RealmChangeListener_: + +.. _addChangeListener_RealmChangeListener_: + +.. _RealmMap_addChangeListener_io_realm_RealmChangeListener_: + +.. _RealmMap_addChangeListener_RealmChangeListener_: + +.. _io_realm_RealmMap_addChangeListener_RealmChangeListener_RealmMap_K__V___: + +.. list-table:: + :header-rows: 1 + + * - | public **void** :ref:`addChangeListener ` ( + | :ref:`io.realm.RealmChangeListener\> ` listener + | ) + + + + + * - Adds a change listener to this :ref:`RealmMap ` . + + Registering a change listener will not prevent the underlying RealmMap from being garbage collected. If the RealmMap 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. + + + + .. code-block:: java + + + public class MyActivity extends Activity { + + private RealmMap dogs; // Strong reference to keep listeners alive + + @Override + protected void onCreate(Bundle savedInstanceState) { + super.onCreate(savedInstanceState); + dogs = realm.where(Person.class).findFirst().getDogs(); + dogs.addChangeListener(new RealmChangeListener>() { + @Override + public void onChange(RealmMap map) { + // 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 `android.app.IntentService `__ thread. + + + + + + + + + + + + .. seealso:: + + + + - :ref:`io.realm.RealmChangeListener ` + + + + + + + + + + +.. _io_realm_RealmMap_addChangeListener_io_realm_MapChangeListener_: + +.. _io_realm_RealmMap_addChangeListener_MapChangeListener_: + +.. _addChangeListener_io_realm_MapChangeListener_: + +.. _addChangeListener_MapChangeListener_: + +.. _RealmMap_addChangeListener_io_realm_MapChangeListener_: + +.. _RealmMap_addChangeListener_MapChangeListener_: + +.. _io_realm_RealmMap_addChangeListener_MapChangeListener_K__V__: + +.. list-table:: + :header-rows: 1 + + * - | public **void** :ref:`addChangeListener ` ( + | :ref:`io.realm.MapChangeListener\ ` listener + | ) + + + + + * - Adds a change listener to this :ref:`RealmMap ` . + + Registering a change listener will not prevent the underlying RealmMap from being garbage collected. If the RealmMap 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. + + + + .. code-block:: java + + + public class MyActivity extends Activity { + + private RealmMap dogs; // Strong reference to keep listeners alive + + @Override + protected void onCreate(Bundle savedInstanceState) { + super.onCreate(savedInstanceState); + dogs = realm.where(Person.class).findFirst().getDogs(); + dogs.addChangeListener(new MapChangeListener() { + @Override + public void onChange(RealmMap map, MapChangeSet 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 `android.app.IntentService `__ thread. + + + + + + + + + + + + + + +.. _clear: + +.. _clear__: + +.. _RealmMap_clear: + +.. _RealmMap_clear__: + +.. _io_realm_RealmMap_clear: + +.. _io_realm_RealmMap_clear__: + + + +clear +----- + +.. list-table:: + :header-rows: 1 + + * - | public **void** :ref:`clear ` () + | + + + + + * - + + + + + + + + + + + + + + + +.. _containsKey: + +.. _containsKey__: + +.. _RealmMap_containsKey: + +.. _RealmMap_containsKey__: + +.. _io_realm_RealmMap_containsKey: + +.. _io_realm_RealmMap_containsKey__: + + + +containsKey +----------- + +.. _io_realm_RealmMap_containsKey_java_lang_Object_: + +.. _io_realm_RealmMap_containsKey_Object_: + +.. _containsKey_java_lang_Object_: + +.. _containsKey_Object_: + +.. _RealmMap_containsKey_java_lang_Object_: + +.. _RealmMap_containsKey_Object_: + +.. list-table:: + :header-rows: 1 + + * - | public **boolean** :ref:`containsKey ` ( + | `Object `__ key + | ) + + + + + * - + + + + + + + + + + + + + + + +.. _containsValue: + +.. _containsValue__: + +.. _RealmMap_containsValue: + +.. _RealmMap_containsValue__: + +.. _io_realm_RealmMap_containsValue: + +.. _io_realm_RealmMap_containsValue__: + + + +containsValue +------------- + +.. _io_realm_RealmMap_containsValue_java_lang_Object_: + +.. _io_realm_RealmMap_containsValue_Object_: + +.. _containsValue_java_lang_Object_: + +.. _containsValue_Object_: + +.. _RealmMap_containsValue_java_lang_Object_: + +.. _RealmMap_containsValue_Object_: + +.. list-table:: + :header-rows: 1 + + * - | public **boolean** :ref:`containsValue ` ( + | `Object `__ value + | ) + + + + + * - + + + + + + + + + + + + + + + +.. _entrySet: + +.. _entrySet__: + +.. _RealmMap_entrySet: + +.. _RealmMap_entrySet__: + +.. _io_realm_RealmMap_entrySet: + +.. _io_realm_RealmMap_entrySet__: + + + +entrySet +-------- + +.. list-table:: + :header-rows: 1 + + * - | public `Set `__ :ref:`entrySet ` () + | + + + + + * - + + + + + + + + + + + + + + + +.. _freeze: + +.. _freeze__: + +.. _RealmMap_freeze: + +.. _RealmMap_freeze__: + +.. _io_realm_RealmMap_freeze: + +.. _io_realm_RealmMap_freeze__: + + + +freeze +------ + +.. list-table:: + :header-rows: 1 + + * - | public :ref:`RealmMap ` :ref:`freeze ` () + | + + + + + * - + + + + + + + + + + + + + + + +.. _get: + +.. _get__: + +.. _RealmMap_get: + +.. _RealmMap_get__: + +.. _io_realm_RealmMap_get: + +.. _io_realm_RealmMap_get__: + + + +get +---- + +.. _io_realm_RealmMap_get_java_lang_Object_: + +.. _io_realm_RealmMap_get_Object_: + +.. _get_java_lang_Object_: + +.. _get_Object_: + +.. _RealmMap_get_java_lang_Object_: + +.. _RealmMap_get_Object_: + +.. list-table:: + :header-rows: 1 + + * - | public **V** :ref:`get ` ( + | `Object `__ key + | ) + + + + + * - + + + + + + + + + + + + + + + +.. _isEmpty: + +.. _isEmpty__: + +.. _RealmMap_isEmpty: + +.. _RealmMap_isEmpty__: + +.. _io_realm_RealmMap_isEmpty: + +.. _io_realm_RealmMap_isEmpty__: + + + +isEmpty +------- + +.. list-table:: + :header-rows: 1 + + * - | public **boolean** :ref:`isEmpty ` () + | + + + + + * - + + + + + + + + + + + + + + + +.. _isFrozen: + +.. _isFrozen__: + +.. _RealmMap_isFrozen: + +.. _RealmMap_isFrozen__: + +.. _io_realm_RealmMap_isFrozen: + +.. _io_realm_RealmMap_isFrozen__: + + + +isFrozen +-------- + +.. list-table:: + :header-rows: 1 + + * - | public **boolean** :ref:`isFrozen ` () + | + + + + + * - + + + + + + + + + + + + + + + + + +.. _isManaged: + +.. _isManaged__: + +.. _RealmMap_isManaged: + +.. _RealmMap_isManaged__: + +.. _io_realm_RealmMap_isManaged: + +.. _io_realm_RealmMap_isManaged__: + + + +isManaged +--------- + +.. list-table:: + :header-rows: 1 + + * - | public **boolean** :ref:`isManaged ` () + | + + + + + * - + + + + + + + + + + + + + + + + + +.. _isValid: + +.. _isValid__: + +.. _RealmMap_isValid: + +.. _RealmMap_isValid__: + +.. _io_realm_RealmMap_isValid: + +.. _io_realm_RealmMap_isValid__: + + + +isValid +------- + +.. list-table:: + :header-rows: 1 + + * - | public **boolean** :ref:`isValid ` () + | + + + + + * - + + + + + + + + + + + + + + + + + +.. _keySet: + +.. _keySet__: + +.. _RealmMap_keySet: + +.. _RealmMap_keySet__: + +.. _io_realm_RealmMap_keySet: + +.. _io_realm_RealmMap_keySet__: + + + +keySet +------ + +.. list-table:: + :header-rows: 1 + + * - | public `Set `__ :ref:`keySet ` () + | + + + + + * - + + + + + + + + + + + + + + + +.. _put: + +.. _put__: + +.. _RealmMap_put: + +.. _RealmMap_put__: + +.. _io_realm_RealmMap_put: + +.. _io_realm_RealmMap_put__: + + + +put +---- + +.. _io_realm_RealmMap_put_K_V_: + +.. _io_realm_RealmMap_put_K__V_: + +.. _put_K_V_: + +.. _put_K__V_: + +.. _RealmMap_put_K_V_: + +.. _RealmMap_put_K__V_: + +.. list-table:: + :header-rows: 1 + + * - | public **V** :ref:`put ` ( + | **K** key, + | **V** value + | ) + + + + + * - + + + + + + + + + + + + + + + +.. _putAll: + +.. _putAll__: + +.. _RealmMap_putAll: + +.. _RealmMap_putAll__: + +.. _io_realm_RealmMap_putAll: + +.. _io_realm_RealmMap_putAll__: + + + +putAll +------ + +.. _io_realm_RealmMap_putAll_java_util_Map_: + +.. _io_realm_RealmMap_putAll_Map_: + +.. _io_realm_RealmMap_putAll_Map___extends_K____extends_V__: + +.. _putAll_java_util_Map_: + +.. _putAll_Map_: + +.. _putAll_Map___extends_K____extends_V__: + +.. _RealmMap_putAll_java_util_Map_: + +.. _RealmMap_putAll_Map_: + +.. _RealmMap_putAll_Map___extends_K____extends_V__: + +.. list-table:: + :header-rows: 1 + + * - | public **void** :ref:`putAll ` ( + | `java.util.Map\ `__ m + | ) + + + + + * - + + + + + + + + + + + + + + + +.. _remove: + +.. _remove__: + +.. _RealmMap_remove: + +.. _RealmMap_remove__: + +.. _io_realm_RealmMap_remove: + +.. _io_realm_RealmMap_remove__: + + + +remove +------ + +.. _io_realm_RealmMap_remove_java_lang_Object_: + +.. _io_realm_RealmMap_remove_Object_: + +.. _remove_java_lang_Object_: + +.. _remove_Object_: + +.. _RealmMap_remove_java_lang_Object_: + +.. _RealmMap_remove_Object_: + +.. list-table:: + :header-rows: 1 + + * - | public **V** :ref:`remove ` ( + | `Object `__ key + | ) + + + + + * - + + + + + + + + + + + + + + + +.. _removeAllChangeListeners: + +.. _removeAllChangeListeners__: + +.. _RealmMap_removeAllChangeListeners: + +.. _RealmMap_removeAllChangeListeners__: + +.. _io_realm_RealmMap_removeAllChangeListeners: + +.. _io_realm_RealmMap_removeAllChangeListeners__: + + + +removeAllChangeListeners +------------------------ + +.. list-table:: + :header-rows: 1 + + * - | public **void** :ref:`removeAllChangeListeners ` () + | + + + + + * - Removes all user-defined change listeners. + + + + + + + + + **Throws** + + - `IllegalStateException `__ - if you try to remove listeners from a non-Looper Thread. + + + + + + + + + + .. seealso:: + + + + - :ref:`io.realm.RealmChangeListener ` + + + + + + + + + + + + +.. _removeChangeListener: + +.. _removeChangeListener__: + +.. _RealmMap_removeChangeListener: + +.. _RealmMap_removeChangeListener__: + +.. _io_realm_RealmMap_removeChangeListener: + +.. _io_realm_RealmMap_removeChangeListener__: + + + +removeChangeListener +-------------------- + +.. _io_realm_RealmMap_removeChangeListener_io_realm_RealmChangeListener_: + +.. _io_realm_RealmMap_removeChangeListener_RealmChangeListener_: + +.. _removeChangeListener_io_realm_RealmChangeListener_: + +.. _removeChangeListener_RealmChangeListener_: + +.. _RealmMap_removeChangeListener_io_realm_RealmChangeListener_: + +.. _RealmMap_removeChangeListener_RealmChangeListener_: + +.. _io_realm_RealmMap_removeChangeListener_RealmChangeListener_RealmMap_K__V___: + +.. list-table:: + :header-rows: 1 + + * - | public **void** :ref:`removeChangeListener ` ( + | :ref:`io.realm.RealmChangeListener\> ` 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. + + + + + + + + + + .. seealso:: + + + + - :ref:`io.realm.RealmChangeListener ` + + + + + + + + + + +.. _io_realm_RealmMap_removeChangeListener_io_realm_MapChangeListener_: + +.. _io_realm_RealmMap_removeChangeListener_MapChangeListener_: + +.. _removeChangeListener_io_realm_MapChangeListener_: + +.. _removeChangeListener_MapChangeListener_: + +.. _RealmMap_removeChangeListener_io_realm_MapChangeListener_: + +.. _RealmMap_removeChangeListener_MapChangeListener_: + +.. _io_realm_RealmMap_removeChangeListener_MapChangeListener_K__V__: + +.. list-table:: + :header-rows: 1 + + * - | public **void** :ref:`removeChangeListener ` ( + | :ref:`io.realm.MapChangeListener\ ` 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. + + + + + + + + + + + + +.. _size: + +.. _size__: + +.. _RealmMap_size: + +.. _RealmMap_size__: + +.. _io_realm_RealmMap_size: + +.. _io_realm_RealmMap_size__: + + + +size +---- + +.. list-table:: + :header-rows: 1 + + * - | public **int** :ref:`size ` () + | + + + + + * - + + + + + + + + + + + + + + + +.. _values: + +.. _values__: + +.. _RealmMap_values: + +.. _RealmMap_values__: + +.. _io_realm_RealmMap_values: + +.. _io_realm_RealmMap_values__: + + + +values +------ + +.. list-table:: + :header-rows: 1 + + * - | public `Collection `__ :ref:`values ` () + | + + + + + * - + + + + + + + + + + + + + + + + diff --git a/source/sdk/java/api/io/realm/RealmObject.txt b/source/sdk/java/api/io/realm/RealmObject.txt index e2943f19e5..c688f0f520 100644 --- a/source/sdk/java/api/io/realm/RealmObject.txt +++ b/source/sdk/java/api/io/realm/RealmObject.txt @@ -18,7 +18,7 @@ io.realm ======== - | `java.lang.Object `__ + | `java.lang.Object `__ | io.realm.RealmObject @@ -27,7 +27,6 @@ io.realm - :ref:`io.realm.RealmModel ` -- **io.realm.internal.ManageableObject** In Realm you define your RealmObject classes by sub-classing RealmObject and adding fields to be persisted. You then create your objects within a Realm, and use your custom subclasses instead of using the RealmObject class directly.An annotation processor will create a proxy class for your RealmObject subclass. @@ -63,6 +62,9 @@ The following field data types are supported: - Date +- UUID + + - org.bson.types.Decimal128 @@ -75,6 +77,9 @@ The following field data types are supported: - RealmList +- RealmDictionary + + The types ``short`` , ``int`` , and ``long`` are mapped to ``long`` when storing within a Realm. @@ -480,7 +485,7 @@ Inherited Methods -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` +- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` @@ -651,19 +656,19 @@ addChangeListener **Throws** - - `IllegalArgumentException `__ - if the ``object`` is ``null`` or an unmanaged object, or the change listener is ``null`` . + - `IllegalArgumentException `__ - if the ``object`` is ``null`` or an unmanaged object, or the change listener is ``null`` . - - `IllegalStateException `__ - if you try to add a listener from a non-Looper or `IntentService `__ thread. + - `IllegalStateException `__ - if you try to add a listener from a non-Looper or **IntentService** thread. - - `IllegalStateException `__ - if you try to add a listener inside a transaction. + - `IllegalStateException `__ - if you try to add a listener inside a transaction. @@ -786,19 +791,19 @@ addChangeListener **Throws** - - `IllegalArgumentException `__ - if the ``object`` is ``null`` or an unmanaged object, or the change listener is ``null`` . + - `IllegalArgumentException `__ - if the ``object`` is ``null`` or an unmanaged object, or the change listener is ``null`` . - - `IllegalStateException `__ - if you try to add a listener from a non-Looper or `IntentService `__ thread. + - `IllegalStateException `__ - if you try to add a listener from a non-Looper or **IntentService** thread. - - `IllegalStateException `__ - if you try to add a listener inside a transaction. + - `IllegalStateException `__ - if you try to add a listener inside a transaction. @@ -880,19 +885,19 @@ addChangeListener **Throws** - - `IllegalArgumentException `__ - if the change listener is ``null`` or the object is an unmanaged object. + - `IllegalArgumentException `__ - if the change listener is ``null`` or the object is an unmanaged object. - - `IllegalStateException `__ - if you try to add a listener from a non-Looper or `IntentService `__ thread. + - `IllegalStateException `__ - if you try to add a listener from a non-Looper or **IntentService** thread. - - `IllegalStateException `__ - if you try to add a listener inside a transaction. + - `IllegalStateException `__ - if you try to add a listener inside a transaction. @@ -974,19 +979,19 @@ addChangeListener **Throws** - - `IllegalArgumentException `__ - if the change listener is ``null`` or the object is an unmanaged object. + - `IllegalArgumentException `__ - if the change listener is ``null`` or the object is an unmanaged object. - - `IllegalStateException `__ - if you try to add a listener from a non-Looper or `IntentService `__ thread. + - `IllegalStateException `__ - if you try to add a listener from a non-Looper or **IntentService** thread. - - `IllegalStateException `__ - if you try to add a listener inside a transaction. + - `IllegalStateException `__ - if you try to add a listener inside a transaction. @@ -1091,11 +1096,11 @@ asChangesetObservable **Throws** - - `UnsupportedOperationException `__ - if the required RxJava framework is not on the classpath or the corresponding Realm instance doesn't support RxJava. + - `UnsupportedOperationException `__ - if the required RxJava framework is not on the classpath or the corresponding Realm instance doesn't support RxJava. - - `IllegalStateException `__ - if the Realm wasn't opened on a Looper thread. + - `IllegalStateException `__ - if the Realm wasn't opened on a Looper thread. @@ -1175,11 +1180,11 @@ asChangesetObservable **Throws** - - `UnsupportedOperationException `__ - if the required RxJava framework is not on the classpath or the corresponding Realm instance doesn't support RxJava. + - `UnsupportedOperationException `__ - if the required RxJava framework is not on the classpath or the corresponding Realm instance doesn't support RxJava. - - `IllegalStateException `__ - if the Realm wasn't opened on a Looper thread. + - `IllegalStateException `__ - if the Realm wasn't opened on a Looper thread. @@ -1317,11 +1322,11 @@ asFlowable **Throws** - - `UnsupportedOperationException `__ - if the required RxJava framework is not on the classpath. + - `UnsupportedOperationException `__ - if the required RxJava framework is not on the classpath. - - `IllegalStateException `__ - if the Realm wasn't opened on a Looper thread. + - `IllegalStateException `__ - if the Realm wasn't opened on a Looper thread. @@ -1427,11 +1432,11 @@ asFlowable **Throws** - - `UnsupportedOperationException `__ - if the required RxJava framework is not on the classpath or the corresponding Realm instance doesn't support RxJava. + - `UnsupportedOperationException `__ - if the required RxJava framework is not on the classpath or the corresponding Realm instance doesn't support RxJava. - - `IllegalStateException `__ - if the Realm wasn't opened on a Looper thread. + - `IllegalStateException `__ - if the Realm wasn't opened on a Looper thread. @@ -1511,7 +1516,7 @@ deleteFromRealm **Throws** - - `IllegalStateException `__ - if the corresponding Realm is closed or in an incorrect thread. + - `IllegalStateException `__ - if the corresponding Realm is closed or in an incorrect thread. @@ -1558,7 +1563,7 @@ deleteFromRealm **Throws** - - `IllegalStateException `__ - if the corresponding Realm is closed or in an incorrect thread. + - `IllegalStateException `__ - if the corresponding Realm is closed or in an incorrect thread. @@ -1624,11 +1629,11 @@ freeze - * - Returns a frozen snapshot of this object. The frozen copy can be read and queried from any thread without throwing an `IllegalStateException `__ . + * - Returns a frozen snapshot of this object. The frozen copy can be read and queried from any thread without throwing an `IllegalStateException `__ . Freezing a RealmObject also creates a frozen Realm which has its own lifecycle, but if the live Realm that spawned the original collection is fully closed (i.e. all instances across all threads are closed), the frozen Realm and object will be closed as well. - Frozen objects can be queried as normal, but trying to mutate it in any way or attempting to register a listener will throw an `IllegalStateException `__ . + Frozen objects can be queried as normal, but trying to mutate it in any way or attempting to register a listener will throw an `IllegalStateException `__ . @@ -1652,7 +1657,7 @@ freeze **Throws** - - `IllegalStateException `__ - if this method is called from inside a write transaction. + - `IllegalStateException `__ - if this method is called from inside a write transaction. @@ -1672,11 +1677,11 @@ freeze - * - Returns a frozen snapshot of this object. The frozen copy can be read and queried from any thread without throwing an `IllegalStateException `__ . + * - Returns a frozen snapshot of this object. The frozen copy can be read and queried from any thread without throwing an `IllegalStateException `__ . Freezing a RealmObject also creates a frozen Realm which has its own lifecycle, but if the live Realm that spawned the original collection is fully closed (i.e. all instances across all threads are closed), the frozen Realm and object will be closed as well. - Frozen objects can be queried as normal, but trying to mutate it in any way or attempting to register a listener will throw an `IllegalStateException `__ . + Frozen objects can be queried as normal, but trying to mutate it in any way or attempting to register a listener will throw an `IllegalStateException `__ . @@ -1700,7 +1705,7 @@ freeze **Throws** - - `IllegalStateException `__ - if this method is called from inside a write transaction. + - `IllegalStateException `__ - if this method is called from inside a write transaction. @@ -1786,13 +1791,13 @@ getRealm **Throws** - - `IllegalArgumentException `__ - if the ``model`` is ``null`` . + - `IllegalArgumentException `__ - if the ``model`` is ``null`` . - - `IllegalStateException `__ - if the ``model`` is an instance of :ref:`DynamicRealmObject ` or this object was already deleted or the corresponding :ref:`Realm ` was already closed. + - `IllegalStateException `__ - if the ``model`` is an instance of :ref:`DynamicRealmObject ` or this object was already deleted or the corresponding :ref:`Realm ` was already closed. @@ -1838,7 +1843,7 @@ getRealm **Throws** - - `IllegalStateException `__ - if this object is an instance of :ref:`DynamicRealmObject ` or this object was already deleted or the corresponding :ref:`Realm ` was already closed. + - `IllegalStateException `__ - if this object is an instance of :ref:`DynamicRealmObject ` or this object was already deleted or the corresponding :ref:`Realm ` was already closed. @@ -2012,7 +2017,7 @@ isLoaded - * - Checks if the query used to find this RealmObject has completed.Async methods like :ref:`RealmQuery.findFirstAsync() ` return an :ref:`RealmObject ` that represents the future result of the :ref:`RealmQuery ` . It can be considered similar to a `java.util.concurrent.Future `__ in this regard. + * - Checks if the query used to find this RealmObject has completed.Async methods like :ref:`RealmQuery.findFirstAsync() ` return an :ref:`RealmObject ` that represents the future result of the :ref:`RealmQuery ` . It can be considered similar to a `java.util.concurrent.Future `__ in this regard. @@ -2101,7 +2106,7 @@ isLoaded - * - Checks if the query used to find this RealmObject has completed.Async methods like :ref:`RealmQuery.findFirstAsync() ` return an :ref:`RealmObject ` that represents the future result of the :ref:`RealmQuery ` . It can be considered similar to a `java.util.concurrent.Future `__ in this regard. + * - Checks if the query used to find this RealmObject has completed.Async methods like :ref:`RealmQuery.findFirstAsync() ` return a :ref:`RealmObject ` that represents the future result of the :ref:`RealmQuery ` . It can be considered similar to a `java.util.concurrent.Future `__ in this regard. @@ -2589,7 +2594,7 @@ removeAllChangeListeners **Throws** - - `IllegalArgumentException `__ - if object is ``null`` or isn't managed by Realm. + - `IllegalArgumentException `__ - if object is ``null`` or isn't managed by Realm. @@ -2728,17 +2733,17 @@ removeChangeListener **Throws** - - `IllegalArgumentException `__ - if the ``object`` or the change listener is ``null`` . + - `IllegalArgumentException `__ - if the ``object`` or the change listener is ``null`` . - - `IllegalArgumentException `__ - if object is an unmanaged RealmObject. + - `IllegalArgumentException `__ - if object is an unmanaged RealmObject. - - `IllegalStateException `__ - if you try to remove a listener from a non-Looper Thread. + - `IllegalStateException `__ - if you try to remove a listener from a non-Looper Thread. @@ -2831,17 +2836,17 @@ removeChangeListener **Throws** - - `IllegalArgumentException `__ - if the ``object`` or the change listener is ``null`` . + - `IllegalArgumentException `__ - if the ``object`` or the change listener is ``null`` . - - `IllegalArgumentException `__ - if object is an unmanaged RealmObject. + - `IllegalArgumentException `__ - if object is an unmanaged RealmObject. - - `IllegalStateException `__ - if you try to remove a listener from a non-Looper Thread. + - `IllegalStateException `__ - if you try to remove a listener from a non-Looper Thread. @@ -2893,13 +2898,13 @@ removeChangeListener **Throws** - - `IllegalArgumentException `__ - if the change listener is ``null`` or the object is an unmanaged object. + - `IllegalArgumentException `__ - if the change listener is ``null`` or the object is an unmanaged object. - - `IllegalStateException `__ - if you try to remove a listener from a non-Looper Thread. + - `IllegalStateException `__ - if you try to remove a listener from a non-Looper Thread. @@ -2951,13 +2956,13 @@ removeChangeListener **Throws** - - `IllegalArgumentException `__ - if the change listener is ``null`` or the object is an unmanaged object. + - `IllegalArgumentException `__ - if the change listener is ``null`` or the object is an unmanaged object. - - `IllegalStateException `__ - if you try to remove a listener from a non-Looper Thread. + - `IllegalStateException `__ - if you try to remove a listener from a non-Looper Thread. diff --git a/source/sdk/java/api/io/realm/RealmObjectSchema.txt b/source/sdk/java/api/io/realm/RealmObjectSchema.txt index d1a0ad0b29..717d39df93 100644 --- a/source/sdk/java/api/io/realm/RealmObjectSchema.txt +++ b/source/sdk/java/api/io/realm/RealmObjectSchema.txt @@ -18,7 +18,7 @@ io.realm ======== - | `java.lang.Object `__ + | `java.lang.Object `__ | io.realm.RealmObjectSchema @@ -70,8 +70,8 @@ Method Summary * - public abstract :ref:`RealmObjectSchema ` - | :ref:`addField ` ( - | `String `__ fieldName, - | `java.lang.Class\ `__ fieldType, + | `String `__ fieldName, + | `java.lang.Class\ `__ fieldType, | :ref:`io.realm.FieldAttribute[] ` attributes | ) @@ -83,7 +83,7 @@ Method Summary * - public abstract :ref:`RealmObjectSchema ` - | :ref:`addIndex ` ( - | `String `__ fieldName + | `String `__ fieldName | ) @@ -94,7 +94,7 @@ Method Summary * - public abstract :ref:`RealmObjectSchema ` - | :ref:`addPrimaryKey ` ( - | `String `__ fieldName + | `String `__ fieldName | ) @@ -103,10 +103,38 @@ Method Summary + * - public abstract :ref:`RealmObjectSchema ` + - | :ref:`addRealmDictionaryField ` ( + | `String `__ fieldName, + | `java.lang.Class\ `__ primitiveType + | ) + + + Adds a new field that references a :ref:`RealmDictionary ` with primitive values. + + + + + + + * - public abstract :ref:`RealmObjectSchema ` + - | :ref:`addRealmDictionaryField ` ( + | `String `__ fieldName, + | :ref:`RealmObjectSchema ` objectSchema + | ) + + + Adds a new field that contains a :ref:`RealmDictionary ` with references to other Realm model classes. + + + + + + * - public abstract :ref:`RealmObjectSchema ` - | :ref:`addRealmListField ` ( - | `String `__ fieldName, - | `java.lang.Class\ `__ primitiveType + | `String `__ fieldName, + | `java.lang.Class\ `__ primitiveType | ) @@ -119,7 +147,7 @@ Method Summary * - public abstract :ref:`RealmObjectSchema ` - | :ref:`addRealmListField ` ( - | `String `__ fieldName, + | `String `__ fieldName, | :ref:`RealmObjectSchema ` objectSchema | ) @@ -133,7 +161,7 @@ Method Summary * - public abstract :ref:`RealmObjectSchema ` - | :ref:`addRealmObjectField ` ( - | `String `__ fieldName, + | `String `__ fieldName, | :ref:`RealmObjectSchema ` objectSchema | ) @@ -145,7 +173,35 @@ Method Summary - * - public `String `__ + * - public abstract :ref:`RealmObjectSchema ` + - | :ref:`addRealmSetField ` ( + | `String `__ fieldName, + | `java.lang.Class\ `__ primitiveType + | ) + + + Adds a new field that references a :ref:`RealmSet ` with primitive values. + + + + + + + * - public abstract :ref:`RealmObjectSchema ` + - | :ref:`addRealmSetField ` ( + | `String `__ fieldName, + | :ref:`RealmObjectSchema ` objectSchema + | ) + + + Adds a new field that contains a :ref:`RealmSet ` with references to other Realm model classes. + + + + + + + * - public `String `__ - | :ref:`getClassName ` () | @@ -155,7 +211,7 @@ Method Summary - * - public `Set `__ + * - public `Set `__ - | :ref:`getFieldNames ` () | @@ -167,7 +223,7 @@ Method Summary * - public :ref:`RealmFieldType ` - | :ref:`getFieldType ` ( - | `String `__ fieldName + | `String `__ fieldName | ) @@ -176,7 +232,7 @@ Method Summary - * - public `String `__ + * - public `String `__ - | :ref:`getPrimaryKey ` () | @@ -186,19 +242,9 @@ Method Summary - * - protected final **SchemaConnector** - - | :ref:`getSchemaConnector ` () - | - - - - - - - * - public **boolean** - | :ref:`hasField ` ( - | `String `__ fieldName + | `String `__ fieldName | ) @@ -209,7 +255,7 @@ Method Summary * - public **boolean** - | :ref:`hasIndex ` ( - | `String `__ fieldName + | `String `__ fieldName | ) @@ -242,7 +288,7 @@ Method Summary * - public **boolean** - | :ref:`isNullable ` ( - | `String `__ fieldName + | `String `__ fieldName | ) @@ -255,7 +301,7 @@ Method Summary * - public **boolean** - | :ref:`isPrimaryKey ` ( - | `String `__ fieldName + | `String `__ fieldName | ) @@ -266,7 +312,7 @@ Method Summary * - public **boolean** - | :ref:`isRequired ` ( - | `String `__ fieldName + | `String `__ fieldName | ) @@ -279,7 +325,7 @@ Method Summary * - public abstract :ref:`RealmObjectSchema ` - | :ref:`removeField ` ( - | `String `__ fieldName + | `String `__ fieldName | ) @@ -290,7 +336,7 @@ Method Summary * - public abstract :ref:`RealmObjectSchema ` - | :ref:`removeIndex ` ( - | `String `__ fieldName + | `String `__ fieldName | ) @@ -311,8 +357,8 @@ Method Summary * - public abstract :ref:`RealmObjectSchema ` - | :ref:`renameField ` ( - | `String `__ currentFieldName, - | `String `__ newFieldName + | `String `__ currentFieldName, + | `String `__ newFieldName | ) @@ -323,7 +369,7 @@ Method Summary * - public abstract :ref:`RealmObjectSchema ` - | :ref:`setClassName ` ( - | `String `__ className + | `String `__ className | ) @@ -345,7 +391,7 @@ Method Summary * - public abstract :ref:`RealmObjectSchema ` - | :ref:`setNullable ` ( - | `String `__ fieldName, + | `String `__ fieldName, | **boolean** nullable | ) @@ -359,7 +405,7 @@ Method Summary * - public abstract :ref:`RealmObjectSchema ` - | :ref:`setRequired ` ( - | `String `__ fieldName, + | `String `__ fieldName, | **boolean** required | ) @@ -390,7 +436,7 @@ Inherited Methods -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` +- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` @@ -565,8 +611,8 @@ addField :header-rows: 1 * - | public abstract :ref:`RealmObjectSchema ` :ref:`addField ` ( - | `String `__ fieldName, - | `java.lang.Class\ `__ fieldType, + | `String `__ fieldName, + | `java.lang.Class\ `__ fieldType, | :ref:`io.realm.FieldAttribute[] ` attributes | ) @@ -613,11 +659,11 @@ addField **Throws** - - `IllegalArgumentException `__ - if the type isn't supported, field name is illegal or a field with that name already exists. + - `IllegalArgumentException `__ - if the type isn't supported, field name is illegal or a field with that name already exists. - - `UnsupportedOperationException `__ - if this :ref:`RealmObjectSchema ` is immutable or if adding a a field with :ref:`FieldAttribute.PRIMARY_KEY ` attribute to a schema of a synced Realm. + - `UnsupportedOperationException `__ - if this :ref:`RealmObjectSchema ` is immutable or if adding a a field with :ref:`FieldAttribute.PRIMARY_KEY ` attribute to a schema of a synced Realm. @@ -665,7 +711,7 @@ addIndex :header-rows: 1 * - | public abstract :ref:`RealmObjectSchema ` :ref:`addIndex ` ( - | `String `__ fieldName + | `String `__ fieldName | ) @@ -697,11 +743,11 @@ addIndex **Throws** - - `IllegalArgumentException `__ - if field name doesn't exist, the field cannot be indexed or it already has a index defined. + - `IllegalArgumentException `__ - if field name doesn't exist, the field cannot be indexed or it already has a index defined. - - `UnsupportedOperationException `__ - if this :ref:`RealmObjectSchema ` is immutable. + - `UnsupportedOperationException `__ - if this :ref:`RealmObjectSchema ` is immutable. @@ -749,7 +795,7 @@ addPrimaryKey :header-rows: 1 * - | public abstract :ref:`RealmObjectSchema ` :ref:`addPrimaryKey ` ( - | `String `__ fieldName + | `String `__ fieldName | ) @@ -781,11 +827,270 @@ addPrimaryKey **Throws** - - `IllegalArgumentException `__ - if field name doesn't exist, the field cannot be a primary key or it already has a primary key defined. + - `IllegalArgumentException `__ - if field name doesn't exist, the field cannot be a primary key or it already has a primary key defined. + + + + - `UnsupportedOperationException `__ - if this :ref:`RealmObjectSchema ` is immutable or of a synced Realm. + + + + + + + + + + + + + + +.. _addRealmDictionaryField: + +.. _addRealmDictionaryField__: + +.. _RealmObjectSchema_addRealmDictionaryField: + +.. _RealmObjectSchema_addRealmDictionaryField__: + +.. _io_realm_RealmObjectSchema_addRealmDictionaryField: + +.. _io_realm_RealmObjectSchema_addRealmDictionaryField__: + + + +addRealmDictionaryField +----------------------- + +.. _io_realm_RealmObjectSchema_addRealmDictionaryField_java_lang_String_java_lang_Class_: + +.. _io_realm_RealmObjectSchema_addRealmDictionaryField_java_lang_String__java_lang_Class_: + +.. _io_realm_RealmObjectSchema_addRealmDictionaryField_java_lang_String_Class_: + +.. _io_realm_RealmObjectSchema_addRealmDictionaryField_java_lang_String__Class_: + +.. _io_realm_RealmObjectSchema_addRealmDictionaryField_String_java_lang_Class_: + +.. _io_realm_RealmObjectSchema_addRealmDictionaryField_String__java_lang_Class_: + +.. _io_realm_RealmObjectSchema_addRealmDictionaryField_String_Class_: + +.. _io_realm_RealmObjectSchema_addRealmDictionaryField_String__Class_: + +.. _addRealmDictionaryField_java_lang_String_java_lang_Class_: + +.. _addRealmDictionaryField_java_lang_String__java_lang_Class_: + +.. _addRealmDictionaryField_java_lang_String_Class_: + +.. _addRealmDictionaryField_java_lang_String__Class_: + +.. _addRealmDictionaryField_String_java_lang_Class_: + +.. _addRealmDictionaryField_String__java_lang_Class_: + +.. _addRealmDictionaryField_String_Class_: + +.. _addRealmDictionaryField_String__Class_: + +.. _RealmObjectSchema_addRealmDictionaryField_java_lang_String_java_lang_Class_: + +.. _RealmObjectSchema_addRealmDictionaryField_java_lang_String__java_lang_Class_: + +.. _RealmObjectSchema_addRealmDictionaryField_java_lang_String_Class_: + +.. _RealmObjectSchema_addRealmDictionaryField_java_lang_String__Class_: + +.. _RealmObjectSchema_addRealmDictionaryField_String_java_lang_Class_: + +.. _RealmObjectSchema_addRealmDictionaryField_String__java_lang_Class_: + +.. _RealmObjectSchema_addRealmDictionaryField_String_Class_: + +.. _RealmObjectSchema_addRealmDictionaryField_String__Class_: + +.. _io_realm_RealmObjectSchema_addRealmDictionaryField_String__Class____: + +.. list-table:: + :header-rows: 1 + + * - | public abstract :ref:`RealmObjectSchema ` :ref:`addRealmDictionaryField ` ( + | `String `__ fieldName, + | `java.lang.Class\ `__ primitiveType + | ) + + + + + * - Adds a new field that references a :ref:`RealmDictionary ` with primitive values. See :ref:`RealmObject ` for the list of supported types. + + Nullability of elements are defined by using the correct class e.g., ``Integer.class`` instead of ``int.class`` . Alternatively :ref:`setRequired(String, boolean) ` can be used. + + + + Example: + + + + .. code-block:: java + + + // Defines the dictionary of Strings as being non null. + RealmObjectSchema schema = schema.create("Person") + .addRealmDictionaryField("parentAndChild", String.class) + .setRequired("parentAndChild", true) + + + + + + If the list contains references to other Realm classes, use :ref:`addRealmDictionaryField(String, RealmObjectSchema) ` instead. + + + + + + + **Parameters** + + - ``fieldName`` - name of the field to add. + + + + - ``primitiveType`` - simple type of elements in the array. + + + + + + + + **Returns** + + the updated schema. + + + + + **Throws** + + - `IllegalArgumentException `__ - if the field name is illegal, a field with that name already exists or the element type isn't supported. + + + + - `UnsupportedOperationException `__ - if this :ref:`RealmObjectSchema ` is immutable. + + + + + + + + + + + + +.. _io_realm_RealmObjectSchema_addRealmDictionaryField_java_lang_String_io_realm_RealmObjectSchema_: + +.. _io_realm_RealmObjectSchema_addRealmDictionaryField_java_lang_String__io_realm_RealmObjectSchema_: + +.. _io_realm_RealmObjectSchema_addRealmDictionaryField_java_lang_String_RealmObjectSchema_: + +.. _io_realm_RealmObjectSchema_addRealmDictionaryField_java_lang_String__RealmObjectSchema_: + +.. _io_realm_RealmObjectSchema_addRealmDictionaryField_String_io_realm_RealmObjectSchema_: + +.. _io_realm_RealmObjectSchema_addRealmDictionaryField_String__io_realm_RealmObjectSchema_: + +.. _io_realm_RealmObjectSchema_addRealmDictionaryField_String_RealmObjectSchema_: + +.. _io_realm_RealmObjectSchema_addRealmDictionaryField_String__RealmObjectSchema_: + +.. _addRealmDictionaryField_java_lang_String_io_realm_RealmObjectSchema_: + +.. _addRealmDictionaryField_java_lang_String__io_realm_RealmObjectSchema_: + +.. _addRealmDictionaryField_java_lang_String_RealmObjectSchema_: + +.. _addRealmDictionaryField_java_lang_String__RealmObjectSchema_: + +.. _addRealmDictionaryField_String_io_realm_RealmObjectSchema_: + +.. _addRealmDictionaryField_String__io_realm_RealmObjectSchema_: + +.. _addRealmDictionaryField_String_RealmObjectSchema_: + +.. _addRealmDictionaryField_String__RealmObjectSchema_: + +.. _RealmObjectSchema_addRealmDictionaryField_java_lang_String_io_realm_RealmObjectSchema_: + +.. _RealmObjectSchema_addRealmDictionaryField_java_lang_String__io_realm_RealmObjectSchema_: + +.. _RealmObjectSchema_addRealmDictionaryField_java_lang_String_RealmObjectSchema_: + +.. _RealmObjectSchema_addRealmDictionaryField_java_lang_String__RealmObjectSchema_: + +.. _RealmObjectSchema_addRealmDictionaryField_String_io_realm_RealmObjectSchema_: + +.. _RealmObjectSchema_addRealmDictionaryField_String__io_realm_RealmObjectSchema_: + +.. _RealmObjectSchema_addRealmDictionaryField_String_RealmObjectSchema_: + +.. _RealmObjectSchema_addRealmDictionaryField_String__RealmObjectSchema_: + +.. list-table:: + :header-rows: 1 + + * - | public abstract :ref:`RealmObjectSchema ` :ref:`addRealmDictionaryField ` ( + | `String `__ fieldName, + | :ref:`RealmObjectSchema ` objectSchema + | ) + + + + + * - Adds a new field that contains a :ref:`RealmDictionary ` with references to other Realm model classes. + + If the dictionary contains primitive types, use :ref:`addRealmDictionaryField(String, Class) ` instead. + + + + + + + + + **Parameters** + + - ``fieldName`` - name of the field to add. + + + + - ``objectSchema`` - schema for the Realm type being referenced. + + + + + + + + **Returns** + + the updated schema. + + + + + **Throws** + + - `IllegalArgumentException `__ - if the field name is illegal or a field with that name already exists. - - `UnsupportedOperationException `__ - if this :ref:`RealmObjectSchema ` is immutable or of a synced Realm. + - `UnsupportedOperationException `__ - if this :ref:`RealmObjectSchema ` is immutable. @@ -871,8 +1176,8 @@ addRealmListField :header-rows: 1 * - | public abstract :ref:`RealmObjectSchema ` :ref:`addRealmListField ` ( - | `String `__ fieldName, - | `java.lang.Class\ `__ primitiveType + | `String `__ fieldName, + | `java.lang.Class\ `__ primitiveType | ) @@ -930,11 +1235,11 @@ addRealmListField **Throws** - - `IllegalArgumentException `__ - if the field name is illegal, a field with that name already exists or the element type isn't supported. + - `IllegalArgumentException `__ - if the field name is illegal, a field with that name already exists or the element type isn't supported. - - `UnsupportedOperationException `__ - if this :ref:`RealmObjectSchema ` is immutable. + - `UnsupportedOperationException `__ - if this :ref:`RealmObjectSchema ` is immutable. @@ -999,7 +1304,7 @@ addRealmListField :header-rows: 1 * - | public abstract :ref:`RealmObjectSchema ` :ref:`addRealmListField ` ( - | `String `__ fieldName, + | `String `__ fieldName, | :ref:`RealmObjectSchema ` objectSchema | ) @@ -1040,11 +1345,11 @@ addRealmListField **Throws** - - `IllegalArgumentException `__ - if the field name is illegal or a field with that name already exists. + - `IllegalArgumentException `__ - if the field name is illegal or a field with that name already exists. - - `UnsupportedOperationException `__ - if this :ref:`RealmObjectSchema ` is immutable. + - `UnsupportedOperationException `__ - if this :ref:`RealmObjectSchema ` is immutable. @@ -1128,7 +1433,7 @@ addRealmObjectField :header-rows: 1 * - | public abstract :ref:`RealmObjectSchema ` :ref:`addRealmObjectField ` ( - | `String `__ fieldName, + | `String `__ fieldName, | :ref:`RealmObjectSchema ` objectSchema | ) @@ -1165,11 +1470,270 @@ addRealmObjectField **Throws** - - `IllegalArgumentException `__ - if field name is illegal or a field with that name already exists. + - `IllegalArgumentException `__ - if field name is illegal or a field with that name already exists. + + + + - `UnsupportedOperationException `__ - if this :ref:`RealmObjectSchema ` is immutable. + + + + + + + + + + + + + + +.. _addRealmSetField: + +.. _addRealmSetField__: + +.. _RealmObjectSchema_addRealmSetField: + +.. _RealmObjectSchema_addRealmSetField__: + +.. _io_realm_RealmObjectSchema_addRealmSetField: + +.. _io_realm_RealmObjectSchema_addRealmSetField__: + + + +addRealmSetField +---------------- + +.. _io_realm_RealmObjectSchema_addRealmSetField_java_lang_String_java_lang_Class_: + +.. _io_realm_RealmObjectSchema_addRealmSetField_java_lang_String__java_lang_Class_: + +.. _io_realm_RealmObjectSchema_addRealmSetField_java_lang_String_Class_: + +.. _io_realm_RealmObjectSchema_addRealmSetField_java_lang_String__Class_: + +.. _io_realm_RealmObjectSchema_addRealmSetField_String_java_lang_Class_: + +.. _io_realm_RealmObjectSchema_addRealmSetField_String__java_lang_Class_: + +.. _io_realm_RealmObjectSchema_addRealmSetField_String_Class_: + +.. _io_realm_RealmObjectSchema_addRealmSetField_String__Class_: + +.. _addRealmSetField_java_lang_String_java_lang_Class_: + +.. _addRealmSetField_java_lang_String__java_lang_Class_: + +.. _addRealmSetField_java_lang_String_Class_: + +.. _addRealmSetField_java_lang_String__Class_: + +.. _addRealmSetField_String_java_lang_Class_: + +.. _addRealmSetField_String__java_lang_Class_: + +.. _addRealmSetField_String_Class_: + +.. _addRealmSetField_String__Class_: + +.. _RealmObjectSchema_addRealmSetField_java_lang_String_java_lang_Class_: + +.. _RealmObjectSchema_addRealmSetField_java_lang_String__java_lang_Class_: + +.. _RealmObjectSchema_addRealmSetField_java_lang_String_Class_: + +.. _RealmObjectSchema_addRealmSetField_java_lang_String__Class_: + +.. _RealmObjectSchema_addRealmSetField_String_java_lang_Class_: + +.. _RealmObjectSchema_addRealmSetField_String__java_lang_Class_: + +.. _RealmObjectSchema_addRealmSetField_String_Class_: + +.. _RealmObjectSchema_addRealmSetField_String__Class_: + +.. _io_realm_RealmObjectSchema_addRealmSetField_String__Class____: + +.. list-table:: + :header-rows: 1 + + * - | public abstract :ref:`RealmObjectSchema ` :ref:`addRealmSetField ` ( + | `String `__ fieldName, + | `java.lang.Class\ `__ primitiveType + | ) + + + + + * - Adds a new field that references a :ref:`RealmSet ` with primitive values. See :ref:`RealmObject ` for the list of supported types. + + Nullability of elements are defined by using the correct class e.g., ``Integer.class`` instead of ``int.class`` . Alternatively :ref:`setRequired(String, boolean) ` can be used. + + + + Example: + + + + .. code-block:: java + + + // Defines the set of Strings as being non null. + RealmObjectSchema schema = schema.create("Person") + .addRealmSetField("children", String.class) + .setRequired("children", true) + + + + + + If the list contains references to other Realm classes, use :ref:`addRealmSetField(String, RealmObjectSchema) ` instead. + + + + + + + **Parameters** + + - ``fieldName`` - name of the field to add. + + + + - ``primitiveType`` - simple type of elements in the array. + + + + + + + + **Returns** + + the updated schema. + + + + + **Throws** + + - `IllegalArgumentException `__ - if the field name is illegal, a field with that name already exists or the element type isn't supported. + + + + - `UnsupportedOperationException `__ - if this :ref:`RealmObjectSchema ` is immutable. + + + + + + + + + + + + +.. _io_realm_RealmObjectSchema_addRealmSetField_java_lang_String_io_realm_RealmObjectSchema_: + +.. _io_realm_RealmObjectSchema_addRealmSetField_java_lang_String__io_realm_RealmObjectSchema_: + +.. _io_realm_RealmObjectSchema_addRealmSetField_java_lang_String_RealmObjectSchema_: + +.. _io_realm_RealmObjectSchema_addRealmSetField_java_lang_String__RealmObjectSchema_: + +.. _io_realm_RealmObjectSchema_addRealmSetField_String_io_realm_RealmObjectSchema_: + +.. _io_realm_RealmObjectSchema_addRealmSetField_String__io_realm_RealmObjectSchema_: + +.. _io_realm_RealmObjectSchema_addRealmSetField_String_RealmObjectSchema_: + +.. _io_realm_RealmObjectSchema_addRealmSetField_String__RealmObjectSchema_: + +.. _addRealmSetField_java_lang_String_io_realm_RealmObjectSchema_: + +.. _addRealmSetField_java_lang_String__io_realm_RealmObjectSchema_: + +.. _addRealmSetField_java_lang_String_RealmObjectSchema_: + +.. _addRealmSetField_java_lang_String__RealmObjectSchema_: + +.. _addRealmSetField_String_io_realm_RealmObjectSchema_: + +.. _addRealmSetField_String__io_realm_RealmObjectSchema_: + +.. _addRealmSetField_String_RealmObjectSchema_: + +.. _addRealmSetField_String__RealmObjectSchema_: + +.. _RealmObjectSchema_addRealmSetField_java_lang_String_io_realm_RealmObjectSchema_: + +.. _RealmObjectSchema_addRealmSetField_java_lang_String__io_realm_RealmObjectSchema_: + +.. _RealmObjectSchema_addRealmSetField_java_lang_String_RealmObjectSchema_: + +.. _RealmObjectSchema_addRealmSetField_java_lang_String__RealmObjectSchema_: + +.. _RealmObjectSchema_addRealmSetField_String_io_realm_RealmObjectSchema_: + +.. _RealmObjectSchema_addRealmSetField_String__io_realm_RealmObjectSchema_: + +.. _RealmObjectSchema_addRealmSetField_String_RealmObjectSchema_: + +.. _RealmObjectSchema_addRealmSetField_String__RealmObjectSchema_: + +.. list-table:: + :header-rows: 1 + + * - | public abstract :ref:`RealmObjectSchema ` :ref:`addRealmSetField ` ( + | `String `__ fieldName, + | :ref:`RealmObjectSchema ` objectSchema + | ) + + + + + * - Adds a new field that contains a :ref:`RealmSet ` with references to other Realm model classes. + + If the set contains primitive types, use :ref:`addRealmSetField(String, Class) ` instead. + + + + + + + + + **Parameters** + + - ``fieldName`` - name of the field to add. + + + + - ``objectSchema`` - schema for the Realm type being referenced. + + + + + + + + **Returns** + + the updated schema. + + + + + **Throws** + + - `IllegalArgumentException `__ - if the field name is illegal or a field with that name already exists. - - `UnsupportedOperationException `__ - if this :ref:`RealmObjectSchema ` is immutable. + - `UnsupportedOperationException `__ - if this :ref:`RealmObjectSchema ` is immutable. @@ -1204,7 +1768,7 @@ getClassName .. list-table:: :header-rows: 1 - * - | public `String `__ :ref:`getClassName ` () + * - | public `String `__ :ref:`getClassName ` () | @@ -1240,7 +1804,7 @@ getClassName **Throws** - - `IllegalStateException `__ - if this schema defintion is no longer part of the Realm. + - `IllegalStateException `__ - if this schema defintion is no longer part of the Realm. @@ -1273,7 +1837,7 @@ getFieldNames .. list-table:: :header-rows: 1 - * - | public `Set `__ :ref:`getFieldNames ` () + * - | public `Set `__ :ref:`getFieldNames ` () | @@ -1333,7 +1897,7 @@ getFieldType :header-rows: 1 * - | public :ref:`RealmFieldType ` :ref:`getFieldType ` ( - | `String `__ fieldName + | `String `__ fieldName | ) @@ -1388,7 +1952,7 @@ getPrimaryKey .. list-table:: :header-rows: 1 - * - | public `String `__ :ref:`getPrimaryKey ` () + * - | public `String `__ :ref:`getPrimaryKey ` () | @@ -1410,7 +1974,7 @@ getPrimaryKey **Throws** - - `IllegalStateException `__ - if the class doesn't have a primary key defined. + - `IllegalStateException `__ - if the class doesn't have a primary key defined. @@ -1423,48 +1987,6 @@ getPrimaryKey -.. _getSchemaConnector: - -.. _getSchemaConnector__: - -.. _RealmObjectSchema_getSchemaConnector: - -.. _RealmObjectSchema_getSchemaConnector__: - -.. _io_realm_RealmObjectSchema_getSchemaConnector: - -.. _io_realm_RealmObjectSchema_getSchemaConnector__: - - - -getSchemaConnector ------------------- - -.. list-table:: - :header-rows: 1 - - * - | protected final **SchemaConnector** :ref:`getSchemaConnector ` () - | - - - - - * - - - - - - - - - - - - - - - - .. _hasField: .. _hasField__: @@ -1498,7 +2020,7 @@ hasField :header-rows: 1 * - | public **boolean** :ref:`hasField ` ( - | `String `__ fieldName + | `String `__ fieldName | ) @@ -1568,7 +2090,7 @@ hasIndex :header-rows: 1 * - | public **boolean** :ref:`hasIndex ` ( - | `String `__ fieldName + | `String `__ fieldName | ) @@ -1600,7 +2122,7 @@ hasIndex **Throws** - - `IllegalArgumentException `__ - if field name doesn't exist. + - `IllegalArgumentException `__ - if field name doesn't exist. @@ -1774,7 +2296,7 @@ isNullable :header-rows: 1 * - | public **boolean** :ref:`isNullable ` ( - | `String `__ fieldName + | `String `__ fieldName | ) @@ -1808,7 +2330,7 @@ isNullable **Throws** - - `IllegalArgumentException `__ - if field name doesn't exist. + - `IllegalArgumentException `__ - if field name doesn't exist. @@ -1868,7 +2390,7 @@ isPrimaryKey :header-rows: 1 * - | public **boolean** :ref:`isPrimaryKey ` ( - | `String `__ fieldName + | `String `__ fieldName | ) @@ -1900,7 +2422,7 @@ isPrimaryKey **Throws** - - `IllegalArgumentException `__ - if field name doesn't exist. + - `IllegalArgumentException `__ - if field name doesn't exist. @@ -1960,7 +2482,7 @@ isRequired :header-rows: 1 * - | public **boolean** :ref:`isRequired ` ( - | `String `__ fieldName + | `String `__ fieldName | ) @@ -1994,7 +2516,7 @@ isRequired **Throws** - - `IllegalArgumentException `__ - if field name doesn't exist. + - `IllegalArgumentException `__ - if field name doesn't exist. @@ -2054,7 +2576,7 @@ removeField :header-rows: 1 * - | public abstract :ref:`RealmObjectSchema ` :ref:`removeField ` ( - | `String `__ fieldName + | `String `__ fieldName | ) @@ -2084,11 +2606,11 @@ removeField **Throws** - - `IllegalArgumentException `__ - if field name doesn't exist. + - `IllegalArgumentException `__ - if field name doesn't exist. - - `UnsupportedOperationException `__ - if this :ref:`RealmObjectSchema ` is immutable or for a synced Realm. + - `UnsupportedOperationException `__ - if this :ref:`RealmObjectSchema ` is immutable or for a synced Realm. @@ -2136,7 +2658,7 @@ removeIndex :header-rows: 1 * - | public abstract :ref:`RealmObjectSchema ` :ref:`removeIndex ` ( - | `String `__ fieldName + | `String `__ fieldName | ) @@ -2168,11 +2690,11 @@ removeIndex **Throws** - - `IllegalArgumentException `__ - if field name doesn't exist or the field doesn't have an index. + - `IllegalArgumentException `__ - if field name doesn't exist or the field doesn't have an index. - - `UnsupportedOperationException `__ - if this :ref:`RealmObjectSchema ` is immutable or of a synced Realm. + - `UnsupportedOperationException `__ - if this :ref:`RealmObjectSchema ` is immutable or of a synced Realm. @@ -2231,11 +2753,11 @@ removePrimaryKey **Throws** - - `IllegalArgumentException `__ - if the class doesn't have a primary key defined. + - `IllegalArgumentException `__ - if the class doesn't have a primary key defined. - - `UnsupportedOperationException `__ - if this :ref:`RealmObjectSchema ` is immutable or of a synced Realm. + - `UnsupportedOperationException `__ - if this :ref:`RealmObjectSchema ` is immutable or of a synced Realm. @@ -2319,8 +2841,8 @@ renameField :header-rows: 1 * - | public abstract :ref:`RealmObjectSchema ` :ref:`renameField ` ( - | `String `__ currentFieldName, - | `String `__ newFieldName + | `String `__ currentFieldName, + | `String `__ newFieldName | ) @@ -2354,11 +2876,11 @@ renameField **Throws** - - `IllegalArgumentException `__ - if field name doesn't exist or if the new field name already exists. + - `IllegalArgumentException `__ - if field name doesn't exist or if the new field name already exists. - - `UnsupportedOperationException `__ - if this :ref:`RealmObjectSchema ` is immutable or for a synced Realm. + - `UnsupportedOperationException `__ - if this :ref:`RealmObjectSchema ` is immutable or for a synced Realm. @@ -2406,7 +2928,7 @@ setClassName :header-rows: 1 * - | public abstract :ref:`RealmObjectSchema ` :ref:`setClassName ` ( - | `String `__ className + | `String `__ className | ) @@ -2431,13 +2953,13 @@ setClassName **Throws** - - `IllegalArgumentException `__ - if className is ``null`` or an empty string, or its length exceeds 56 characters. + - `IllegalArgumentException `__ - if className is ``null`` or an empty string, or its length exceeds 56 characters. - - `UnsupportedOperationException `__ - if this :ref:`RealmObjectSchema ` is immutable or from a synced Realm. + - `UnsupportedOperationException `__ - if this :ref:`RealmObjectSchema ` is immutable or from a synced Realm. @@ -2506,7 +3028,7 @@ setEmbedded - The class is not allowed to have a primary key defined. - - All existing objects of this type, must have one and exactly one parent object already pointing to it. If 0 or more than 1 object has a reference to an object about to be marked embedded an `IllegalStateException `__ will be thrown. + - All existing objects of this type, must have one and exactly one parent object already pointing to it. If 0 or more than 1 object has a reference to an object about to be marked embedded an `IllegalStateException `__ will be thrown. @@ -2524,7 +3046,7 @@ setEmbedded **Throws** - - `IllegalStateException `__ - if the class could not be converted because it broke some of the Embedded Objects invariants. + - `IllegalStateException `__ - if the class could not be converted because it broke some of the Embedded Objects invariants. @@ -2596,7 +3118,7 @@ setNullable :header-rows: 1 * - | public abstract :ref:`RealmObjectSchema ` :ref:`setNullable ` ( - | `String `__ fieldName, + | `String `__ fieldName, | **boolean** nullable | ) @@ -2639,11 +3161,11 @@ setNullable **Throws** - - `IllegalArgumentException `__ - if the field name doesn't exist, or cannot be set as nullable. + - `IllegalArgumentException `__ - if the field name doesn't exist, or cannot be set as nullable. - - `UnsupportedOperationException `__ - if this :ref:`RealmObjectSchema ` is immutable. + - `UnsupportedOperationException `__ - if this :ref:`RealmObjectSchema ` is immutable. @@ -2703,7 +3225,7 @@ setRequired :header-rows: 1 * - | public abstract :ref:`RealmObjectSchema ` :ref:`setRequired ` ( - | `String `__ fieldName, + | `String `__ fieldName, | **boolean** required | ) @@ -2746,13 +3268,13 @@ setRequired **Throws** - - `IllegalArgumentException `__ - if the field name doesn't exist, cannot have the :ref:`Required ` annotation or the field already have been set as required. + - `IllegalArgumentException `__ - if the field name doesn't exist, cannot have the :ref:`Required ` annotation or the field already have been set as required. - - `UnsupportedOperationException `__ - if this :ref:`RealmObjectSchema ` is immutable. + - `UnsupportedOperationException `__ - if this :ref:`RealmObjectSchema ` is immutable. @@ -2854,7 +3376,7 @@ transform **Throws** - - `UnsupportedOperationException `__ - if this :ref:`RealmObjectSchema ` is immutable. + - `UnsupportedOperationException `__ - if this :ref:`RealmObjectSchema ` is immutable. diff --git a/source/sdk/java/api/io/realm/RealmQuery.txt b/source/sdk/java/api/io/realm/RealmQuery.txt index d820d432d0..48d8b80218 100644 --- a/source/sdk/java/api/io/realm/RealmQuery.txt +++ b/source/sdk/java/api/io/realm/RealmQuery.txt @@ -18,7 +18,7 @@ io.realm ======== - | `java.lang.Object `__ + | `java.lang.Object `__ | io.realm.RealmQuery @@ -103,7 +103,7 @@ Method Summary * - public **double** - | :ref:`average ` ( - | `String `__ fieldName + | `String `__ fieldName | ) @@ -114,7 +114,18 @@ Method Summary * - public **Decimal128** - | :ref:`averageDecimal128 ` ( - | `String `__ fieldName + | `String `__ fieldName + | ) + + + Returns the average of a given field. + + + + + * - public **Decimal128** + - | :ref:`averageRealmAny ` ( + | `String `__ fieldName | ) @@ -135,8 +146,21 @@ Method Summary * - public :ref:`RealmQuery ` - | :ref:`beginsWith ` ( - | `String `__ fieldName, - | `String `__ value, + | `String `__ fieldName, + | :ref:`RealmAny ` value, + | :ref:`Case ` casing + | ) + + + Condition that the value of field begins with the specified substring. + + + + + * - public :ref:`RealmQuery ` + - | :ref:`beginsWith ` ( + | `String `__ fieldName, + | `String `__ value, | :ref:`Case ` casing | ) @@ -148,8 +172,20 @@ Method Summary * - public :ref:`RealmQuery ` - | :ref:`beginsWith ` ( - | `String `__ fieldName, - | `String `__ value + | `String `__ fieldName, + | :ref:`RealmAny ` value + | ) + + + Condition that the value of field begins with the specified string. + + + + + * - public :ref:`RealmQuery ` + - | :ref:`beginsWith ` ( + | `String `__ fieldName, + | `String `__ value | ) @@ -160,7 +196,7 @@ Method Summary * - public :ref:`RealmQuery ` - | :ref:`between ` ( - | `String `__ fieldName, + | `String `__ fieldName, | **Decimal128** from, | **Decimal128** to | ) @@ -173,9 +209,22 @@ Method Summary * - public :ref:`RealmQuery ` - | :ref:`between ` ( - | `String `__ fieldName, - | `Date `__ from, - | `Date `__ to + | `String `__ fieldName, + | :ref:`RealmAny ` from, + | :ref:`RealmAny ` to + | ) + + + Between condition. + + + + + * - public :ref:`RealmQuery ` + - | :ref:`between ` ( + | `String `__ fieldName, + | `Date `__ from, + | `Date `__ to | ) @@ -186,7 +235,7 @@ Method Summary * - public :ref:`RealmQuery ` - | :ref:`between ` ( - | `String `__ fieldName, + | `String `__ fieldName, | **float** from, | **float** to | ) @@ -199,7 +248,7 @@ Method Summary * - public :ref:`RealmQuery ` - | :ref:`between ` ( - | `String `__ fieldName, + | `String `__ fieldName, | **double** from, | **double** to | ) @@ -212,7 +261,7 @@ Method Summary * - public :ref:`RealmQuery ` - | :ref:`between ` ( - | `String `__ fieldName, + | `String `__ fieldName, | **long** from, | **long** to | ) @@ -225,7 +274,7 @@ Method Summary * - public :ref:`RealmQuery ` - | :ref:`between ` ( - | `String `__ fieldName, + | `String `__ fieldName, | **int** from, | **int** to | ) @@ -238,8 +287,8 @@ Method Summary * - public :ref:`RealmQuery ` - | :ref:`contains ` ( - | `String `__ fieldName, - | `String `__ value, + | `String `__ fieldName, + | :ref:`RealmAny ` value, | :ref:`Case ` casing | ) @@ -251,8 +300,9 @@ Method Summary * - public :ref:`RealmQuery ` - | :ref:`contains ` ( - | `String `__ fieldName, - | `String `__ value + | `String `__ fieldName, + | `String `__ value, + | :ref:`Case ` casing | ) @@ -261,31 +311,212 @@ Method Summary - * - public **long** - - | :ref:`count ` () - | + * - public :ref:`RealmQuery ` + - | :ref:`contains ` ( + | `String `__ fieldName, + | :ref:`RealmAny ` value + | ) - Counts the number of objects that fulfill the query conditions. + Condition that value of field contains the specified substring. * - public :ref:`RealmQuery ` - - | :ref:`distinct ` ( - | `String `__ firstFieldName, - | `java.lang.String[] `__ remainingFieldNames + - | :ref:`contains ` ( + | `String `__ fieldName, + | `String `__ value | ) - Selects a distinct set of objects of a specific class. + Condition that value of field contains the specified substring. + + + + + * - public :ref:`RealmQuery ` + - | :ref:`containsEntry ` ( + | `String `__ fieldName, + | `java.util.Map.Entry\ `__ entry + | ) + + + Condition that value, if a dictionary field, contains the specified entry. + + + + + * - public :ref:`RealmQuery ` + - | :ref:`containsKey ` ( + | `String `__ fieldName, + | `String `__ key + | ) + + + Condition that value, if a dictionary field, contains the specified key. + + + + + * - public :ref:`RealmQuery ` + - | :ref:`containsValue ` ( + | `String `__ fieldName, + | **ObjectId** value + | ) + + + Condition that value, if a dictionary field, contains the specified value. + + + + + * - public :ref:`RealmQuery ` + - | :ref:`containsValue ` ( + | `String `__ fieldName, + | **Decimal128** value + | ) + + + Condition that value, if a dictionary field, contains the specified value. + + + + + * - public :ref:`RealmQuery ` + - | :ref:`containsValue ` ( + | `String `__ fieldName, + | `Date `__ value + | ) + + + Condition that value, if a dictionary field, contains the specified value. + + + + + * - public :ref:`RealmQuery ` + - | :ref:`containsValue ` ( + | `String `__ fieldName, + | **byte[]** value + | ) + + + Condition that value, if a dictionary field, contains the specified value. + + + + + * - public :ref:`RealmQuery ` + - | :ref:`containsValue ` ( + | `String `__ fieldName, + | `String `__ value + | ) + + + Condition that value, if a dictionary field, contains the specified value. + + + + + * - public :ref:`RealmQuery ` + - | :ref:`containsValue ` ( + | `String `__ fieldName, + | `Float `__ value + | ) + + + Condition that value, if a dictionary field, contains the specified value. + + + + + * - public :ref:`RealmQuery ` + - | :ref:`containsValue ` ( + | `String `__ fieldName, + | `Double `__ value + | ) + + + Condition that value, if a dictionary field, contains the specified value. + + + + + * - public :ref:`RealmQuery ` + - | :ref:`containsValue ` ( + | `String `__ fieldName, + | `Long `__ value + | ) + + + Condition that value, if a dictionary field, contains the specified value. + + + + + * - public :ref:`RealmQuery ` + - | :ref:`containsValue ` ( + | `String `__ fieldName, + | `Integer `__ value + | ) + + + Condition that value, if a dictionary field, contains the specified value. + + + + + * - public :ref:`RealmQuery ` + - | :ref:`containsValue ` ( + | `String `__ fieldName, + | `Short `__ value + | ) + + + Condition that value, if a dictionary field, contains the specified value. + + + + + * - public :ref:`RealmQuery ` + - | :ref:`containsValue ` ( + | `String `__ fieldName, + | `Byte `__ value + | ) + + + Condition that value, if a dictionary field, contains the specified value. + + + + + * - public :ref:`RealmQuery ` + - | :ref:`containsValue ` ( + | `String `__ fieldName, + | `Boolean `__ value + | ) + + + Condition that value, if a dictionary field, contains the specified value. + + + + + * - public **long** + - | :ref:`count ` () + | + + + Counts the number of objects that fulfill the query conditions. * - public :ref:`RealmQuery ` - | :ref:`distinct ` ( - | `String `__ fieldName + | `String `__ firstFieldName, + | `java.lang.String[] `__ remainingFieldNames | ) @@ -308,8 +539,21 @@ Method Summary * - public :ref:`RealmQuery ` - | :ref:`endsWith ` ( - | `String `__ fieldName, - | `String `__ value, + | `String `__ fieldName, + | :ref:`RealmAny ` value, + | :ref:`Case ` casing + | ) + + + Condition that the value of field ends with the specified substring. + + + + + * - public :ref:`RealmQuery ` + - | :ref:`endsWith ` ( + | `String `__ fieldName, + | `String `__ value, | :ref:`Case ` casing | ) @@ -321,8 +565,20 @@ Method Summary * - public :ref:`RealmQuery ` - | :ref:`endsWith ` ( - | `String `__ fieldName, - | `String `__ value + | `String `__ fieldName, + | :ref:`RealmAny ` value + | ) + + + Condition that the value of field ends with the specified string. + + + + + * - public :ref:`RealmQuery ` + - | :ref:`endsWith ` ( + | `String `__ fieldName, + | `String `__ value | ) @@ -333,7 +589,7 @@ Method Summary * - public :ref:`RealmQuery ` - | :ref:`equalTo ` ( - | `String `__ fieldName, + | `String `__ fieldName, | **ObjectId** value | ) @@ -345,7 +601,7 @@ Method Summary * - public :ref:`RealmQuery ` - | :ref:`equalTo ` ( - | `String `__ fieldName, + | `String `__ fieldName, | **Decimal128** value | ) @@ -357,8 +613,21 @@ Method Summary * - public :ref:`RealmQuery ` - | :ref:`equalTo ` ( - | `String `__ fieldName, - | `String `__ value, + | `String `__ fieldName, + | :ref:`RealmAny ` value, + | :ref:`Case ` casing + | ) + + + Equal-to comparison. + + + + + * - public :ref:`RealmQuery ` + - | :ref:`equalTo ` ( + | `String `__ fieldName, + | `String `__ value, | :ref:`Case ` casing | ) @@ -370,8 +639,8 @@ Method Summary * - public :ref:`RealmQuery ` - | :ref:`equalTo ` ( - | `String `__ fieldName, - | `String `__ value + | `String `__ fieldName, + | `String `__ value | ) @@ -422,7 +691,7 @@ Method Summary - * - public `String `__ + * - public `String `__ - | :ref:`getDescription ` () | @@ -432,6 +701,16 @@ Method Summary + * - public **long** + - | :ref:`getQueryPointer ` () + | + + + Returns the pointer to the underlying C++ query. + + + + * - public :ref:`Realm ` - | :ref:`getRealm ` () | @@ -444,7 +723,7 @@ Method Summary - * - public `String `__ + * - public `String `__ - | :ref:`getTypeQueried ` () | @@ -456,7 +735,7 @@ Method Summary * - public :ref:`RealmQuery ` - | :ref:`greaterThan ` ( - | `String `__ fieldName, + | `String `__ fieldName, | **ObjectId** value | ) @@ -468,7 +747,7 @@ Method Summary * - public :ref:`RealmQuery ` - | :ref:`greaterThan ` ( - | `String `__ fieldName, + | `String `__ fieldName, | **Decimal128** value | ) @@ -480,8 +759,20 @@ Method Summary * - public :ref:`RealmQuery ` - | :ref:`greaterThan ` ( - | `String `__ fieldName, - | `Date `__ value + | `String `__ fieldName, + | :ref:`RealmAny ` value + | ) + + + Greater-than comparison. + + + + + * - public :ref:`RealmQuery ` + - | :ref:`greaterThan ` ( + | `String `__ fieldName, + | `Date `__ value | ) @@ -492,7 +783,7 @@ Method Summary * - public :ref:`RealmQuery ` - | :ref:`greaterThan ` ( - | `String `__ fieldName, + | `String `__ fieldName, | **float** value | ) @@ -504,7 +795,7 @@ Method Summary * - public :ref:`RealmQuery ` - | :ref:`greaterThan ` ( - | `String `__ fieldName, + | `String `__ fieldName, | **double** value | ) @@ -516,7 +807,7 @@ Method Summary * - public :ref:`RealmQuery ` - | :ref:`greaterThan ` ( - | `String `__ fieldName, + | `String `__ fieldName, | **long** value | ) @@ -528,7 +819,7 @@ Method Summary * - public :ref:`RealmQuery ` - | :ref:`greaterThan ` ( - | `String `__ fieldName, + | `String `__ fieldName, | **int** value | ) @@ -540,7 +831,7 @@ Method Summary * - public :ref:`RealmQuery ` - | :ref:`greaterThanOrEqualTo ` ( - | `String `__ fieldName, + | `String `__ fieldName, | **ObjectId** value | ) @@ -552,7 +843,7 @@ Method Summary * - public :ref:`RealmQuery ` - | :ref:`greaterThanOrEqualTo ` ( - | `String `__ fieldName, + | `String `__ fieldName, | **Decimal128** value | ) @@ -564,8 +855,8 @@ Method Summary * - public :ref:`RealmQuery ` - | :ref:`greaterThanOrEqualTo ` ( - | `String `__ fieldName, - | `Date `__ value + | `String `__ fieldName, + | `Date `__ value | ) @@ -576,7 +867,7 @@ Method Summary * - public :ref:`RealmQuery ` - | :ref:`greaterThanOrEqualTo ` ( - | `String `__ fieldName, + | `String `__ fieldName, | **float** value | ) @@ -588,7 +879,7 @@ Method Summary * - public :ref:`RealmQuery ` - | :ref:`greaterThanOrEqualTo ` ( - | `String `__ fieldName, + | `String `__ fieldName, | **double** value | ) @@ -600,7 +891,7 @@ Method Summary * - public :ref:`RealmQuery ` - | :ref:`greaterThanOrEqualTo ` ( - | `String `__ fieldName, + | `String `__ fieldName, | **long** value | ) @@ -612,7 +903,7 @@ Method Summary * - public :ref:`RealmQuery ` - | :ref:`greaterThanOrEqualTo ` ( - | `String `__ fieldName, + | `String `__ fieldName, | **int** value | ) @@ -624,8 +915,20 @@ Method Summary * - public :ref:`RealmQuery ` - | :ref:`in ` ( - | `String `__ fieldName, - | `java.util.Date[] `__ values + | `String `__ fieldName, + | :ref:`io.realm.RealmAny[] ` values + | ) + + + In comparison. + + + + + * - public :ref:`RealmQuery ` + - | :ref:`in ` ( + | `String `__ fieldName, + | `java.util.Date[] `__ values | ) @@ -636,8 +939,8 @@ Method Summary * - public :ref:`RealmQuery ` - | :ref:`in ` ( - | `String `__ fieldName, - | `java.lang.Boolean[] `__ values + | `String `__ fieldName, + | `java.lang.Boolean[] `__ values | ) @@ -648,8 +951,8 @@ Method Summary * - public :ref:`RealmQuery ` - | :ref:`in ` ( - | `String `__ fieldName, - | `java.lang.Float[] `__ values + | `String `__ fieldName, + | `java.lang.Float[] `__ values | ) @@ -660,8 +963,8 @@ Method Summary * - public :ref:`RealmQuery ` - | :ref:`in ` ( - | `String `__ fieldName, - | `java.lang.Double[] `__ values + | `String `__ fieldName, + | `java.lang.Double[] `__ values | ) @@ -672,8 +975,8 @@ Method Summary * - public :ref:`RealmQuery ` - | :ref:`in ` ( - | `String `__ fieldName, - | `java.lang.Long[] `__ values + | `String `__ fieldName, + | `java.lang.Long[] `__ values | ) @@ -684,8 +987,8 @@ Method Summary * - public :ref:`RealmQuery ` - | :ref:`in ` ( - | `String `__ fieldName, - | `java.lang.Integer[] `__ values + | `String `__ fieldName, + | `java.lang.Integer[] `__ values | ) @@ -696,8 +999,8 @@ Method Summary * - public :ref:`RealmQuery ` - | :ref:`in ` ( - | `String `__ fieldName, - | `java.lang.Short[] `__ values + | `String `__ fieldName, + | `java.lang.Short[] `__ values | ) @@ -708,8 +1011,8 @@ Method Summary * - public :ref:`RealmQuery ` - | :ref:`in ` ( - | `String `__ fieldName, - | `java.lang.Byte[] `__ values + | `String `__ fieldName, + | `java.lang.Byte[] `__ values | ) @@ -720,8 +1023,8 @@ Method Summary * - public :ref:`RealmQuery ` - | :ref:`in ` ( - | `String `__ fieldName, - | `java.lang.String[] `__ values, + | `String `__ fieldName, + | `java.lang.String[] `__ values, | :ref:`Case ` casing | ) @@ -733,8 +1036,8 @@ Method Summary * - public :ref:`RealmQuery ` - | :ref:`in ` ( - | `String `__ fieldName, - | `java.lang.String[] `__ values + | `String `__ fieldName, + | `java.lang.String[] `__ values | ) @@ -745,7 +1048,7 @@ Method Summary * - public :ref:`RealmQuery ` - | :ref:`isEmpty ` ( - | `String `__ fieldName + | `String `__ fieldName | ) @@ -756,7 +1059,7 @@ Method Summary * - public :ref:`RealmQuery ` - | :ref:`isNotEmpty ` ( - | `String `__ fieldName + | `String `__ fieldName | ) @@ -767,7 +1070,7 @@ Method Summary * - public :ref:`RealmQuery ` - | :ref:`isNotNull ` ( - | `String `__ fieldName + | `String `__ fieldName | ) @@ -780,7 +1083,7 @@ Method Summary * - public :ref:`RealmQuery ` - | :ref:`isNull ` ( - | `String `__ fieldName + | `String `__ fieldName | ) @@ -805,7 +1108,7 @@ Method Summary * - public :ref:`RealmQuery ` - | :ref:`lessThan ` ( - | `String `__ fieldName, + | `String `__ fieldName, | **ObjectId** value | ) @@ -817,7 +1120,7 @@ Method Summary * - public :ref:`RealmQuery ` - | :ref:`lessThan ` ( - | `String `__ fieldName, + | `String `__ fieldName, | **Decimal128** value | ) @@ -829,7 +1132,7 @@ Method Summary * - public :ref:`RealmQuery ` - | :ref:`lessThan ` ( - | `String `__ fieldName, + | `String `__ fieldName, | **long** value | ) @@ -841,7 +1144,7 @@ Method Summary * - public :ref:`RealmQuery ` - | :ref:`lessThan ` ( - | `String `__ fieldName, + | `String `__ fieldName, | **int** value | ) @@ -853,7 +1156,7 @@ Method Summary * - public :ref:`RealmQuery ` - | :ref:`lessThanOrEqualTo ` ( - | `String `__ fieldName, + | `String `__ fieldName, | **ObjectId** value | ) @@ -865,7 +1168,7 @@ Method Summary * - public :ref:`RealmQuery ` - | :ref:`lessThanOrEqualTo ` ( - | `String `__ fieldName, + | `String `__ fieldName, | **Decimal128** value | ) @@ -877,7 +1180,7 @@ Method Summary * - public :ref:`RealmQuery ` - | :ref:`lessThanOrEqualTo ` ( - | `String `__ fieldName, + | `String `__ fieldName, | **long** value | ) @@ -889,7 +1192,7 @@ Method Summary * - public :ref:`RealmQuery ` - | :ref:`lessThanOrEqualTo ` ( - | `String `__ fieldName, + | `String `__ fieldName, | **int** value | ) @@ -901,8 +1204,8 @@ Method Summary * - public :ref:`RealmQuery ` - | :ref:`like ` ( - | `String `__ fieldName, - | `String `__ value, + | `String `__ fieldName, + | :ref:`RealmAny ` value, | :ref:`Case ` casing | ) @@ -924,8 +1227,9 @@ Method Summary * - public :ref:`RealmQuery ` - | :ref:`like ` ( - | `String `__ fieldName, - | `String `__ value + | `String `__ fieldName, + | `String `__ value, + | :ref:`Case ` casing | ) @@ -945,31 +1249,88 @@ Method Summary * - public :ref:`RealmQuery ` - - | :ref:`limit ` ( - | **long** limit + - | :ref:`like ` ( + | `String `__ fieldName, + | :ref:`RealmAny ` value | ) - Limits the number of objects returned in case the query matched more objects. - + Condition that the value of field matches with the specified substring, with wildcards: + - '\*' matches [0, n] unicode chars + + + - '?' matches a single unicode char. + + - - * - public `Number `__ - - | :ref:`max ` ( - | `String `__ fieldName - | ) - Finds the maximum value of a field. - * - public `Date `__ - - | :ref:`maximumDate ` ( - | `String `__ fieldName - | ) + * - public :ref:`RealmQuery ` + - | :ref:`like ` ( + | `String `__ fieldName, + | `String `__ value + | ) + + + Condition that the value of field matches with the specified substring, with wildcards: + + - '\*' matches [0, n] unicode chars + + + - '?' matches a single unicode char. + + + + + + + + + + * - public :ref:`RealmQuery ` + - | :ref:`limit ` ( + | **long** limit + | ) + + + Limits the number of objects returned in case the query matched more objects. + + + + + * - public `Number `__ + - | :ref:`max ` ( + | `String `__ fieldName + | ) + + + Finds the maximum value of a field. + + + + + * - public :ref:`RealmAny ` + - | :ref:`maxRealmAny ` ( + | `String `__ fieldName + | ) + + + Finds the maximum value of a :ref:`RealmAny ` field. + + + + + + + * - public `Date `__ + - | :ref:`maximumDate ` ( + | `String `__ fieldName + | ) Finds the maximum value of a field. @@ -977,9 +1338,9 @@ Method Summary - * - public `Number `__ + * - public `Number `__ - | :ref:`min ` ( - | `String `__ fieldName + | `String `__ fieldName | ) @@ -988,9 +1349,22 @@ Method Summary - * - public `Date `__ + * - public :ref:`RealmAny ` + - | :ref:`minRealmAny ` ( + | `String `__ fieldName + | ) + + + Finds the minimum value of a :ref:`RealmAny ` field. + + + + + + + * - public `Date `__ - | :ref:`minimumDate ` ( - | `String `__ fieldName + | `String `__ fieldName | ) @@ -1011,7 +1385,7 @@ Method Summary * - public :ref:`RealmQuery ` - | :ref:`notEqualTo ` ( - | `String `__ fieldName, + | `String `__ fieldName, | **ObjectId** value | ) @@ -1023,7 +1397,7 @@ Method Summary * - public :ref:`RealmQuery ` - | :ref:`notEqualTo ` ( - | `String `__ fieldName, + | `String `__ fieldName, | **Decimal128** value | ) @@ -1035,8 +1409,21 @@ Method Summary * - public :ref:`RealmQuery ` - | :ref:`notEqualTo ` ( - | `String `__ fieldName, - | `String `__ value, + | `String `__ fieldName, + | :ref:`RealmAny ` value, + | :ref:`Case ` casing + | ) + + + Not-equal-to comparison. + + + + + * - public :ref:`RealmQuery ` + - | :ref:`notEqualTo ` ( + | `String `__ fieldName, + | `String `__ value, | :ref:`Case ` casing | ) @@ -1048,8 +1435,8 @@ Method Summary * - public :ref:`RealmQuery ` - | :ref:`notEqualTo ` ( - | `String `__ fieldName, - | `String `__ value + | `String `__ fieldName, + | `String `__ value | ) @@ -1068,9 +1455,21 @@ Method Summary + * - public :ref:`RealmQuery ` + - | :ref:`rawPredicate ` ( + | `String `__ predicate, + | `java.lang.Object[] `__ arguments + | ) + + + Create a text-based predicate using the Realm Query Language. + + + + * - public :ref:`RealmQuery ` - | :ref:`sort ` ( - | `java.lang.String[] `__ fieldNames, + | `java.lang.String[] `__ fieldNames, | :ref:`io.realm.Sort[] ` sortOrders | ) @@ -1082,9 +1481,9 @@ Method Summary * - public :ref:`RealmQuery ` - | :ref:`sort ` ( - | `String `__ fieldName1, + | `String `__ fieldName1, | :ref:`Sort ` sortOrder1, - | `String `__ fieldName2, + | `String `__ fieldName2, | :ref:`Sort ` sortOrder2 | ) @@ -1096,7 +1495,7 @@ Method Summary * - public :ref:`RealmQuery ` - | :ref:`sort ` ( - | `String `__ fieldName, + | `String `__ fieldName, | :ref:`Sort ` sortOrder | ) @@ -1108,7 +1507,7 @@ Method Summary * - public :ref:`RealmQuery ` - | :ref:`sort ` ( - | `String `__ fieldName + | `String `__ fieldName | ) @@ -1117,9 +1516,9 @@ Method Summary - * - public `Number `__ + * - public `Number `__ - | :ref:`sum ` ( - | `String `__ fieldName + | `String `__ fieldName | ) @@ -1136,7 +1535,7 @@ Inherited Methods -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` +- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` @@ -1308,7 +1707,7 @@ average :header-rows: 1 * - | public **double** :ref:`average ` ( - | `String `__ fieldName + | `String `__ fieldName | ) @@ -1340,7 +1739,7 @@ average **Throws** - - `java.lang.IllegalArgumentException `__ - if the field is not a number type. + - `java.lang.IllegalArgumentException `__ - if the field is not a number type. @@ -1392,7 +1791,7 @@ averageDecimal128 :header-rows: 1 * - | public **Decimal128** :ref:`averageDecimal128 ` ( - | `String `__ fieldName + | `String `__ fieldName | ) @@ -1426,7 +1825,93 @@ averageDecimal128 **Throws** - - `java.lang.IllegalArgumentException `__ - if the field is not a Decimal128 type. + - `java.lang.IllegalArgumentException `__ - if the field is not a Decimal128 type. + + + + - :ref:`RealmException ` - if called from the UI thread after opting out via :ref:`RealmConfiguration.Builder.allowQueriesOnUiThread(boolean) ` . + + + + + + + + + + + + + + +.. _averageRealmAny: + +.. _averageRealmAny__: + +.. _RealmQuery_averageRealmAny: + +.. _RealmQuery_averageRealmAny__: + +.. _io_realm_RealmQuery_averageRealmAny: + +.. _io_realm_RealmQuery_averageRealmAny__: + + + +averageRealmAny +--------------- + +.. _io_realm_RealmQuery_averageRealmAny_java_lang_String_: + +.. _io_realm_RealmQuery_averageRealmAny_String_: + +.. _averageRealmAny_java_lang_String_: + +.. _averageRealmAny_String_: + +.. _RealmQuery_averageRealmAny_java_lang_String_: + +.. _RealmQuery_averageRealmAny_String_: + +.. list-table:: + :header-rows: 1 + + * - | public **Decimal128** :ref:`averageRealmAny ` ( + | `String `__ fieldName + | ) + + + + + * - Returns the average of a given field. Does not support dotted field notation. + + + + + **Parameters** + + - ``fieldName`` - the field to calculate average on. Only RealmAny fields are supported. For other types consider using :ref:`average(String) ` . + + + + + + + + + + **Returns** + + the average for the given field amongst objects in query results. This will be of type Decimal128. 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 RealmAny type. @@ -1525,6 +2010,159 @@ beginGroup beginsWith ---------- +.. _io_realm_RealmQuery_beginsWith_java_lang_String_io_realm_RealmAny_io_realm_Case_: + +.. _io_realm_RealmQuery_beginsWith_java_lang_String__io_realm_RealmAny__io_realm_Case_: + +.. _io_realm_RealmQuery_beginsWith_java_lang_String_io_realm_RealmAny_Case_: + +.. _io_realm_RealmQuery_beginsWith_java_lang_String__io_realm_RealmAny__Case_: + +.. _io_realm_RealmQuery_beginsWith_java_lang_String_RealmAny_io_realm_Case_: + +.. _io_realm_RealmQuery_beginsWith_java_lang_String__RealmAny__io_realm_Case_: + +.. _io_realm_RealmQuery_beginsWith_java_lang_String_RealmAny_Case_: + +.. _io_realm_RealmQuery_beginsWith_java_lang_String__RealmAny__Case_: + +.. _io_realm_RealmQuery_beginsWith_String_io_realm_RealmAny_io_realm_Case_: + +.. _io_realm_RealmQuery_beginsWith_String__io_realm_RealmAny__io_realm_Case_: + +.. _io_realm_RealmQuery_beginsWith_String_io_realm_RealmAny_Case_: + +.. _io_realm_RealmQuery_beginsWith_String__io_realm_RealmAny__Case_: + +.. _io_realm_RealmQuery_beginsWith_String_RealmAny_io_realm_Case_: + +.. _io_realm_RealmQuery_beginsWith_String__RealmAny__io_realm_Case_: + +.. _io_realm_RealmQuery_beginsWith_String_RealmAny_Case_: + +.. _io_realm_RealmQuery_beginsWith_String__RealmAny__Case_: + +.. _beginsWith_java_lang_String_io_realm_RealmAny_io_realm_Case_: + +.. _beginsWith_java_lang_String__io_realm_RealmAny__io_realm_Case_: + +.. _beginsWith_java_lang_String_io_realm_RealmAny_Case_: + +.. _beginsWith_java_lang_String__io_realm_RealmAny__Case_: + +.. _beginsWith_java_lang_String_RealmAny_io_realm_Case_: + +.. _beginsWith_java_lang_String__RealmAny__io_realm_Case_: + +.. _beginsWith_java_lang_String_RealmAny_Case_: + +.. _beginsWith_java_lang_String__RealmAny__Case_: + +.. _beginsWith_String_io_realm_RealmAny_io_realm_Case_: + +.. _beginsWith_String__io_realm_RealmAny__io_realm_Case_: + +.. _beginsWith_String_io_realm_RealmAny_Case_: + +.. _beginsWith_String__io_realm_RealmAny__Case_: + +.. _beginsWith_String_RealmAny_io_realm_Case_: + +.. _beginsWith_String__RealmAny__io_realm_Case_: + +.. _beginsWith_String_RealmAny_Case_: + +.. _beginsWith_String__RealmAny__Case_: + +.. _RealmQuery_beginsWith_java_lang_String_io_realm_RealmAny_io_realm_Case_: + +.. _RealmQuery_beginsWith_java_lang_String__io_realm_RealmAny__io_realm_Case_: + +.. _RealmQuery_beginsWith_java_lang_String_io_realm_RealmAny_Case_: + +.. _RealmQuery_beginsWith_java_lang_String__io_realm_RealmAny__Case_: + +.. _RealmQuery_beginsWith_java_lang_String_RealmAny_io_realm_Case_: + +.. _RealmQuery_beginsWith_java_lang_String__RealmAny__io_realm_Case_: + +.. _RealmQuery_beginsWith_java_lang_String_RealmAny_Case_: + +.. _RealmQuery_beginsWith_java_lang_String__RealmAny__Case_: + +.. _RealmQuery_beginsWith_String_io_realm_RealmAny_io_realm_Case_: + +.. _RealmQuery_beginsWith_String__io_realm_RealmAny__io_realm_Case_: + +.. _RealmQuery_beginsWith_String_io_realm_RealmAny_Case_: + +.. _RealmQuery_beginsWith_String__io_realm_RealmAny__Case_: + +.. _RealmQuery_beginsWith_String_RealmAny_io_realm_Case_: + +.. _RealmQuery_beginsWith_String__RealmAny__io_realm_Case_: + +.. _RealmQuery_beginsWith_String_RealmAny_Case_: + +.. _RealmQuery_beginsWith_String__RealmAny__Case_: + +.. list-table:: + :header-rows: 1 + + * - | public :ref:`RealmQuery ` :ref:`beginsWith ` ( + | `String `__ fieldName, + | :ref:`RealmAny ` value, + | :ref:`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 :ref:`Case.INSENSITIVE ` only works for Latin-1 characters. + + + + + + + + + + **Returns** + + the query object + + + + + **Throws** + + - `java.lang.IllegalArgumentException `__ - if one or more arguments do not match class or field type. + + + + + + + + + + .. _io_realm_RealmQuery_beginsWith_java_lang_String_java_lang_String_io_realm_Case_: .. _io_realm_RealmQuery_beginsWith_java_lang_String__java_lang_String__io_realm_Case_: @@ -1625,8 +2263,8 @@ beginsWith :header-rows: 1 * - | public :ref:`RealmQuery ` :ref:`beginsWith ` ( - | `String `__ fieldName, - | `String `__ value, + | `String `__ fieldName, + | `String `__ value, | :ref:`Case ` casing | ) @@ -1667,7 +2305,7 @@ beginsWith **Throws** - - `java.lang.IllegalArgumentException `__ - if one or more arguments do not match class or field type. + - `java.lang.IllegalArgumentException `__ - if one or more arguments do not match class or field type. @@ -1678,19 +2316,117 @@ beginsWith -.. _io_realm_RealmQuery_beginsWith_java_lang_String_java_lang_String_: +.. _io_realm_RealmQuery_beginsWith_java_lang_String_io_realm_RealmAny_: -.. _io_realm_RealmQuery_beginsWith_java_lang_String__java_lang_String_: +.. _io_realm_RealmQuery_beginsWith_java_lang_String__io_realm_RealmAny_: -.. _io_realm_RealmQuery_beginsWith_java_lang_String_String_: +.. _io_realm_RealmQuery_beginsWith_java_lang_String_RealmAny_: -.. _io_realm_RealmQuery_beginsWith_java_lang_String__String_: +.. _io_realm_RealmQuery_beginsWith_java_lang_String__RealmAny_: -.. _io_realm_RealmQuery_beginsWith_String_java_lang_String_: +.. _io_realm_RealmQuery_beginsWith_String_io_realm_RealmAny_: -.. _io_realm_RealmQuery_beginsWith_String__java_lang_String_: +.. _io_realm_RealmQuery_beginsWith_String__io_realm_RealmAny_: -.. _io_realm_RealmQuery_beginsWith_String_String_: +.. _io_realm_RealmQuery_beginsWith_String_RealmAny_: + +.. _io_realm_RealmQuery_beginsWith_String__RealmAny_: + +.. _beginsWith_java_lang_String_io_realm_RealmAny_: + +.. _beginsWith_java_lang_String__io_realm_RealmAny_: + +.. _beginsWith_java_lang_String_RealmAny_: + +.. _beginsWith_java_lang_String__RealmAny_: + +.. _beginsWith_String_io_realm_RealmAny_: + +.. _beginsWith_String__io_realm_RealmAny_: + +.. _beginsWith_String_RealmAny_: + +.. _beginsWith_String__RealmAny_: + +.. _RealmQuery_beginsWith_java_lang_String_io_realm_RealmAny_: + +.. _RealmQuery_beginsWith_java_lang_String__io_realm_RealmAny_: + +.. _RealmQuery_beginsWith_java_lang_String_RealmAny_: + +.. _RealmQuery_beginsWith_java_lang_String__RealmAny_: + +.. _RealmQuery_beginsWith_String_io_realm_RealmAny_: + +.. _RealmQuery_beginsWith_String__io_realm_RealmAny_: + +.. _RealmQuery_beginsWith_String_RealmAny_: + +.. _RealmQuery_beginsWith_String__RealmAny_: + +.. list-table:: + :header-rows: 1 + + * - | public :ref:`RealmQuery ` :ref:`beginsWith ` ( + | `String `__ fieldName, + | :ref:`RealmAny ` 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. + + + + + + + + + + +.. _io_realm_RealmQuery_beginsWith_java_lang_String_java_lang_String_: + +.. _io_realm_RealmQuery_beginsWith_java_lang_String__java_lang_String_: + +.. _io_realm_RealmQuery_beginsWith_java_lang_String_String_: + +.. _io_realm_RealmQuery_beginsWith_java_lang_String__String_: + +.. _io_realm_RealmQuery_beginsWith_String_java_lang_String_: + +.. _io_realm_RealmQuery_beginsWith_String__java_lang_String_: + +.. _io_realm_RealmQuery_beginsWith_String_String_: .. _io_realm_RealmQuery_beginsWith_String__String_: @@ -1730,8 +2466,8 @@ beginsWith :header-rows: 1 * - | public :ref:`RealmQuery ` :ref:`beginsWith ` ( - | `String `__ fieldName, - | `String `__ value + | `String `__ fieldName, + | `String `__ value | ) @@ -1765,7 +2501,7 @@ beginsWith **Throws** - - `java.lang.IllegalArgumentException `__ - if one or more arguments do not match class or field type. + - `java.lang.IllegalArgumentException `__ - if one or more arguments do not match class or field type. @@ -1823,7 +2559,7 @@ between :header-rows: 1 * - | public :ref:`RealmQuery ` :ref:`between ` ( - | `String `__ fieldName, + | `String `__ fieldName, | **Decimal128** from, | **Decimal128** to | ) @@ -1863,7 +2599,158 @@ between **Throws** - - `java.lang.IllegalArgumentException `__ - if one or more arguments do not match class or field type. + - `java.lang.IllegalArgumentException `__ - if one or more arguments do not match class or field type. + + + + + + + + + + +.. _io_realm_RealmQuery_between_java_lang_String_io_realm_RealmAny_io_realm_RealmAny_: + +.. _io_realm_RealmQuery_between_java_lang_String__io_realm_RealmAny__io_realm_RealmAny_: + +.. _io_realm_RealmQuery_between_java_lang_String_io_realm_RealmAny_RealmAny_: + +.. _io_realm_RealmQuery_between_java_lang_String__io_realm_RealmAny__RealmAny_: + +.. _io_realm_RealmQuery_between_java_lang_String_RealmAny_io_realm_RealmAny_: + +.. _io_realm_RealmQuery_between_java_lang_String__RealmAny__io_realm_RealmAny_: + +.. _io_realm_RealmQuery_between_java_lang_String_RealmAny_RealmAny_: + +.. _io_realm_RealmQuery_between_java_lang_String__RealmAny__RealmAny_: + +.. _io_realm_RealmQuery_between_String_io_realm_RealmAny_io_realm_RealmAny_: + +.. _io_realm_RealmQuery_between_String__io_realm_RealmAny__io_realm_RealmAny_: + +.. _io_realm_RealmQuery_between_String_io_realm_RealmAny_RealmAny_: + +.. _io_realm_RealmQuery_between_String__io_realm_RealmAny__RealmAny_: + +.. _io_realm_RealmQuery_between_String_RealmAny_io_realm_RealmAny_: + +.. _io_realm_RealmQuery_between_String__RealmAny__io_realm_RealmAny_: + +.. _io_realm_RealmQuery_between_String_RealmAny_RealmAny_: + +.. _io_realm_RealmQuery_between_String__RealmAny__RealmAny_: + +.. _between_java_lang_String_io_realm_RealmAny_io_realm_RealmAny_: + +.. _between_java_lang_String__io_realm_RealmAny__io_realm_RealmAny_: + +.. _between_java_lang_String_io_realm_RealmAny_RealmAny_: + +.. _between_java_lang_String__io_realm_RealmAny__RealmAny_: + +.. _between_java_lang_String_RealmAny_io_realm_RealmAny_: + +.. _between_java_lang_String__RealmAny__io_realm_RealmAny_: + +.. _between_java_lang_String_RealmAny_RealmAny_: + +.. _between_java_lang_String__RealmAny__RealmAny_: + +.. _between_String_io_realm_RealmAny_io_realm_RealmAny_: + +.. _between_String__io_realm_RealmAny__io_realm_RealmAny_: + +.. _between_String_io_realm_RealmAny_RealmAny_: + +.. _between_String__io_realm_RealmAny__RealmAny_: + +.. _between_String_RealmAny_io_realm_RealmAny_: + +.. _between_String__RealmAny__io_realm_RealmAny_: + +.. _between_String_RealmAny_RealmAny_: + +.. _between_String__RealmAny__RealmAny_: + +.. _RealmQuery_between_java_lang_String_io_realm_RealmAny_io_realm_RealmAny_: + +.. _RealmQuery_between_java_lang_String__io_realm_RealmAny__io_realm_RealmAny_: + +.. _RealmQuery_between_java_lang_String_io_realm_RealmAny_RealmAny_: + +.. _RealmQuery_between_java_lang_String__io_realm_RealmAny__RealmAny_: + +.. _RealmQuery_between_java_lang_String_RealmAny_io_realm_RealmAny_: + +.. _RealmQuery_between_java_lang_String__RealmAny__io_realm_RealmAny_: + +.. _RealmQuery_between_java_lang_String_RealmAny_RealmAny_: + +.. _RealmQuery_between_java_lang_String__RealmAny__RealmAny_: + +.. _RealmQuery_between_String_io_realm_RealmAny_io_realm_RealmAny_: + +.. _RealmQuery_between_String__io_realm_RealmAny__io_realm_RealmAny_: + +.. _RealmQuery_between_String_io_realm_RealmAny_RealmAny_: + +.. _RealmQuery_between_String__io_realm_RealmAny__RealmAny_: + +.. _RealmQuery_between_String_RealmAny_io_realm_RealmAny_: + +.. _RealmQuery_between_String__RealmAny__io_realm_RealmAny_: + +.. _RealmQuery_between_String_RealmAny_RealmAny_: + +.. _RealmQuery_between_String__RealmAny__RealmAny_: + +.. list-table:: + :header-rows: 1 + + * - | public :ref:`RealmQuery ` :ref:`between ` ( + | `String `__ fieldName, + | :ref:`RealmAny ` from, + | :ref:`RealmAny ` 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. @@ -1974,9 +2861,9 @@ between :header-rows: 1 * - | public :ref:`RealmQuery ` :ref:`between ` ( - | `String `__ fieldName, - | `Date `__ from, - | `Date `__ to + | `String `__ fieldName, + | `Date `__ from, + | `Date `__ to | ) @@ -2014,7 +2901,7 @@ between **Throws** - - `java.lang.IllegalArgumentException `__ - if one or more arguments do not match class or field type. + - `java.lang.IllegalArgumentException `__ - if one or more arguments do not match class or field type. @@ -2053,7 +2940,7 @@ between :header-rows: 1 * - | public :ref:`RealmQuery ` :ref:`between ` ( - | `String `__ fieldName, + | `String `__ fieldName, | **float** from, | **float** to | ) @@ -2093,7 +2980,7 @@ between **Throws** - - `java.lang.IllegalArgumentException `__ - if one or more arguments do not match class or field type. + - `java.lang.IllegalArgumentException `__ - if one or more arguments do not match class or field type. @@ -2132,7 +3019,7 @@ between :header-rows: 1 * - | public :ref:`RealmQuery ` :ref:`between ` ( - | `String `__ fieldName, + | `String `__ fieldName, | **double** from, | **double** to | ) @@ -2172,7 +3059,7 @@ between **Throws** - - `java.lang.IllegalArgumentException `__ - if one or more arguments do not match class or field type. + - `java.lang.IllegalArgumentException `__ - if one or more arguments do not match class or field type. @@ -2211,7 +3098,7 @@ between :header-rows: 1 * - | public :ref:`RealmQuery ` :ref:`between ` ( - | `String `__ fieldName, + | `String `__ fieldName, | **long** from, | **long** to | ) @@ -2251,7 +3138,7 @@ between **Throws** - - `java.lang.IllegalArgumentException `__ - if one or more arguments do not match class or field type. + - `java.lang.IllegalArgumentException `__ - if one or more arguments do not match class or field type. @@ -2290,7 +3177,7 @@ between :header-rows: 1 * - | public :ref:`RealmQuery ` :ref:`between ` ( - | `String `__ fieldName, + | `String `__ fieldName, | **int** from, | **int** to | ) @@ -2330,7 +3217,7 @@ between **Throws** - - `java.lang.IllegalArgumentException `__ - if one or more arguments do not match class or field type. + - `java.lang.IllegalArgumentException `__ - if one or more arguments do not match class or field type. @@ -2360,108 +3247,108 @@ between contains -------- -.. _io_realm_RealmQuery_contains_java_lang_String_java_lang_String_io_realm_Case_: +.. _io_realm_RealmQuery_contains_java_lang_String_io_realm_RealmAny_io_realm_Case_: -.. _io_realm_RealmQuery_contains_java_lang_String__java_lang_String__io_realm_Case_: +.. _io_realm_RealmQuery_contains_java_lang_String__io_realm_RealmAny__io_realm_Case_: -.. _io_realm_RealmQuery_contains_java_lang_String_java_lang_String_Case_: +.. _io_realm_RealmQuery_contains_java_lang_String_io_realm_RealmAny_Case_: -.. _io_realm_RealmQuery_contains_java_lang_String__java_lang_String__Case_: +.. _io_realm_RealmQuery_contains_java_lang_String__io_realm_RealmAny__Case_: -.. _io_realm_RealmQuery_contains_java_lang_String_String_io_realm_Case_: +.. _io_realm_RealmQuery_contains_java_lang_String_RealmAny_io_realm_Case_: -.. _io_realm_RealmQuery_contains_java_lang_String__String__io_realm_Case_: +.. _io_realm_RealmQuery_contains_java_lang_String__RealmAny__io_realm_Case_: -.. _io_realm_RealmQuery_contains_java_lang_String_String_Case_: +.. _io_realm_RealmQuery_contains_java_lang_String_RealmAny_Case_: -.. _io_realm_RealmQuery_contains_java_lang_String__String__Case_: +.. _io_realm_RealmQuery_contains_java_lang_String__RealmAny__Case_: -.. _io_realm_RealmQuery_contains_String_java_lang_String_io_realm_Case_: +.. _io_realm_RealmQuery_contains_String_io_realm_RealmAny_io_realm_Case_: -.. _io_realm_RealmQuery_contains_String__java_lang_String__io_realm_Case_: +.. _io_realm_RealmQuery_contains_String__io_realm_RealmAny__io_realm_Case_: -.. _io_realm_RealmQuery_contains_String_java_lang_String_Case_: +.. _io_realm_RealmQuery_contains_String_io_realm_RealmAny_Case_: -.. _io_realm_RealmQuery_contains_String__java_lang_String__Case_: +.. _io_realm_RealmQuery_contains_String__io_realm_RealmAny__Case_: -.. _io_realm_RealmQuery_contains_String_String_io_realm_Case_: +.. _io_realm_RealmQuery_contains_String_RealmAny_io_realm_Case_: -.. _io_realm_RealmQuery_contains_String__String__io_realm_Case_: +.. _io_realm_RealmQuery_contains_String__RealmAny__io_realm_Case_: -.. _io_realm_RealmQuery_contains_String_String_Case_: +.. _io_realm_RealmQuery_contains_String_RealmAny_Case_: -.. _io_realm_RealmQuery_contains_String__String__Case_: +.. _io_realm_RealmQuery_contains_String__RealmAny__Case_: -.. _contains_java_lang_String_java_lang_String_io_realm_Case_: +.. _contains_java_lang_String_io_realm_RealmAny_io_realm_Case_: -.. _contains_java_lang_String__java_lang_String__io_realm_Case_: +.. _contains_java_lang_String__io_realm_RealmAny__io_realm_Case_: -.. _contains_java_lang_String_java_lang_String_Case_: +.. _contains_java_lang_String_io_realm_RealmAny_Case_: -.. _contains_java_lang_String__java_lang_String__Case_: +.. _contains_java_lang_String__io_realm_RealmAny__Case_: -.. _contains_java_lang_String_String_io_realm_Case_: +.. _contains_java_lang_String_RealmAny_io_realm_Case_: -.. _contains_java_lang_String__String__io_realm_Case_: +.. _contains_java_lang_String__RealmAny__io_realm_Case_: -.. _contains_java_lang_String_String_Case_: +.. _contains_java_lang_String_RealmAny_Case_: -.. _contains_java_lang_String__String__Case_: +.. _contains_java_lang_String__RealmAny__Case_: -.. _contains_String_java_lang_String_io_realm_Case_: +.. _contains_String_io_realm_RealmAny_io_realm_Case_: -.. _contains_String__java_lang_String__io_realm_Case_: +.. _contains_String__io_realm_RealmAny__io_realm_Case_: -.. _contains_String_java_lang_String_Case_: +.. _contains_String_io_realm_RealmAny_Case_: -.. _contains_String__java_lang_String__Case_: +.. _contains_String__io_realm_RealmAny__Case_: -.. _contains_String_String_io_realm_Case_: +.. _contains_String_RealmAny_io_realm_Case_: -.. _contains_String__String__io_realm_Case_: +.. _contains_String__RealmAny__io_realm_Case_: -.. _contains_String_String_Case_: +.. _contains_String_RealmAny_Case_: -.. _contains_String__String__Case_: +.. _contains_String__RealmAny__Case_: -.. _RealmQuery_contains_java_lang_String_java_lang_String_io_realm_Case_: +.. _RealmQuery_contains_java_lang_String_io_realm_RealmAny_io_realm_Case_: -.. _RealmQuery_contains_java_lang_String__java_lang_String__io_realm_Case_: +.. _RealmQuery_contains_java_lang_String__io_realm_RealmAny__io_realm_Case_: -.. _RealmQuery_contains_java_lang_String_java_lang_String_Case_: +.. _RealmQuery_contains_java_lang_String_io_realm_RealmAny_Case_: -.. _RealmQuery_contains_java_lang_String__java_lang_String__Case_: +.. _RealmQuery_contains_java_lang_String__io_realm_RealmAny__Case_: -.. _RealmQuery_contains_java_lang_String_String_io_realm_Case_: +.. _RealmQuery_contains_java_lang_String_RealmAny_io_realm_Case_: -.. _RealmQuery_contains_java_lang_String__String__io_realm_Case_: +.. _RealmQuery_contains_java_lang_String__RealmAny__io_realm_Case_: -.. _RealmQuery_contains_java_lang_String_String_Case_: +.. _RealmQuery_contains_java_lang_String_RealmAny_Case_: -.. _RealmQuery_contains_java_lang_String__String__Case_: +.. _RealmQuery_contains_java_lang_String__RealmAny__Case_: -.. _RealmQuery_contains_String_java_lang_String_io_realm_Case_: +.. _RealmQuery_contains_String_io_realm_RealmAny_io_realm_Case_: -.. _RealmQuery_contains_String__java_lang_String__io_realm_Case_: +.. _RealmQuery_contains_String__io_realm_RealmAny__io_realm_Case_: -.. _RealmQuery_contains_String_java_lang_String_Case_: +.. _RealmQuery_contains_String_io_realm_RealmAny_Case_: -.. _RealmQuery_contains_String__java_lang_String__Case_: +.. _RealmQuery_contains_String__io_realm_RealmAny__Case_: -.. _RealmQuery_contains_String_String_io_realm_Case_: +.. _RealmQuery_contains_String_RealmAny_io_realm_Case_: -.. _RealmQuery_contains_String__String__io_realm_Case_: +.. _RealmQuery_contains_String__RealmAny__io_realm_Case_: -.. _RealmQuery_contains_String_String_Case_: +.. _RealmQuery_contains_String_RealmAny_Case_: -.. _RealmQuery_contains_String__String__Case_: +.. _RealmQuery_contains_String__RealmAny__Case_: .. list-table:: :header-rows: 1 * - | public :ref:`RealmQuery ` :ref:`contains ` ( - | `String `__ fieldName, - | `String `__ value, + | `String `__ fieldName, + | :ref:`RealmAny ` value, | :ref:`Case ` casing | ) @@ -2502,7 +3389,7 @@ contains **Throws** - - `java.lang.IllegalArgumentException `__ - if one or more arguments do not match class or field type. + - `java.lang.IllegalArgumentException `__ - if one or more arguments do not match class or field type. @@ -2513,66 +3400,1726 @@ contains -.. _io_realm_RealmQuery_contains_java_lang_String_java_lang_String_: +.. _io_realm_RealmQuery_contains_java_lang_String_java_lang_String_io_realm_Case_: -.. _io_realm_RealmQuery_contains_java_lang_String__java_lang_String_: +.. _io_realm_RealmQuery_contains_java_lang_String__java_lang_String__io_realm_Case_: -.. _io_realm_RealmQuery_contains_java_lang_String_String_: +.. _io_realm_RealmQuery_contains_java_lang_String_java_lang_String_Case_: -.. _io_realm_RealmQuery_contains_java_lang_String__String_: +.. _io_realm_RealmQuery_contains_java_lang_String__java_lang_String__Case_: -.. _io_realm_RealmQuery_contains_String_java_lang_String_: +.. _io_realm_RealmQuery_contains_java_lang_String_String_io_realm_Case_: -.. _io_realm_RealmQuery_contains_String__java_lang_String_: +.. _io_realm_RealmQuery_contains_java_lang_String__String__io_realm_Case_: -.. _io_realm_RealmQuery_contains_String_String_: +.. _io_realm_RealmQuery_contains_java_lang_String_String_Case_: -.. _io_realm_RealmQuery_contains_String__String_: +.. _io_realm_RealmQuery_contains_java_lang_String__String__Case_: -.. _contains_java_lang_String_java_lang_String_: +.. _io_realm_RealmQuery_contains_String_java_lang_String_io_realm_Case_: -.. _contains_java_lang_String__java_lang_String_: +.. _io_realm_RealmQuery_contains_String__java_lang_String__io_realm_Case_: -.. _contains_java_lang_String_String_: +.. _io_realm_RealmQuery_contains_String_java_lang_String_Case_: -.. _contains_java_lang_String__String_: +.. _io_realm_RealmQuery_contains_String__java_lang_String__Case_: -.. _contains_String_java_lang_String_: +.. _io_realm_RealmQuery_contains_String_String_io_realm_Case_: -.. _contains_String__java_lang_String_: +.. _io_realm_RealmQuery_contains_String__String__io_realm_Case_: -.. _contains_String_String_: +.. _io_realm_RealmQuery_contains_String_String_Case_: -.. _contains_String__String_: +.. _io_realm_RealmQuery_contains_String__String__Case_: + +.. _contains_java_lang_String_java_lang_String_io_realm_Case_: + +.. _contains_java_lang_String__java_lang_String__io_realm_Case_: + +.. _contains_java_lang_String_java_lang_String_Case_: + +.. _contains_java_lang_String__java_lang_String__Case_: + +.. _contains_java_lang_String_String_io_realm_Case_: + +.. _contains_java_lang_String__String__io_realm_Case_: + +.. _contains_java_lang_String_String_Case_: + +.. _contains_java_lang_String__String__Case_: + +.. _contains_String_java_lang_String_io_realm_Case_: + +.. _contains_String__java_lang_String__io_realm_Case_: + +.. _contains_String_java_lang_String_Case_: + +.. _contains_String__java_lang_String__Case_: + +.. _contains_String_String_io_realm_Case_: + +.. _contains_String__String__io_realm_Case_: + +.. _contains_String_String_Case_: + +.. _contains_String__String__Case_: + +.. _RealmQuery_contains_java_lang_String_java_lang_String_io_realm_Case_: + +.. _RealmQuery_contains_java_lang_String__java_lang_String__io_realm_Case_: + +.. _RealmQuery_contains_java_lang_String_java_lang_String_Case_: + +.. _RealmQuery_contains_java_lang_String__java_lang_String__Case_: + +.. _RealmQuery_contains_java_lang_String_String_io_realm_Case_: + +.. _RealmQuery_contains_java_lang_String__String__io_realm_Case_: + +.. _RealmQuery_contains_java_lang_String_String_Case_: + +.. _RealmQuery_contains_java_lang_String__String__Case_: + +.. _RealmQuery_contains_String_java_lang_String_io_realm_Case_: + +.. _RealmQuery_contains_String__java_lang_String__io_realm_Case_: + +.. _RealmQuery_contains_String_java_lang_String_Case_: + +.. _RealmQuery_contains_String__java_lang_String__Case_: + +.. _RealmQuery_contains_String_String_io_realm_Case_: + +.. _RealmQuery_contains_String__String__io_realm_Case_: + +.. _RealmQuery_contains_String_String_Case_: + +.. _RealmQuery_contains_String__String__Case_: + +.. list-table:: + :header-rows: 1 + + * - | public :ref:`RealmQuery ` :ref:`contains ` ( + | `String `__ fieldName, + | `String `__ value, + | :ref:`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 :ref:`Case.INSENSITIVE ` only works for Latin-1 characters. + + + + + + + + + + **Returns** + + The query object. + + + + + **Throws** + + - `java.lang.IllegalArgumentException `__ - if one or more arguments do not match class or field type. + + + + + + + + + + +.. _io_realm_RealmQuery_contains_java_lang_String_io_realm_RealmAny_: + +.. _io_realm_RealmQuery_contains_java_lang_String__io_realm_RealmAny_: + +.. _io_realm_RealmQuery_contains_java_lang_String_RealmAny_: + +.. _io_realm_RealmQuery_contains_java_lang_String__RealmAny_: + +.. _io_realm_RealmQuery_contains_String_io_realm_RealmAny_: + +.. _io_realm_RealmQuery_contains_String__io_realm_RealmAny_: + +.. _io_realm_RealmQuery_contains_String_RealmAny_: + +.. _io_realm_RealmQuery_contains_String__RealmAny_: + +.. _contains_java_lang_String_io_realm_RealmAny_: + +.. _contains_java_lang_String__io_realm_RealmAny_: + +.. _contains_java_lang_String_RealmAny_: + +.. _contains_java_lang_String__RealmAny_: + +.. _contains_String_io_realm_RealmAny_: + +.. _contains_String__io_realm_RealmAny_: + +.. _contains_String_RealmAny_: + +.. _contains_String__RealmAny_: + +.. _RealmQuery_contains_java_lang_String_io_realm_RealmAny_: + +.. _RealmQuery_contains_java_lang_String__io_realm_RealmAny_: + +.. _RealmQuery_contains_java_lang_String_RealmAny_: + +.. _RealmQuery_contains_java_lang_String__RealmAny_: + +.. _RealmQuery_contains_String_io_realm_RealmAny_: + +.. _RealmQuery_contains_String__io_realm_RealmAny_: + +.. _RealmQuery_contains_String_RealmAny_: + +.. _RealmQuery_contains_String__RealmAny_: + +.. list-table:: + :header-rows: 1 + + * - | public :ref:`RealmQuery ` :ref:`contains ` ( + | `String `__ fieldName, + | :ref:`RealmAny ` 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. + + + + + + + + + + +.. _io_realm_RealmQuery_contains_java_lang_String_java_lang_String_: + +.. _io_realm_RealmQuery_contains_java_lang_String__java_lang_String_: + +.. _io_realm_RealmQuery_contains_java_lang_String_String_: + +.. _io_realm_RealmQuery_contains_java_lang_String__String_: + +.. _io_realm_RealmQuery_contains_String_java_lang_String_: + +.. _io_realm_RealmQuery_contains_String__java_lang_String_: + +.. _io_realm_RealmQuery_contains_String_String_: + +.. _io_realm_RealmQuery_contains_String__String_: + +.. _contains_java_lang_String_java_lang_String_: + +.. _contains_java_lang_String__java_lang_String_: + +.. _contains_java_lang_String_String_: + +.. _contains_java_lang_String__String_: + +.. _contains_String_java_lang_String_: + +.. _contains_String__java_lang_String_: + +.. _contains_String_String_: + +.. _contains_String__String_: + +.. _RealmQuery_contains_java_lang_String_java_lang_String_: + +.. _RealmQuery_contains_java_lang_String__java_lang_String_: + +.. _RealmQuery_contains_java_lang_String_String_: + +.. _RealmQuery_contains_java_lang_String__String_: + +.. _RealmQuery_contains_String_java_lang_String_: + +.. _RealmQuery_contains_String__java_lang_String_: + +.. _RealmQuery_contains_String_String_: + +.. _RealmQuery_contains_String__String_: + +.. list-table:: + :header-rows: 1 + + * - | public :ref:`RealmQuery ` :ref:`contains ` ( + | `String `__ fieldName, + | `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. + + + + + + + + + + + + +.. _containsEntry: + +.. _containsEntry__: + +.. _RealmQuery_containsEntry: + +.. _RealmQuery_containsEntry__: + +.. _io_realm_RealmQuery_containsEntry: + +.. _io_realm_RealmQuery_containsEntry__: + + + +containsEntry +------------- + +.. _io_realm_RealmQuery_containsEntry_java_lang_String_java_util_Map_Entry_: + +.. _io_realm_RealmQuery_containsEntry_java_lang_String__java_util_Map_Entry_: + +.. _io_realm_RealmQuery_containsEntry_java_lang_String_Entry_: + +.. _io_realm_RealmQuery_containsEntry_java_lang_String__Entry_: + +.. _io_realm_RealmQuery_containsEntry_java_lang_String_Map_Entry_: + +.. _io_realm_RealmQuery_containsEntry_java_lang_String__Map_Entry_: + +.. _io_realm_RealmQuery_containsEntry_String_java_util_Map_Entry_: + +.. _io_realm_RealmQuery_containsEntry_String__java_util_Map_Entry_: + +.. _io_realm_RealmQuery_containsEntry_String_Entry_: + +.. _io_realm_RealmQuery_containsEntry_String__Entry_: + +.. _io_realm_RealmQuery_containsEntry_String_Map_Entry_: + +.. _io_realm_RealmQuery_containsEntry_String__Map_Entry_: + +.. _containsEntry_java_lang_String_java_util_Map_Entry_: + +.. _containsEntry_java_lang_String__java_util_Map_Entry_: + +.. _containsEntry_java_lang_String_Entry_: + +.. _containsEntry_java_lang_String__Entry_: + +.. _containsEntry_java_lang_String_Map_Entry_: + +.. _containsEntry_java_lang_String__Map_Entry_: + +.. _containsEntry_String_java_util_Map_Entry_: + +.. _containsEntry_String__java_util_Map_Entry_: + +.. _containsEntry_String_Entry_: + +.. _containsEntry_String__Entry_: + +.. _containsEntry_String_Map_Entry_: + +.. _containsEntry_String__Map_Entry_: + +.. _RealmQuery_containsEntry_java_lang_String_java_util_Map_Entry_: + +.. _RealmQuery_containsEntry_java_lang_String__java_util_Map_Entry_: + +.. _RealmQuery_containsEntry_java_lang_String_Entry_: + +.. _RealmQuery_containsEntry_java_lang_String__Entry_: + +.. _RealmQuery_containsEntry_java_lang_String_Map_Entry_: + +.. _RealmQuery_containsEntry_java_lang_String__Map_Entry_: + +.. _RealmQuery_containsEntry_String_java_util_Map_Entry_: + +.. _RealmQuery_containsEntry_String__java_util_Map_Entry_: + +.. _RealmQuery_containsEntry_String_Entry_: + +.. _RealmQuery_containsEntry_String__Entry_: + +.. _RealmQuery_containsEntry_String_Map_Entry_: + +.. _RealmQuery_containsEntry_String__Map_Entry_: + +.. _io_realm_RealmQuery_containsEntry_String__Map_Entry_String_____: + +.. list-table:: + :header-rows: 1 + + * - | public :ref:`RealmQuery ` :ref:`containsEntry ` ( + | `String `__ fieldName, + | `java.util.Map.Entry\ `__ entry + | ) + + + + + * - Condition that value, if a dictionary field, contains the specified entry. + + + + + **Parameters** + + - ``fieldName`` - the field to compare. + + + + - ``entry`` - the entry to search for. + + + + + + + + **Returns** + + the query object. + + + + + **Throws** + + - `java.lang.IllegalArgumentException `__ - if the field name isn't valid. + + + + + + + + + + + + +.. _containsKey: + +.. _containsKey__: + +.. _RealmQuery_containsKey: + +.. _RealmQuery_containsKey__: + +.. _io_realm_RealmQuery_containsKey: + +.. _io_realm_RealmQuery_containsKey__: + + + +containsKey +----------- + +.. _io_realm_RealmQuery_containsKey_java_lang_String_java_lang_String_: + +.. _io_realm_RealmQuery_containsKey_java_lang_String__java_lang_String_: + +.. _io_realm_RealmQuery_containsKey_java_lang_String_String_: + +.. _io_realm_RealmQuery_containsKey_java_lang_String__String_: + +.. _io_realm_RealmQuery_containsKey_String_java_lang_String_: + +.. _io_realm_RealmQuery_containsKey_String__java_lang_String_: + +.. _io_realm_RealmQuery_containsKey_String_String_: + +.. _io_realm_RealmQuery_containsKey_String__String_: + +.. _containsKey_java_lang_String_java_lang_String_: + +.. _containsKey_java_lang_String__java_lang_String_: + +.. _containsKey_java_lang_String_String_: + +.. _containsKey_java_lang_String__String_: + +.. _containsKey_String_java_lang_String_: + +.. _containsKey_String__java_lang_String_: + +.. _containsKey_String_String_: + +.. _containsKey_String__String_: + +.. _RealmQuery_containsKey_java_lang_String_java_lang_String_: + +.. _RealmQuery_containsKey_java_lang_String__java_lang_String_: + +.. _RealmQuery_containsKey_java_lang_String_String_: + +.. _RealmQuery_containsKey_java_lang_String__String_: + +.. _RealmQuery_containsKey_String_java_lang_String_: + +.. _RealmQuery_containsKey_String__java_lang_String_: + +.. _RealmQuery_containsKey_String_String_: + +.. _RealmQuery_containsKey_String__String_: + +.. list-table:: + :header-rows: 1 + + * - | public :ref:`RealmQuery ` :ref:`containsKey ` ( + | `String `__ fieldName, + | `String `__ key + | ) + + + + + * - Condition that value, if a dictionary field, contains the specified key. + + + + + **Parameters** + + - ``fieldName`` - the field to compare. + + + + - ``key`` - the key to search for. + + + + + + + + **Returns** + + the query object. + + + + + **Throws** + + - `java.lang.IllegalArgumentException `__ - if the field name isn't valid. + + + + + + + + + + + + +.. _containsValue: + +.. _containsValue__: + +.. _RealmQuery_containsValue: + +.. _RealmQuery_containsValue__: + +.. _io_realm_RealmQuery_containsValue: + +.. _io_realm_RealmQuery_containsValue__: + + + +containsValue +------------- + +.. _io_realm_RealmQuery_containsValue_java_lang_String_ObjectId_: + +.. _io_realm_RealmQuery_containsValue_java_lang_String__ObjectId_: + +.. _io_realm_RealmQuery_containsValue_String_ObjectId_: + +.. _io_realm_RealmQuery_containsValue_String__ObjectId_: + +.. _containsValue_java_lang_String_ObjectId_: + +.. _containsValue_java_lang_String__ObjectId_: + +.. _containsValue_String_ObjectId_: + +.. _containsValue_String__ObjectId_: + +.. _RealmQuery_containsValue_java_lang_String_ObjectId_: + +.. _RealmQuery_containsValue_java_lang_String__ObjectId_: + +.. _RealmQuery_containsValue_String_ObjectId_: + +.. _RealmQuery_containsValue_String__ObjectId_: + +.. list-table:: + :header-rows: 1 + + * - | public :ref:`RealmQuery ` :ref:`containsValue ` ( + | `String `__ fieldName, + | **ObjectId** value + | ) + + + + + * - Condition that value, if a dictionary field, contains the specified value. + + + + + **Parameters** + + - ``fieldName`` - the field to compare. + + + + - ``value`` - the value to search for. + + + + + + + + **Returns** + + the query object. + + + + + **Throws** + + - `java.lang.IllegalArgumentException `__ - if the field name isn't valid. + + + + + + + + + + +.. _io_realm_RealmQuery_containsValue_java_lang_String_Decimal128_: + +.. _io_realm_RealmQuery_containsValue_java_lang_String__Decimal128_: + +.. _io_realm_RealmQuery_containsValue_String_Decimal128_: + +.. _io_realm_RealmQuery_containsValue_String__Decimal128_: + +.. _containsValue_java_lang_String_Decimal128_: + +.. _containsValue_java_lang_String__Decimal128_: + +.. _containsValue_String_Decimal128_: + +.. _containsValue_String__Decimal128_: + +.. _RealmQuery_containsValue_java_lang_String_Decimal128_: + +.. _RealmQuery_containsValue_java_lang_String__Decimal128_: + +.. _RealmQuery_containsValue_String_Decimal128_: + +.. _RealmQuery_containsValue_String__Decimal128_: + +.. list-table:: + :header-rows: 1 + + * - | public :ref:`RealmQuery ` :ref:`containsValue ` ( + | `String `__ fieldName, + | **Decimal128** value + | ) + + + + + * - Condition that value, if a dictionary field, contains the specified value. + + + + + **Parameters** + + - ``fieldName`` - the field to compare. + + + + - ``value`` - the value to search for. + + + + + + + + **Returns** + + the query object. + + + + + **Throws** + + - `java.lang.IllegalArgumentException `__ - if the field name isn't valid. + + + + + + + + + + +.. _io_realm_RealmQuery_containsValue_java_lang_String_java_util_Date_: + +.. _io_realm_RealmQuery_containsValue_java_lang_String__java_util_Date_: + +.. _io_realm_RealmQuery_containsValue_java_lang_String_Date_: + +.. _io_realm_RealmQuery_containsValue_java_lang_String__Date_: + +.. _io_realm_RealmQuery_containsValue_String_java_util_Date_: + +.. _io_realm_RealmQuery_containsValue_String__java_util_Date_: + +.. _io_realm_RealmQuery_containsValue_String_Date_: + +.. _io_realm_RealmQuery_containsValue_String__Date_: + +.. _containsValue_java_lang_String_java_util_Date_: + +.. _containsValue_java_lang_String__java_util_Date_: + +.. _containsValue_java_lang_String_Date_: + +.. _containsValue_java_lang_String__Date_: + +.. _containsValue_String_java_util_Date_: + +.. _containsValue_String__java_util_Date_: + +.. _containsValue_String_Date_: + +.. _containsValue_String__Date_: + +.. _RealmQuery_containsValue_java_lang_String_java_util_Date_: + +.. _RealmQuery_containsValue_java_lang_String__java_util_Date_: + +.. _RealmQuery_containsValue_java_lang_String_Date_: + +.. _RealmQuery_containsValue_java_lang_String__Date_: + +.. _RealmQuery_containsValue_String_java_util_Date_: + +.. _RealmQuery_containsValue_String__java_util_Date_: + +.. _RealmQuery_containsValue_String_Date_: + +.. _RealmQuery_containsValue_String__Date_: + +.. list-table:: + :header-rows: 1 + + * - | public :ref:`RealmQuery ` :ref:`containsValue ` ( + | `String `__ fieldName, + | `Date `__ value + | ) + + + + + * - Condition that value, if a dictionary field, contains the specified value. + + + + + **Parameters** + + - ``fieldName`` - the field to compare. + + + + - ``value`` - the value to search for. + + + + + + + + **Returns** + + the query object. + + + + + **Throws** + + - `java.lang.IllegalArgumentException `__ - if the field name isn't valid. + + + + + + + + + + +.. _io_realm_RealmQuery_containsValue_java_lang_String_byte_: + +.. _io_realm_RealmQuery_containsValue_java_lang_String__byte_: + +.. _io_realm_RealmQuery_containsValue_java_lang_String_byte____: + +.. _io_realm_RealmQuery_containsValue_java_lang_String__byte____: + +.. _io_realm_RealmQuery_containsValue_String_byte_: + +.. _io_realm_RealmQuery_containsValue_String__byte_: + +.. _io_realm_RealmQuery_containsValue_String_byte____: + +.. _io_realm_RealmQuery_containsValue_String__byte____: + +.. _containsValue_java_lang_String_byte_: + +.. _containsValue_java_lang_String__byte_: + +.. _containsValue_java_lang_String_byte____: + +.. _containsValue_java_lang_String__byte____: + +.. _containsValue_String_byte_: + +.. _containsValue_String__byte_: + +.. _containsValue_String_byte____: + +.. _containsValue_String__byte____: + +.. _RealmQuery_containsValue_java_lang_String_byte_: + +.. _RealmQuery_containsValue_java_lang_String__byte_: + +.. _RealmQuery_containsValue_java_lang_String_byte____: + +.. _RealmQuery_containsValue_java_lang_String__byte____: + +.. _RealmQuery_containsValue_String_byte_: + +.. _RealmQuery_containsValue_String__byte_: + +.. _RealmQuery_containsValue_String_byte____: + +.. _RealmQuery_containsValue_String__byte____: + +.. _io_realm_RealmQuery_containsValue_String__byte[]_: + +.. list-table:: + :header-rows: 1 + + * - | public :ref:`RealmQuery ` :ref:`containsValue ` ( + | `String `__ fieldName, + | **byte[]** value + | ) + + + + + * - Condition that value, if a dictionary field, contains the specified value. + + + + + **Parameters** + + - ``fieldName`` - the field to compare. + + + + - ``value`` - the value to search for. + + + + + + + + **Returns** + + the query object. + + + + + **Throws** + + - `java.lang.IllegalArgumentException `__ - if the field name isn't valid. + + + + + + + + + + +.. _io_realm_RealmQuery_containsValue_java_lang_String_java_lang_String_: + +.. _io_realm_RealmQuery_containsValue_java_lang_String__java_lang_String_: + +.. _io_realm_RealmQuery_containsValue_java_lang_String_String_: + +.. _io_realm_RealmQuery_containsValue_java_lang_String__String_: + +.. _io_realm_RealmQuery_containsValue_String_java_lang_String_: + +.. _io_realm_RealmQuery_containsValue_String__java_lang_String_: + +.. _io_realm_RealmQuery_containsValue_String_String_: + +.. _io_realm_RealmQuery_containsValue_String__String_: + +.. _containsValue_java_lang_String_java_lang_String_: + +.. _containsValue_java_lang_String__java_lang_String_: + +.. _containsValue_java_lang_String_String_: + +.. _containsValue_java_lang_String__String_: + +.. _containsValue_String_java_lang_String_: + +.. _containsValue_String__java_lang_String_: + +.. _containsValue_String_String_: + +.. _containsValue_String__String_: + +.. _RealmQuery_containsValue_java_lang_String_java_lang_String_: + +.. _RealmQuery_containsValue_java_lang_String__java_lang_String_: + +.. _RealmQuery_containsValue_java_lang_String_String_: + +.. _RealmQuery_containsValue_java_lang_String__String_: + +.. _RealmQuery_containsValue_String_java_lang_String_: + +.. _RealmQuery_containsValue_String__java_lang_String_: + +.. _RealmQuery_containsValue_String_String_: + +.. _RealmQuery_containsValue_String__String_: + +.. list-table:: + :header-rows: 1 + + * - | public :ref:`RealmQuery ` :ref:`containsValue ` ( + | `String `__ fieldName, + | `String `__ value + | ) + + + + + * - Condition that value, if a dictionary field, contains the specified value. + + + + + **Parameters** + + - ``fieldName`` - the field to compare. + + + + - ``value`` - the value to search for. + + + + + + + + **Returns** + + the query object. + + + + + **Throws** + + - `java.lang.IllegalArgumentException `__ - if the field name isn't valid. + + + + + + + + + + +.. _io_realm_RealmQuery_containsValue_java_lang_String_java_lang_Float_: + +.. _io_realm_RealmQuery_containsValue_java_lang_String__java_lang_Float_: + +.. _io_realm_RealmQuery_containsValue_java_lang_String_Float_: + +.. _io_realm_RealmQuery_containsValue_java_lang_String__Float_: + +.. _io_realm_RealmQuery_containsValue_String_java_lang_Float_: + +.. _io_realm_RealmQuery_containsValue_String__java_lang_Float_: + +.. _io_realm_RealmQuery_containsValue_String_Float_: + +.. _io_realm_RealmQuery_containsValue_String__Float_: + +.. _containsValue_java_lang_String_java_lang_Float_: + +.. _containsValue_java_lang_String__java_lang_Float_: + +.. _containsValue_java_lang_String_Float_: + +.. _containsValue_java_lang_String__Float_: + +.. _containsValue_String_java_lang_Float_: + +.. _containsValue_String__java_lang_Float_: + +.. _containsValue_String_Float_: + +.. _containsValue_String__Float_: + +.. _RealmQuery_containsValue_java_lang_String_java_lang_Float_: + +.. _RealmQuery_containsValue_java_lang_String__java_lang_Float_: + +.. _RealmQuery_containsValue_java_lang_String_Float_: + +.. _RealmQuery_containsValue_java_lang_String__Float_: + +.. _RealmQuery_containsValue_String_java_lang_Float_: + +.. _RealmQuery_containsValue_String__java_lang_Float_: + +.. _RealmQuery_containsValue_String_Float_: + +.. _RealmQuery_containsValue_String__Float_: + +.. list-table:: + :header-rows: 1 + + * - | public :ref:`RealmQuery ` :ref:`containsValue ` ( + | `String `__ fieldName, + | `Float `__ value + | ) + + + + + * - Condition that value, if a dictionary field, contains the specified value. + + + + + **Parameters** + + - ``fieldName`` - the field to compare. + + + + - ``value`` - the value to search for. + + + + + + + + **Returns** + + the query object. + + + + + **Throws** + + - `java.lang.IllegalArgumentException `__ - if the field name isn't valid. + + + + + + + + + + +.. _io_realm_RealmQuery_containsValue_java_lang_String_java_lang_Double_: + +.. _io_realm_RealmQuery_containsValue_java_lang_String__java_lang_Double_: + +.. _io_realm_RealmQuery_containsValue_java_lang_String_Double_: + +.. _io_realm_RealmQuery_containsValue_java_lang_String__Double_: + +.. _io_realm_RealmQuery_containsValue_String_java_lang_Double_: + +.. _io_realm_RealmQuery_containsValue_String__java_lang_Double_: + +.. _io_realm_RealmQuery_containsValue_String_Double_: + +.. _io_realm_RealmQuery_containsValue_String__Double_: + +.. _containsValue_java_lang_String_java_lang_Double_: + +.. _containsValue_java_lang_String__java_lang_Double_: + +.. _containsValue_java_lang_String_Double_: + +.. _containsValue_java_lang_String__Double_: + +.. _containsValue_String_java_lang_Double_: + +.. _containsValue_String__java_lang_Double_: + +.. _containsValue_String_Double_: + +.. _containsValue_String__Double_: + +.. _RealmQuery_containsValue_java_lang_String_java_lang_Double_: + +.. _RealmQuery_containsValue_java_lang_String__java_lang_Double_: + +.. _RealmQuery_containsValue_java_lang_String_Double_: + +.. _RealmQuery_containsValue_java_lang_String__Double_: + +.. _RealmQuery_containsValue_String_java_lang_Double_: + +.. _RealmQuery_containsValue_String__java_lang_Double_: + +.. _RealmQuery_containsValue_String_Double_: + +.. _RealmQuery_containsValue_String__Double_: + +.. list-table:: + :header-rows: 1 + + * - | public :ref:`RealmQuery ` :ref:`containsValue ` ( + | `String `__ fieldName, + | `Double `__ value + | ) + + + + + * - Condition that value, if a dictionary field, contains the specified value. + + + + + **Parameters** + + - ``fieldName`` - the field to compare. + + + + - ``value`` - the value to search for. + + + + + + + + **Returns** + + the query object. + + + + + **Throws** + + - `java.lang.IllegalArgumentException `__ - if the field name isn't valid. + + + + + + + + + + +.. _io_realm_RealmQuery_containsValue_java_lang_String_java_lang_Long_: + +.. _io_realm_RealmQuery_containsValue_java_lang_String__java_lang_Long_: + +.. _io_realm_RealmQuery_containsValue_java_lang_String_Long_: + +.. _io_realm_RealmQuery_containsValue_java_lang_String__Long_: + +.. _io_realm_RealmQuery_containsValue_String_java_lang_Long_: + +.. _io_realm_RealmQuery_containsValue_String__java_lang_Long_: + +.. _io_realm_RealmQuery_containsValue_String_Long_: + +.. _io_realm_RealmQuery_containsValue_String__Long_: + +.. _containsValue_java_lang_String_java_lang_Long_: + +.. _containsValue_java_lang_String__java_lang_Long_: + +.. _containsValue_java_lang_String_Long_: + +.. _containsValue_java_lang_String__Long_: + +.. _containsValue_String_java_lang_Long_: + +.. _containsValue_String__java_lang_Long_: + +.. _containsValue_String_Long_: + +.. _containsValue_String__Long_: + +.. _RealmQuery_containsValue_java_lang_String_java_lang_Long_: + +.. _RealmQuery_containsValue_java_lang_String__java_lang_Long_: + +.. _RealmQuery_containsValue_java_lang_String_Long_: + +.. _RealmQuery_containsValue_java_lang_String__Long_: + +.. _RealmQuery_containsValue_String_java_lang_Long_: + +.. _RealmQuery_containsValue_String__java_lang_Long_: + +.. _RealmQuery_containsValue_String_Long_: + +.. _RealmQuery_containsValue_String__Long_: + +.. list-table:: + :header-rows: 1 + + * - | public :ref:`RealmQuery ` :ref:`containsValue ` ( + | `String `__ fieldName, + | `Long `__ value + | ) + + + + + * - Condition that value, if a dictionary field, contains the specified value. + + + + + **Parameters** + + - ``fieldName`` - the field to compare. + + + + - ``value`` - the value to search for. + + + + + + + + **Returns** + + the query object. + + + + + **Throws** + + - `java.lang.IllegalArgumentException `__ - if the field name isn't valid. + + + + + + + + + + +.. _io_realm_RealmQuery_containsValue_java_lang_String_java_lang_Integer_: + +.. _io_realm_RealmQuery_containsValue_java_lang_String__java_lang_Integer_: + +.. _io_realm_RealmQuery_containsValue_java_lang_String_Integer_: + +.. _io_realm_RealmQuery_containsValue_java_lang_String__Integer_: + +.. _io_realm_RealmQuery_containsValue_String_java_lang_Integer_: + +.. _io_realm_RealmQuery_containsValue_String__java_lang_Integer_: + +.. _io_realm_RealmQuery_containsValue_String_Integer_: + +.. _io_realm_RealmQuery_containsValue_String__Integer_: + +.. _containsValue_java_lang_String_java_lang_Integer_: + +.. _containsValue_java_lang_String__java_lang_Integer_: + +.. _containsValue_java_lang_String_Integer_: + +.. _containsValue_java_lang_String__Integer_: + +.. _containsValue_String_java_lang_Integer_: + +.. _containsValue_String__java_lang_Integer_: + +.. _containsValue_String_Integer_: + +.. _containsValue_String__Integer_: + +.. _RealmQuery_containsValue_java_lang_String_java_lang_Integer_: + +.. _RealmQuery_containsValue_java_lang_String__java_lang_Integer_: + +.. _RealmQuery_containsValue_java_lang_String_Integer_: + +.. _RealmQuery_containsValue_java_lang_String__Integer_: + +.. _RealmQuery_containsValue_String_java_lang_Integer_: + +.. _RealmQuery_containsValue_String__java_lang_Integer_: + +.. _RealmQuery_containsValue_String_Integer_: + +.. _RealmQuery_containsValue_String__Integer_: + +.. list-table:: + :header-rows: 1 + + * - | public :ref:`RealmQuery ` :ref:`containsValue ` ( + | `String `__ fieldName, + | `Integer `__ value + | ) + + + + + * - Condition that value, if a dictionary field, contains the specified value. + + + + + **Parameters** + + - ``fieldName`` - the field to compare. + + + + - ``value`` - the value to search for + + + + + + + + **Returns** + + the query object. + + + + + **Throws** + + - `java.lang.IllegalArgumentException `__ - if the field name isn't valid. + + + + + + + + + + +.. _io_realm_RealmQuery_containsValue_java_lang_String_java_lang_Short_: + +.. _io_realm_RealmQuery_containsValue_java_lang_String__java_lang_Short_: + +.. _io_realm_RealmQuery_containsValue_java_lang_String_Short_: + +.. _io_realm_RealmQuery_containsValue_java_lang_String__Short_: + +.. _io_realm_RealmQuery_containsValue_String_java_lang_Short_: + +.. _io_realm_RealmQuery_containsValue_String__java_lang_Short_: + +.. _io_realm_RealmQuery_containsValue_String_Short_: + +.. _io_realm_RealmQuery_containsValue_String__Short_: + +.. _containsValue_java_lang_String_java_lang_Short_: + +.. _containsValue_java_lang_String__java_lang_Short_: + +.. _containsValue_java_lang_String_Short_: + +.. _containsValue_java_lang_String__Short_: + +.. _containsValue_String_java_lang_Short_: + +.. _containsValue_String__java_lang_Short_: + +.. _containsValue_String_Short_: + +.. _containsValue_String__Short_: + +.. _RealmQuery_containsValue_java_lang_String_java_lang_Short_: + +.. _RealmQuery_containsValue_java_lang_String__java_lang_Short_: + +.. _RealmQuery_containsValue_java_lang_String_Short_: + +.. _RealmQuery_containsValue_java_lang_String__Short_: + +.. _RealmQuery_containsValue_String_java_lang_Short_: + +.. _RealmQuery_containsValue_String__java_lang_Short_: + +.. _RealmQuery_containsValue_String_Short_: + +.. _RealmQuery_containsValue_String__Short_: + +.. list-table:: + :header-rows: 1 + + * - | public :ref:`RealmQuery ` :ref:`containsValue ` ( + | `String `__ fieldName, + | `Short `__ value + | ) + + + + + * - Condition that value, if a dictionary field, contains the specified value. + + + + + **Parameters** + + - ``fieldName`` - the field to compare. + + + + - ``value`` - the value to search for. + + + + + + + + **Returns** + + the query object. + + + + + **Throws** + + - `java.lang.IllegalArgumentException `__ - if the field name isn't valid. + + + + + + + + + + +.. _io_realm_RealmQuery_containsValue_java_lang_String_java_lang_Byte_: + +.. _io_realm_RealmQuery_containsValue_java_lang_String__java_lang_Byte_: + +.. _io_realm_RealmQuery_containsValue_java_lang_String_Byte_: + +.. _io_realm_RealmQuery_containsValue_java_lang_String__Byte_: + +.. _io_realm_RealmQuery_containsValue_String_java_lang_Byte_: + +.. _io_realm_RealmQuery_containsValue_String__java_lang_Byte_: + +.. _io_realm_RealmQuery_containsValue_String_Byte_: + +.. _io_realm_RealmQuery_containsValue_String__Byte_: + +.. _containsValue_java_lang_String_java_lang_Byte_: + +.. _containsValue_java_lang_String__java_lang_Byte_: + +.. _containsValue_java_lang_String_Byte_: + +.. _containsValue_java_lang_String__Byte_: + +.. _containsValue_String_java_lang_Byte_: + +.. _containsValue_String__java_lang_Byte_: + +.. _containsValue_String_Byte_: + +.. _containsValue_String__Byte_: + +.. _RealmQuery_containsValue_java_lang_String_java_lang_Byte_: + +.. _RealmQuery_containsValue_java_lang_String__java_lang_Byte_: + +.. _RealmQuery_containsValue_java_lang_String_Byte_: + +.. _RealmQuery_containsValue_java_lang_String__Byte_: + +.. _RealmQuery_containsValue_String_java_lang_Byte_: + +.. _RealmQuery_containsValue_String__java_lang_Byte_: + +.. _RealmQuery_containsValue_String_Byte_: + +.. _RealmQuery_containsValue_String__Byte_: + +.. list-table:: + :header-rows: 1 + + * - | public :ref:`RealmQuery ` :ref:`containsValue ` ( + | `String `__ fieldName, + | `Byte `__ value + | ) + + + + + * - Condition that value, if a dictionary field, contains the specified value. + + + + + **Parameters** + + - ``fieldName`` - the field to compare. + + + + - ``value`` - the value to search for. + + + + + + + + **Returns** + + the query object. + + + + + **Throws** + + - `java.lang.IllegalArgumentException `__ - if the field name isn't valid. + + + + + + + + + + +.. _io_realm_RealmQuery_containsValue_java_lang_String_java_lang_Boolean_: + +.. _io_realm_RealmQuery_containsValue_java_lang_String__java_lang_Boolean_: + +.. _io_realm_RealmQuery_containsValue_java_lang_String_Boolean_: + +.. _io_realm_RealmQuery_containsValue_java_lang_String__Boolean_: + +.. _io_realm_RealmQuery_containsValue_String_java_lang_Boolean_: + +.. _io_realm_RealmQuery_containsValue_String__java_lang_Boolean_: + +.. _io_realm_RealmQuery_containsValue_String_Boolean_: + +.. _io_realm_RealmQuery_containsValue_String__Boolean_: -.. _RealmQuery_contains_java_lang_String_java_lang_String_: +.. _containsValue_java_lang_String_java_lang_Boolean_: -.. _RealmQuery_contains_java_lang_String__java_lang_String_: +.. _containsValue_java_lang_String__java_lang_Boolean_: -.. _RealmQuery_contains_java_lang_String_String_: +.. _containsValue_java_lang_String_Boolean_: -.. _RealmQuery_contains_java_lang_String__String_: +.. _containsValue_java_lang_String__Boolean_: -.. _RealmQuery_contains_String_java_lang_String_: +.. _containsValue_String_java_lang_Boolean_: -.. _RealmQuery_contains_String__java_lang_String_: +.. _containsValue_String__java_lang_Boolean_: -.. _RealmQuery_contains_String_String_: +.. _containsValue_String_Boolean_: -.. _RealmQuery_contains_String__String_: +.. _containsValue_String__Boolean_: + +.. _RealmQuery_containsValue_java_lang_String_java_lang_Boolean_: + +.. _RealmQuery_containsValue_java_lang_String__java_lang_Boolean_: + +.. _RealmQuery_containsValue_java_lang_String_Boolean_: + +.. _RealmQuery_containsValue_java_lang_String__Boolean_: + +.. _RealmQuery_containsValue_String_java_lang_Boolean_: + +.. _RealmQuery_containsValue_String__java_lang_Boolean_: + +.. _RealmQuery_containsValue_String_Boolean_: + +.. _RealmQuery_containsValue_String__Boolean_: .. list-table:: :header-rows: 1 - * - | public :ref:`RealmQuery ` :ref:`contains ` ( - | `String `__ fieldName, - | `String `__ value + * - | public :ref:`RealmQuery ` :ref:`containsValue ` ( + | `String `__ fieldName, + | `Boolean `__ value | ) - * - Condition that value of field contains the specified substring. + * - Condition that value, if a dictionary field, contains the specified value. @@ -2583,7 +5130,7 @@ contains - - ``value`` - the substring. + - ``value`` - the value to search for. @@ -2600,7 +5147,7 @@ contains **Throws** - - `java.lang.IllegalArgumentException `__ - if one or more arguments do not match class or field type. + - `java.lang.IllegalArgumentException `__ - if the field name isn't valid. @@ -2655,7 +5202,7 @@ count **Throws** - - `java.lang.UnsupportedOperationException `__ - if the query is not valid ("syntax error"). + - `java.lang.UnsupportedOperationException `__ - if the query is not valid ("syntax error"). @@ -2767,8 +5314,8 @@ distinct :header-rows: 1 * - | public :ref:`RealmQuery ` :ref:`distinct ` ( - | `String `__ firstFieldName, - | `java.lang.String[] `__ remainingFieldNames + | `String `__ firstFieldName, + | `java.lang.String[] `__ remainingFieldNames | ) @@ -2797,75 +5344,13 @@ distinct **Throws** - - `IllegalArgumentException `__ - if field names is empty or ``null`` , does not exist, is an unsupported type, or points to a linked field. - - - - - - - `IllegalStateException `__ - if distinct field names were already defined. - - - - - - - - - - -.. _io_realm_RealmQuery_distinct_java_lang_String_: - -.. _io_realm_RealmQuery_distinct_String_: - -.. _distinct_java_lang_String_: - -.. _distinct_String_: - -.. _RealmQuery_distinct_java_lang_String_: - -.. _RealmQuery_distinct_String_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmQuery ` :ref:`distinct ` ( - | `String `__ fieldName - | ) - - - - - * - Selects 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.Adding :ref:`io.realm.annotations.Index ` to the corresponding field will make this operation much faster. - - - - - - - - - **Parameters** - - - ``fieldName`` - the field name. - - - - - - - - - - **Throws** - - - `IllegalArgumentException `__ - if a field is ``null`` , does not exist, is an unsupported type, or points to linked fields. + - `IllegalArgumentException `__ - if field names is empty or ``null`` , does not exist, is an unsupported type, or points to a linked field. - - `IllegalStateException `__ - if distinct field names were already defined. + - `IllegalStateException `__ - if distinct field names were already defined. @@ -2958,6 +5443,159 @@ endGroup endsWith -------- +.. _io_realm_RealmQuery_endsWith_java_lang_String_io_realm_RealmAny_io_realm_Case_: + +.. _io_realm_RealmQuery_endsWith_java_lang_String__io_realm_RealmAny__io_realm_Case_: + +.. _io_realm_RealmQuery_endsWith_java_lang_String_io_realm_RealmAny_Case_: + +.. _io_realm_RealmQuery_endsWith_java_lang_String__io_realm_RealmAny__Case_: + +.. _io_realm_RealmQuery_endsWith_java_lang_String_RealmAny_io_realm_Case_: + +.. _io_realm_RealmQuery_endsWith_java_lang_String__RealmAny__io_realm_Case_: + +.. _io_realm_RealmQuery_endsWith_java_lang_String_RealmAny_Case_: + +.. _io_realm_RealmQuery_endsWith_java_lang_String__RealmAny__Case_: + +.. _io_realm_RealmQuery_endsWith_String_io_realm_RealmAny_io_realm_Case_: + +.. _io_realm_RealmQuery_endsWith_String__io_realm_RealmAny__io_realm_Case_: + +.. _io_realm_RealmQuery_endsWith_String_io_realm_RealmAny_Case_: + +.. _io_realm_RealmQuery_endsWith_String__io_realm_RealmAny__Case_: + +.. _io_realm_RealmQuery_endsWith_String_RealmAny_io_realm_Case_: + +.. _io_realm_RealmQuery_endsWith_String__RealmAny__io_realm_Case_: + +.. _io_realm_RealmQuery_endsWith_String_RealmAny_Case_: + +.. _io_realm_RealmQuery_endsWith_String__RealmAny__Case_: + +.. _endsWith_java_lang_String_io_realm_RealmAny_io_realm_Case_: + +.. _endsWith_java_lang_String__io_realm_RealmAny__io_realm_Case_: + +.. _endsWith_java_lang_String_io_realm_RealmAny_Case_: + +.. _endsWith_java_lang_String__io_realm_RealmAny__Case_: + +.. _endsWith_java_lang_String_RealmAny_io_realm_Case_: + +.. _endsWith_java_lang_String__RealmAny__io_realm_Case_: + +.. _endsWith_java_lang_String_RealmAny_Case_: + +.. _endsWith_java_lang_String__RealmAny__Case_: + +.. _endsWith_String_io_realm_RealmAny_io_realm_Case_: + +.. _endsWith_String__io_realm_RealmAny__io_realm_Case_: + +.. _endsWith_String_io_realm_RealmAny_Case_: + +.. _endsWith_String__io_realm_RealmAny__Case_: + +.. _endsWith_String_RealmAny_io_realm_Case_: + +.. _endsWith_String__RealmAny__io_realm_Case_: + +.. _endsWith_String_RealmAny_Case_: + +.. _endsWith_String__RealmAny__Case_: + +.. _RealmQuery_endsWith_java_lang_String_io_realm_RealmAny_io_realm_Case_: + +.. _RealmQuery_endsWith_java_lang_String__io_realm_RealmAny__io_realm_Case_: + +.. _RealmQuery_endsWith_java_lang_String_io_realm_RealmAny_Case_: + +.. _RealmQuery_endsWith_java_lang_String__io_realm_RealmAny__Case_: + +.. _RealmQuery_endsWith_java_lang_String_RealmAny_io_realm_Case_: + +.. _RealmQuery_endsWith_java_lang_String__RealmAny__io_realm_Case_: + +.. _RealmQuery_endsWith_java_lang_String_RealmAny_Case_: + +.. _RealmQuery_endsWith_java_lang_String__RealmAny__Case_: + +.. _RealmQuery_endsWith_String_io_realm_RealmAny_io_realm_Case_: + +.. _RealmQuery_endsWith_String__io_realm_RealmAny__io_realm_Case_: + +.. _RealmQuery_endsWith_String_io_realm_RealmAny_Case_: + +.. _RealmQuery_endsWith_String__io_realm_RealmAny__Case_: + +.. _RealmQuery_endsWith_String_RealmAny_io_realm_Case_: + +.. _RealmQuery_endsWith_String__RealmAny__io_realm_Case_: + +.. _RealmQuery_endsWith_String_RealmAny_Case_: + +.. _RealmQuery_endsWith_String__RealmAny__Case_: + +.. list-table:: + :header-rows: 1 + + * - | public :ref:`RealmQuery ` :ref:`endsWith ` ( + | `String `__ fieldName, + | :ref:`RealmAny ` value, + | :ref:`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 :ref:`Case.INSENSITIVE ` only works for Latin-1 characters. + + + + + + + + + + **Returns** + + the query object. + + + + + **Throws** + + - `java.lang.IllegalArgumentException `__ - if one or more arguments do not match class or field type. + + + + + + + + + + .. _io_realm_RealmQuery_endsWith_java_lang_String_java_lang_String_io_realm_Case_: .. _io_realm_RealmQuery_endsWith_java_lang_String__java_lang_String__io_realm_Case_: @@ -3008,65 +5646,169 @@ endsWith .. _endsWith_String_java_lang_String_io_realm_Case_: -.. _endsWith_String__java_lang_String__io_realm_Case_: +.. _endsWith_String__java_lang_String__io_realm_Case_: + +.. _endsWith_String_java_lang_String_Case_: + +.. _endsWith_String__java_lang_String__Case_: + +.. _endsWith_String_String_io_realm_Case_: + +.. _endsWith_String__String__io_realm_Case_: + +.. _endsWith_String_String_Case_: + +.. _endsWith_String__String__Case_: + +.. _RealmQuery_endsWith_java_lang_String_java_lang_String_io_realm_Case_: + +.. _RealmQuery_endsWith_java_lang_String__java_lang_String__io_realm_Case_: + +.. _RealmQuery_endsWith_java_lang_String_java_lang_String_Case_: + +.. _RealmQuery_endsWith_java_lang_String__java_lang_String__Case_: + +.. _RealmQuery_endsWith_java_lang_String_String_io_realm_Case_: + +.. _RealmQuery_endsWith_java_lang_String__String__io_realm_Case_: + +.. _RealmQuery_endsWith_java_lang_String_String_Case_: + +.. _RealmQuery_endsWith_java_lang_String__String__Case_: + +.. _RealmQuery_endsWith_String_java_lang_String_io_realm_Case_: + +.. _RealmQuery_endsWith_String__java_lang_String__io_realm_Case_: + +.. _RealmQuery_endsWith_String_java_lang_String_Case_: + +.. _RealmQuery_endsWith_String__java_lang_String__Case_: + +.. _RealmQuery_endsWith_String_String_io_realm_Case_: + +.. _RealmQuery_endsWith_String__String__io_realm_Case_: + +.. _RealmQuery_endsWith_String_String_Case_: + +.. _RealmQuery_endsWith_String__String__Case_: + +.. list-table:: + :header-rows: 1 + + * - | public :ref:`RealmQuery ` :ref:`endsWith ` ( + | `String `__ fieldName, + | `String `__ value, + | :ref:`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 :ref:`Case.INSENSITIVE ` only works for Latin-1 characters. + + + + + + + + + + **Returns** + + the query object. + + + + + **Throws** + + - `java.lang.IllegalArgumentException `__ - if one or more arguments do not match class or field type. + + + + + + + + + + +.. _io_realm_RealmQuery_endsWith_java_lang_String_io_realm_RealmAny_: + +.. _io_realm_RealmQuery_endsWith_java_lang_String__io_realm_RealmAny_: -.. _endsWith_String_java_lang_String_Case_: +.. _io_realm_RealmQuery_endsWith_java_lang_String_RealmAny_: -.. _endsWith_String__java_lang_String__Case_: +.. _io_realm_RealmQuery_endsWith_java_lang_String__RealmAny_: -.. _endsWith_String_String_io_realm_Case_: +.. _io_realm_RealmQuery_endsWith_String_io_realm_RealmAny_: -.. _endsWith_String__String__io_realm_Case_: +.. _io_realm_RealmQuery_endsWith_String__io_realm_RealmAny_: -.. _endsWith_String_String_Case_: +.. _io_realm_RealmQuery_endsWith_String_RealmAny_: -.. _endsWith_String__String__Case_: +.. _io_realm_RealmQuery_endsWith_String__RealmAny_: -.. _RealmQuery_endsWith_java_lang_String_java_lang_String_io_realm_Case_: +.. _endsWith_java_lang_String_io_realm_RealmAny_: -.. _RealmQuery_endsWith_java_lang_String__java_lang_String__io_realm_Case_: +.. _endsWith_java_lang_String__io_realm_RealmAny_: -.. _RealmQuery_endsWith_java_lang_String_java_lang_String_Case_: +.. _endsWith_java_lang_String_RealmAny_: -.. _RealmQuery_endsWith_java_lang_String__java_lang_String__Case_: +.. _endsWith_java_lang_String__RealmAny_: -.. _RealmQuery_endsWith_java_lang_String_String_io_realm_Case_: +.. _endsWith_String_io_realm_RealmAny_: -.. _RealmQuery_endsWith_java_lang_String__String__io_realm_Case_: +.. _endsWith_String__io_realm_RealmAny_: -.. _RealmQuery_endsWith_java_lang_String_String_Case_: +.. _endsWith_String_RealmAny_: -.. _RealmQuery_endsWith_java_lang_String__String__Case_: +.. _endsWith_String__RealmAny_: -.. _RealmQuery_endsWith_String_java_lang_String_io_realm_Case_: +.. _RealmQuery_endsWith_java_lang_String_io_realm_RealmAny_: -.. _RealmQuery_endsWith_String__java_lang_String__io_realm_Case_: +.. _RealmQuery_endsWith_java_lang_String__io_realm_RealmAny_: -.. _RealmQuery_endsWith_String_java_lang_String_Case_: +.. _RealmQuery_endsWith_java_lang_String_RealmAny_: -.. _RealmQuery_endsWith_String__java_lang_String__Case_: +.. _RealmQuery_endsWith_java_lang_String__RealmAny_: -.. _RealmQuery_endsWith_String_String_io_realm_Case_: +.. _RealmQuery_endsWith_String_io_realm_RealmAny_: -.. _RealmQuery_endsWith_String__String__io_realm_Case_: +.. _RealmQuery_endsWith_String__io_realm_RealmAny_: -.. _RealmQuery_endsWith_String_String_Case_: +.. _RealmQuery_endsWith_String_RealmAny_: -.. _RealmQuery_endsWith_String__String__Case_: +.. _RealmQuery_endsWith_String__RealmAny_: .. list-table:: :header-rows: 1 * - | public :ref:`RealmQuery ` :ref:`endsWith ` ( - | `String `__ fieldName, - | `String `__ value, - | :ref:`Case ` casing + | `String `__ fieldName, + | :ref:`RealmAny ` value | ) - * - Condition that the value of field ends with the specified substring. + * - Condition that the value of field ends with the specified string. @@ -3077,13 +5819,7 @@ endsWith - - ``value`` - the substring. - - - - - ``casing`` - how to handle casing. Setting this to :ref:`Case.INSENSITIVE ` only works for Latin-1 characters. - - + - ``value`` - the string. @@ -3100,7 +5836,7 @@ endsWith **Throws** - - `java.lang.IllegalArgumentException `__ - if one or more arguments do not match class or field type. + - `java.lang.IllegalArgumentException `__ - if one or more arguments do not match class or field type. @@ -3163,8 +5899,8 @@ endsWith :header-rows: 1 * - | public :ref:`RealmQuery ` :ref:`endsWith ` ( - | `String `__ fieldName, - | `String `__ value + | `String `__ fieldName, + | `String `__ value | ) @@ -3198,7 +5934,7 @@ endsWith **Throws** - - `java.lang.IllegalArgumentException `__ - if one or more arguments do not match class or field type. + - `java.lang.IllegalArgumentException `__ - if one or more arguments do not match class or field type. @@ -3256,7 +5992,7 @@ equalTo :header-rows: 1 * - | public :ref:`RealmQuery ` :ref:`equalTo ` ( - | `String `__ fieldName, + | `String `__ fieldName, | **ObjectId** value | ) @@ -3291,7 +6027,7 @@ equalTo **Throws** - - `java.lang.IllegalArgumentException `__ - if one or more arguments do not match class or field type. + - `java.lang.IllegalArgumentException `__ - if one or more arguments do not match class or field type. @@ -3330,7 +6066,7 @@ equalTo :header-rows: 1 * - | public :ref:`RealmQuery ` :ref:`equalTo ` ( - | `String `__ fieldName, + | `String `__ fieldName, | **Decimal128** value | ) @@ -3365,7 +6101,160 @@ equalTo **Throws** - - `java.lang.IllegalArgumentException `__ - if one or more arguments do not match class or field type. + - `java.lang.IllegalArgumentException `__ - if one or more arguments do not match class or field type. + + + + + + + + + + +.. _io_realm_RealmQuery_equalTo_java_lang_String_io_realm_RealmAny_io_realm_Case_: + +.. _io_realm_RealmQuery_equalTo_java_lang_String__io_realm_RealmAny__io_realm_Case_: + +.. _io_realm_RealmQuery_equalTo_java_lang_String_io_realm_RealmAny_Case_: + +.. _io_realm_RealmQuery_equalTo_java_lang_String__io_realm_RealmAny__Case_: + +.. _io_realm_RealmQuery_equalTo_java_lang_String_RealmAny_io_realm_Case_: + +.. _io_realm_RealmQuery_equalTo_java_lang_String__RealmAny__io_realm_Case_: + +.. _io_realm_RealmQuery_equalTo_java_lang_String_RealmAny_Case_: + +.. _io_realm_RealmQuery_equalTo_java_lang_String__RealmAny__Case_: + +.. _io_realm_RealmQuery_equalTo_String_io_realm_RealmAny_io_realm_Case_: + +.. _io_realm_RealmQuery_equalTo_String__io_realm_RealmAny__io_realm_Case_: + +.. _io_realm_RealmQuery_equalTo_String_io_realm_RealmAny_Case_: + +.. _io_realm_RealmQuery_equalTo_String__io_realm_RealmAny__Case_: + +.. _io_realm_RealmQuery_equalTo_String_RealmAny_io_realm_Case_: + +.. _io_realm_RealmQuery_equalTo_String__RealmAny__io_realm_Case_: + +.. _io_realm_RealmQuery_equalTo_String_RealmAny_Case_: + +.. _io_realm_RealmQuery_equalTo_String__RealmAny__Case_: + +.. _equalTo_java_lang_String_io_realm_RealmAny_io_realm_Case_: + +.. _equalTo_java_lang_String__io_realm_RealmAny__io_realm_Case_: + +.. _equalTo_java_lang_String_io_realm_RealmAny_Case_: + +.. _equalTo_java_lang_String__io_realm_RealmAny__Case_: + +.. _equalTo_java_lang_String_RealmAny_io_realm_Case_: + +.. _equalTo_java_lang_String__RealmAny__io_realm_Case_: + +.. _equalTo_java_lang_String_RealmAny_Case_: + +.. _equalTo_java_lang_String__RealmAny__Case_: + +.. _equalTo_String_io_realm_RealmAny_io_realm_Case_: + +.. _equalTo_String__io_realm_RealmAny__io_realm_Case_: + +.. _equalTo_String_io_realm_RealmAny_Case_: + +.. _equalTo_String__io_realm_RealmAny__Case_: + +.. _equalTo_String_RealmAny_io_realm_Case_: + +.. _equalTo_String__RealmAny__io_realm_Case_: + +.. _equalTo_String_RealmAny_Case_: + +.. _equalTo_String__RealmAny__Case_: + +.. _RealmQuery_equalTo_java_lang_String_io_realm_RealmAny_io_realm_Case_: + +.. _RealmQuery_equalTo_java_lang_String__io_realm_RealmAny__io_realm_Case_: + +.. _RealmQuery_equalTo_java_lang_String_io_realm_RealmAny_Case_: + +.. _RealmQuery_equalTo_java_lang_String__io_realm_RealmAny__Case_: + +.. _RealmQuery_equalTo_java_lang_String_RealmAny_io_realm_Case_: + +.. _RealmQuery_equalTo_java_lang_String__RealmAny__io_realm_Case_: + +.. _RealmQuery_equalTo_java_lang_String_RealmAny_Case_: + +.. _RealmQuery_equalTo_java_lang_String__RealmAny__Case_: + +.. _RealmQuery_equalTo_String_io_realm_RealmAny_io_realm_Case_: + +.. _RealmQuery_equalTo_String__io_realm_RealmAny__io_realm_Case_: + +.. _RealmQuery_equalTo_String_io_realm_RealmAny_Case_: + +.. _RealmQuery_equalTo_String__io_realm_RealmAny__Case_: + +.. _RealmQuery_equalTo_String_RealmAny_io_realm_Case_: + +.. _RealmQuery_equalTo_String__RealmAny__io_realm_Case_: + +.. _RealmQuery_equalTo_String_RealmAny_Case_: + +.. _RealmQuery_equalTo_String__RealmAny__Case_: + +.. list-table:: + :header-rows: 1 + + * - | public :ref:`RealmQuery ` :ref:`equalTo ` ( + | `String `__ fieldName, + | :ref:`RealmAny ` value, + | :ref:`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 :ref:`Case.INSENSITIVE ` only works for Latin-1 characters. + + + + + + + + + + **Returns** + + the query object. + + + + + **Throws** + + - `java.lang.IllegalArgumentException `__ - if one or more arguments do not match class or field type. @@ -3476,8 +6365,8 @@ equalTo :header-rows: 1 * - | public :ref:`RealmQuery ` :ref:`equalTo ` ( - | `String `__ fieldName, - | `String `__ value, + | `String `__ fieldName, + | `String `__ value, | :ref:`Case ` casing | ) @@ -3518,7 +6407,7 @@ equalTo **Throws** - - `java.lang.IllegalArgumentException `__ - if one or more arguments do not match class or field type. + - `java.lang.IllegalArgumentException `__ - if one or more arguments do not match class or field type. @@ -3581,8 +6470,8 @@ equalTo :header-rows: 1 * - | public :ref:`RealmQuery ` :ref:`equalTo ` ( - | `String `__ fieldName, - | `String `__ value + | `String `__ fieldName, + | `String `__ value | ) @@ -3616,7 +6505,7 @@ equalTo **Throws** - - `java.lang.IllegalArgumentException `__ - if one or more arguments do not match class or field type. + - `java.lang.IllegalArgumentException `__ - if one or more arguments do not match class or field type. @@ -3872,7 +6761,7 @@ findFirstAsync - * - Similar to :ref:`findFirst() ` but runs asynchronously on a worker thread. An listener should be registered to the returned :ref:`RealmObject ` to get the notification when query completes. The registered listener will also be triggered if there are changes made to the queried :ref:`RealmObject ` . If the :ref:`RealmObject ` is deleted, the listener will be called one last time and then stop. The query will not be re-run. + * - Similar to :ref:`findFirst() ` but runs asynchronously on a worker thread. A listener should be registered to the returned :ref:`RealmObject ` to get the notification when query completes. The registered listener will also be triggered if there are changes made to the queried :ref:`RealmObject ` . If the :ref:`RealmObject ` is deleted, the listener will be called one last time and then stop. The query will not be re-run. @@ -3892,7 +6781,7 @@ findFirstAsync **Throws** - - `IllegalStateException `__ - if this is called on a non-looper thread. + - `IllegalStateException `__ - if this is called on a non-looper thread. @@ -3925,7 +6814,7 @@ getDescription .. list-table:: :header-rows: 1 - * - | public `String `__ :ref:`getDescription ` () + * - | public `String `__ :ref:`getDescription ` () | @@ -3952,6 +6841,53 @@ getDescription +.. _getQueryPointer: + +.. _getQueryPointer__: + +.. _RealmQuery_getQueryPointer: + +.. _RealmQuery_getQueryPointer__: + +.. _io_realm_RealmQuery_getQueryPointer: + +.. _io_realm_RealmQuery_getQueryPointer__: + + + +getQueryPointer +--------------- + +.. list-table:: + :header-rows: 1 + + * - | public **long** :ref:`getQueryPointer ` () + | + + + + + * - Returns the pointer to the underlying C++ query. This method is only public due to architectural design choices that are hard to work around and should be considered internal and can change without warning. + + + + + + + **Returns** + + the pointer to the underlying C++ query. + + + + + + + + + + + .. _getRealm: .. _getRealm__: @@ -4002,7 +6938,7 @@ getRealm **Throws** - - `IllegalStateException `__ - if the Realm is an instance of :ref:`DynamicRealm ` or the :ref:`Realm ` was already closed. + - `IllegalStateException `__ - if the Realm is an instance of :ref:`DynamicRealm ` or the :ref:`Realm ` was already closed. @@ -4037,7 +6973,7 @@ getTypeQueried .. list-table:: :header-rows: 1 - * - | public `String `__ :ref:`getTypeQueried ` () + * - | public `String `__ :ref:`getTypeQueried ` () | @@ -4083,34 +7019,108 @@ greaterThan .. _io_realm_RealmQuery_greaterThan_java_lang_String_ObjectId_: -.. _io_realm_RealmQuery_greaterThan_java_lang_String__ObjectId_: +.. _io_realm_RealmQuery_greaterThan_java_lang_String__ObjectId_: + +.. _io_realm_RealmQuery_greaterThan_String_ObjectId_: + +.. _io_realm_RealmQuery_greaterThan_String__ObjectId_: + +.. _greaterThan_java_lang_String_ObjectId_: + +.. _greaterThan_java_lang_String__ObjectId_: + +.. _greaterThan_String_ObjectId_: + +.. _greaterThan_String__ObjectId_: + +.. _RealmQuery_greaterThan_java_lang_String_ObjectId_: + +.. _RealmQuery_greaterThan_java_lang_String__ObjectId_: + +.. _RealmQuery_greaterThan_String_ObjectId_: + +.. _RealmQuery_greaterThan_String__ObjectId_: + +.. list-table:: + :header-rows: 1 + + * - | public :ref:`RealmQuery ` :ref:`greaterThan ` ( + | `String `__ fieldName, + | **ObjectId** 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. + + + + + + + + + + +.. _io_realm_RealmQuery_greaterThan_java_lang_String_Decimal128_: + +.. _io_realm_RealmQuery_greaterThan_java_lang_String__Decimal128_: -.. _io_realm_RealmQuery_greaterThan_String_ObjectId_: +.. _io_realm_RealmQuery_greaterThan_String_Decimal128_: -.. _io_realm_RealmQuery_greaterThan_String__ObjectId_: +.. _io_realm_RealmQuery_greaterThan_String__Decimal128_: -.. _greaterThan_java_lang_String_ObjectId_: +.. _greaterThan_java_lang_String_Decimal128_: -.. _greaterThan_java_lang_String__ObjectId_: +.. _greaterThan_java_lang_String__Decimal128_: -.. _greaterThan_String_ObjectId_: +.. _greaterThan_String_Decimal128_: -.. _greaterThan_String__ObjectId_: +.. _greaterThan_String__Decimal128_: -.. _RealmQuery_greaterThan_java_lang_String_ObjectId_: +.. _RealmQuery_greaterThan_java_lang_String_Decimal128_: -.. _RealmQuery_greaterThan_java_lang_String__ObjectId_: +.. _RealmQuery_greaterThan_java_lang_String__Decimal128_: -.. _RealmQuery_greaterThan_String_ObjectId_: +.. _RealmQuery_greaterThan_String_Decimal128_: -.. _RealmQuery_greaterThan_String__ObjectId_: +.. _RealmQuery_greaterThan_String__Decimal128_: .. list-table:: :header-rows: 1 * - | public :ref:`RealmQuery ` :ref:`greaterThan ` ( - | `String `__ fieldName, - | **ObjectId** value + | `String `__ fieldName, + | **Decimal128** value | ) @@ -4144,7 +7154,7 @@ greaterThan **Throws** - - `java.lang.IllegalArgumentException `__ - if one or more arguments do not match class or field type. + - `java.lang.IllegalArgumentException `__ - if one or more arguments do not match class or field type. @@ -4155,36 +7165,60 @@ greaterThan -.. _io_realm_RealmQuery_greaterThan_java_lang_String_Decimal128_: +.. _io_realm_RealmQuery_greaterThan_java_lang_String_io_realm_RealmAny_: -.. _io_realm_RealmQuery_greaterThan_java_lang_String__Decimal128_: +.. _io_realm_RealmQuery_greaterThan_java_lang_String__io_realm_RealmAny_: -.. _io_realm_RealmQuery_greaterThan_String_Decimal128_: +.. _io_realm_RealmQuery_greaterThan_java_lang_String_RealmAny_: -.. _io_realm_RealmQuery_greaterThan_String__Decimal128_: +.. _io_realm_RealmQuery_greaterThan_java_lang_String__RealmAny_: -.. _greaterThan_java_lang_String_Decimal128_: +.. _io_realm_RealmQuery_greaterThan_String_io_realm_RealmAny_: -.. _greaterThan_java_lang_String__Decimal128_: +.. _io_realm_RealmQuery_greaterThan_String__io_realm_RealmAny_: -.. _greaterThan_String_Decimal128_: +.. _io_realm_RealmQuery_greaterThan_String_RealmAny_: -.. _greaterThan_String__Decimal128_: +.. _io_realm_RealmQuery_greaterThan_String__RealmAny_: -.. _RealmQuery_greaterThan_java_lang_String_Decimal128_: +.. _greaterThan_java_lang_String_io_realm_RealmAny_: -.. _RealmQuery_greaterThan_java_lang_String__Decimal128_: +.. _greaterThan_java_lang_String__io_realm_RealmAny_: -.. _RealmQuery_greaterThan_String_Decimal128_: +.. _greaterThan_java_lang_String_RealmAny_: -.. _RealmQuery_greaterThan_String__Decimal128_: +.. _greaterThan_java_lang_String__RealmAny_: + +.. _greaterThan_String_io_realm_RealmAny_: + +.. _greaterThan_String__io_realm_RealmAny_: + +.. _greaterThan_String_RealmAny_: + +.. _greaterThan_String__RealmAny_: + +.. _RealmQuery_greaterThan_java_lang_String_io_realm_RealmAny_: + +.. _RealmQuery_greaterThan_java_lang_String__io_realm_RealmAny_: + +.. _RealmQuery_greaterThan_java_lang_String_RealmAny_: + +.. _RealmQuery_greaterThan_java_lang_String__RealmAny_: + +.. _RealmQuery_greaterThan_String_io_realm_RealmAny_: + +.. _RealmQuery_greaterThan_String__io_realm_RealmAny_: + +.. _RealmQuery_greaterThan_String_RealmAny_: + +.. _RealmQuery_greaterThan_String__RealmAny_: .. list-table:: :header-rows: 1 * - | public :ref:`RealmQuery ` :ref:`greaterThan ` ( - | `String `__ fieldName, - | **Decimal128** value + | `String `__ fieldName, + | :ref:`RealmAny ` value | ) @@ -4218,7 +7252,7 @@ greaterThan **Throws** - - `java.lang.IllegalArgumentException `__ - if one or more arguments do not match class or field type. + - `java.lang.IllegalArgumentException `__ - if one or more arguments do not match class or field type. @@ -4281,8 +7315,8 @@ greaterThan :header-rows: 1 * - | public :ref:`RealmQuery ` :ref:`greaterThan ` ( - | `String `__ fieldName, - | `Date `__ value + | `String `__ fieldName, + | `Date `__ value | ) @@ -4316,7 +7350,7 @@ greaterThan **Throws** - - `java.lang.IllegalArgumentException `__ - if one or more arguments do not match class or field type. + - `java.lang.IllegalArgumentException `__ - if one or more arguments do not match class or field type. @@ -4355,7 +7389,7 @@ greaterThan :header-rows: 1 * - | public :ref:`RealmQuery ` :ref:`greaterThan ` ( - | `String `__ fieldName, + | `String `__ fieldName, | **float** value | ) @@ -4390,7 +7424,7 @@ greaterThan **Throws** - - `java.lang.IllegalArgumentException `__ - if one or more arguments do not match class or field type. + - `java.lang.IllegalArgumentException `__ - if one or more arguments do not match class or field type. @@ -4429,7 +7463,7 @@ greaterThan :header-rows: 1 * - | public :ref:`RealmQuery ` :ref:`greaterThan ` ( - | `String `__ fieldName, + | `String `__ fieldName, | **double** value | ) @@ -4464,7 +7498,7 @@ greaterThan **Throws** - - `java.lang.IllegalArgumentException `__ - if one or more arguments do not match class or field type. + - `java.lang.IllegalArgumentException `__ - if one or more arguments do not match class or field type. @@ -4503,7 +7537,7 @@ greaterThan :header-rows: 1 * - | public :ref:`RealmQuery ` :ref:`greaterThan ` ( - | `String `__ fieldName, + | `String `__ fieldName, | **long** value | ) @@ -4538,7 +7572,7 @@ greaterThan **Throws** - - `java.lang.IllegalArgumentException `__ - if one or more arguments do not match class or field type. + - `java.lang.IllegalArgumentException `__ - if one or more arguments do not match class or field type. @@ -4577,7 +7611,7 @@ greaterThan :header-rows: 1 * - | public :ref:`RealmQuery ` :ref:`greaterThan ` ( - | `String `__ fieldName, + | `String `__ fieldName, | **int** value | ) @@ -4612,7 +7646,7 @@ greaterThan **Throws** - - `java.lang.IllegalArgumentException `__ - if one or more arguments do not match class or field type. + - `java.lang.IllegalArgumentException `__ - if one or more arguments do not match class or field type. @@ -4670,7 +7704,7 @@ greaterThanOrEqualTo :header-rows: 1 * - | public :ref:`RealmQuery ` :ref:`greaterThanOrEqualTo ` ( - | `String `__ fieldName, + | `String `__ fieldName, | **ObjectId** value | ) @@ -4705,7 +7739,7 @@ greaterThanOrEqualTo **Throws** - - `java.lang.IllegalArgumentException `__ - if one or more arguments do not match class or field type. + - `java.lang.IllegalArgumentException `__ - if one or more arguments do not match class or field type. @@ -4744,7 +7778,7 @@ greaterThanOrEqualTo :header-rows: 1 * - | public :ref:`RealmQuery ` :ref:`greaterThanOrEqualTo ` ( - | `String `__ fieldName, + | `String `__ fieldName, | **Decimal128** value | ) @@ -4779,7 +7813,7 @@ greaterThanOrEqualTo **Throws** - - `java.lang.IllegalArgumentException `__ - if one or more arguments do not match class or field type. + - `java.lang.IllegalArgumentException `__ - if one or more arguments do not match class or field type. @@ -4842,8 +7876,8 @@ greaterThanOrEqualTo :header-rows: 1 * - | public :ref:`RealmQuery ` :ref:`greaterThanOrEqualTo ` ( - | `String `__ fieldName, - | `Date `__ value + | `String `__ fieldName, + | `Date `__ value | ) @@ -4877,7 +7911,7 @@ greaterThanOrEqualTo **Throws** - - `java.lang.IllegalArgumentException `__ - if one or more arguments do not match class or field type. + - `java.lang.IllegalArgumentException `__ - if one or more arguments do not match class or field type. @@ -4916,7 +7950,7 @@ greaterThanOrEqualTo :header-rows: 1 * - | public :ref:`RealmQuery ` :ref:`greaterThanOrEqualTo ` ( - | `String `__ fieldName, + | `String `__ fieldName, | **float** value | ) @@ -4951,7 +7985,7 @@ greaterThanOrEqualTo **Throws** - - `java.lang.IllegalArgumentException `__ - if one or more arguments do not match class or field type + - `java.lang.IllegalArgumentException `__ - if one or more arguments do not match class or field type @@ -4990,7 +8024,7 @@ greaterThanOrEqualTo :header-rows: 1 * - | public :ref:`RealmQuery ` :ref:`greaterThanOrEqualTo ` ( - | `String `__ fieldName, + | `String `__ fieldName, | **double** value | ) @@ -5025,7 +8059,7 @@ greaterThanOrEqualTo **Throws** - - `java.lang.IllegalArgumentException `__ - if one or more arguments do not match class or field type. + - `java.lang.IllegalArgumentException `__ - if one or more arguments do not match class or field type. @@ -5064,7 +8098,7 @@ greaterThanOrEqualTo :header-rows: 1 * - | public :ref:`RealmQuery ` :ref:`greaterThanOrEqualTo ` ( - | `String `__ fieldName, + | `String `__ fieldName, | **long** value | ) @@ -5099,7 +8133,7 @@ greaterThanOrEqualTo **Throws** - - `java.lang.IllegalArgumentException `__ - if one or more arguments do not match class or field type. + - `java.lang.IllegalArgumentException `__ - if one or more arguments do not match class or field type. @@ -5138,7 +8172,7 @@ greaterThanOrEqualTo :header-rows: 1 * - | public :ref:`RealmQuery ` :ref:`greaterThanOrEqualTo ` ( - | `String `__ fieldName, + | `String `__ fieldName, | **int** value | ) @@ -5173,7 +8207,7 @@ greaterThanOrEqualTo **Throws** - - `java.lang.IllegalArgumentException `__ - if one or more arguments do not match class or field type. + - `java.lang.IllegalArgumentException `__ - if one or more arguments do not match class or field type. @@ -5203,6 +8237,132 @@ greaterThanOrEqualTo in ---- +.. _io_realm_RealmQuery_in_java_lang_String_io_realm_RealmAny_: + +.. _io_realm_RealmQuery_in_java_lang_String__io_realm_RealmAny_: + +.. _io_realm_RealmQuery_in_java_lang_String_RealmAny_: + +.. _io_realm_RealmQuery_in_java_lang_String__RealmAny_: + +.. _io_realm_RealmQuery_in_java_lang_String_RealmAny____: + +.. _io_realm_RealmQuery_in_java_lang_String__RealmAny____: + +.. _io_realm_RealmQuery_in_String_io_realm_RealmAny_: + +.. _io_realm_RealmQuery_in_String__io_realm_RealmAny_: + +.. _io_realm_RealmQuery_in_String_RealmAny_: + +.. _io_realm_RealmQuery_in_String__RealmAny_: + +.. _io_realm_RealmQuery_in_String_RealmAny____: + +.. _io_realm_RealmQuery_in_String__RealmAny____: + +.. _in_java_lang_String_io_realm_RealmAny_: + +.. _in_java_lang_String__io_realm_RealmAny_: + +.. _in_java_lang_String_RealmAny_: + +.. _in_java_lang_String__RealmAny_: + +.. _in_java_lang_String_RealmAny____: + +.. _in_java_lang_String__RealmAny____: + +.. _in_String_io_realm_RealmAny_: + +.. _in_String__io_realm_RealmAny_: + +.. _in_String_RealmAny_: + +.. _in_String__RealmAny_: + +.. _in_String_RealmAny____: + +.. _in_String__RealmAny____: + +.. _RealmQuery_in_java_lang_String_io_realm_RealmAny_: + +.. _RealmQuery_in_java_lang_String__io_realm_RealmAny_: + +.. _RealmQuery_in_java_lang_String_RealmAny_: + +.. _RealmQuery_in_java_lang_String__RealmAny_: + +.. _RealmQuery_in_java_lang_String_RealmAny____: + +.. _RealmQuery_in_java_lang_String__RealmAny____: + +.. _RealmQuery_in_String_io_realm_RealmAny_: + +.. _RealmQuery_in_String__io_realm_RealmAny_: + +.. _RealmQuery_in_String_RealmAny_: + +.. _RealmQuery_in_String__RealmAny_: + +.. _RealmQuery_in_String_RealmAny____: + +.. _RealmQuery_in_String__RealmAny____: + +.. _io_realm_RealmQuery_in_String__RealmAny[]_: + +.. list-table:: + :header-rows: 1 + + * - | public :ref:`RealmQuery ` :ref:`in ` ( + | `String `__ fieldName, + | :ref:`io.realm.RealmAny[] ` values + | ) + + + + + * - In comparison. This allows you to test if objects match any value in an array of values. + + + + + **Parameters** + + - ``fieldName`` - the field to compare. + + + + - ``values`` - array of values to compare with. If ``null`` or the empty array is provided the query will never match any results. + + + + + + + + + + **Returns** + + the query object. + + + + + **Throws** + + - `java.lang.IllegalArgumentException `__ - if the field isn't a Date field. + + + + + + + + + + .. _io_realm_RealmQuery_in_java_lang_String_java_util_Date_: .. _io_realm_RealmQuery_in_java_lang_String__java_util_Date_: @@ -5281,8 +8441,8 @@ in :header-rows: 1 * - | public :ref:`RealmQuery ` :ref:`in ` ( - | `String `__ fieldName, - | `java.util.Date[] `__ values + | `String `__ fieldName, + | `java.util.Date[] `__ values | ) @@ -5318,7 +8478,7 @@ in **Throws** - - `java.lang.IllegalArgumentException `__ - if the field isn't a Date field. + - `java.lang.IllegalArgumentException `__ - if the field isn't a Date field. @@ -5407,8 +8567,8 @@ in :header-rows: 1 * - | public :ref:`RealmQuery ` :ref:`in ` ( - | `String `__ fieldName, - | `java.lang.Boolean[] `__ values + | `String `__ fieldName, + | `java.lang.Boolean[] `__ values | ) @@ -5444,7 +8604,7 @@ in **Throws** - - `java.lang.IllegalArgumentException `__ - if the field isn't a Boolean. or empty. + - `java.lang.IllegalArgumentException `__ - if the field isn't a Boolean. or empty. @@ -5533,8 +8693,8 @@ in :header-rows: 1 * - | public :ref:`RealmQuery ` :ref:`in ` ( - | `String `__ fieldName, - | `java.lang.Float[] `__ values + | `String `__ fieldName, + | `java.lang.Float[] `__ values | ) @@ -5570,7 +8730,7 @@ in **Throws** - - `java.lang.IllegalArgumentException `__ - if the field isn't a Float field. + - `java.lang.IllegalArgumentException `__ - if the field isn't a Float field. @@ -5659,8 +8819,8 @@ in :header-rows: 1 * - | public :ref:`RealmQuery ` :ref:`in ` ( - | `String `__ fieldName, - | `java.lang.Double[] `__ values + | `String `__ fieldName, + | `java.lang.Double[] `__ values | ) @@ -5696,7 +8856,7 @@ in **Throws** - - `java.lang.IllegalArgumentException `__ - if the field isn't a Double field. empty. + - `java.lang.IllegalArgumentException `__ - if the field isn't a Double field. empty. @@ -5785,8 +8945,8 @@ in :header-rows: 1 * - | public :ref:`RealmQuery ` :ref:`in ` ( - | `String `__ fieldName, - | `java.lang.Long[] `__ values + | `String `__ fieldName, + | `java.lang.Long[] `__ values | ) @@ -5822,7 +8982,7 @@ in **Throws** - - `java.lang.IllegalArgumentException `__ - if the field isn't a Long field. empty. + - `java.lang.IllegalArgumentException `__ - if the field isn't a Long field. empty. @@ -5911,8 +9071,8 @@ in :header-rows: 1 * - | public :ref:`RealmQuery ` :ref:`in ` ( - | `String `__ fieldName, - | `java.lang.Integer[] `__ values + | `String `__ fieldName, + | `java.lang.Integer[] `__ values | ) @@ -5948,7 +9108,7 @@ in **Throws** - - `java.lang.IllegalArgumentException `__ - if the field isn't a Integer field. + - `java.lang.IllegalArgumentException `__ - if the field isn't a Integer field. @@ -6037,8 +9197,8 @@ in :header-rows: 1 * - | public :ref:`RealmQuery ` :ref:`in ` ( - | `String `__ fieldName, - | `java.lang.Short[] `__ values + | `String `__ fieldName, + | `java.lang.Short[] `__ values | ) @@ -6074,7 +9234,7 @@ in **Throws** - - `java.lang.IllegalArgumentException `__ - if the field isn't a Short field. + - `java.lang.IllegalArgumentException `__ - if the field isn't a Short field. @@ -6163,8 +9323,8 @@ in :header-rows: 1 * - | public :ref:`RealmQuery ` :ref:`in ` ( - | `String `__ fieldName, - | `java.lang.Byte[] `__ values + | `String `__ fieldName, + | `java.lang.Byte[] `__ values | ) @@ -6200,7 +9360,7 @@ in **Throws** - - `java.lang.IllegalArgumentException `__ - if the field isn't a Byte field. + - `java.lang.IllegalArgumentException `__ - if the field isn't a Byte field. @@ -6361,8 +9521,8 @@ in :header-rows: 1 * - | public :ref:`RealmQuery ` :ref:`in ` ( - | `String `__ fieldName, - | `java.lang.String[] `__ values, + | `String `__ fieldName, + | `java.lang.String[] `__ values, | :ref:`Case ` casing | ) @@ -6405,7 +9565,7 @@ in **Throws** - - `java.lang.IllegalArgumentException `__ - if the field isn't a String field. + - `java.lang.IllegalArgumentException `__ - if the field isn't a String field. @@ -6494,8 +9654,8 @@ in :header-rows: 1 * - | public :ref:`RealmQuery ` :ref:`in ` ( - | `String `__ fieldName, - | `java.lang.String[] `__ values + | `String `__ fieldName, + | `java.lang.String[] `__ values | ) @@ -6531,7 +9691,7 @@ in **Throws** - - `java.lang.IllegalArgumentException `__ - if the field isn't a String field. + - `java.lang.IllegalArgumentException `__ - if the field isn't a String field. @@ -6577,7 +9737,7 @@ isEmpty :header-rows: 1 * - | public :ref:`RealmQuery ` :ref:`isEmpty ` ( - | `String `__ fieldName + | `String `__ fieldName | ) @@ -6607,7 +9767,7 @@ isEmpty **Throws** - - `java.lang.IllegalArgumentException `__ - if the field name isn't valid or its type isn't either a RealmList, String or byte array. + - `java.lang.IllegalArgumentException `__ - if the field name isn't valid or its type isn't either a RealmList, String or byte array. @@ -6653,7 +9813,7 @@ isNotEmpty :header-rows: 1 * - | public :ref:`RealmQuery ` :ref:`isNotEmpty ` ( - | `String `__ fieldName + | `String `__ fieldName | ) @@ -6683,7 +9843,7 @@ isNotEmpty **Throws** - - `java.lang.IllegalArgumentException `__ - if the field name isn't valid or its type isn't either a RealmList, String or byte array. + - `java.lang.IllegalArgumentException `__ - if the field name isn't valid or its type isn't either a RealmList, String or byte array. @@ -6729,7 +9889,7 @@ isNotNull :header-rows: 1 * - | public :ref:`RealmQuery ` :ref:`isNotNull ` ( - | `String `__ fieldName + | `String `__ fieldName | ) @@ -6761,7 +9921,7 @@ isNotNull **Throws** - - `java.lang.IllegalArgumentException `__ - if the field is not nullable. + - `java.lang.IllegalArgumentException `__ - if the field is not nullable. @@ -6821,7 +9981,7 @@ isNull :header-rows: 1 * - | public :ref:`RealmQuery ` :ref:`isNull ` ( - | `String `__ fieldName + | `String `__ fieldName | ) @@ -6857,7 +10017,7 @@ isNull **Throws** - - `java.lang.IllegalArgumentException `__ - if the field is not nullable. + - `java.lang.IllegalArgumentException `__ - if the field is not nullable. @@ -6980,7 +10140,7 @@ lessThan :header-rows: 1 * - | public :ref:`RealmQuery ` :ref:`lessThan ` ( - | `String `__ fieldName, + | `String `__ fieldName, | **ObjectId** value | ) @@ -7015,7 +10175,7 @@ lessThan **Throws** - - `java.lang.IllegalArgumentException `__ - if one or more arguments do not match class or field type. + - `java.lang.IllegalArgumentException `__ - if one or more arguments do not match class or field type. @@ -7054,7 +10214,7 @@ lessThan :header-rows: 1 * - | public :ref:`RealmQuery ` :ref:`lessThan ` ( - | `String `__ fieldName, + | `String `__ fieldName, | **Decimal128** value | ) @@ -7089,7 +10249,7 @@ lessThan **Throws** - - `java.lang.IllegalArgumentException `__ - if one or more arguments do not match class or field type. + - `java.lang.IllegalArgumentException `__ - if one or more arguments do not match class or field type. @@ -7128,7 +10288,7 @@ lessThan :header-rows: 1 * - | public :ref:`RealmQuery ` :ref:`lessThan ` ( - | `String `__ fieldName, + | `String `__ fieldName, | **long** value | ) @@ -7163,7 +10323,7 @@ lessThan **Throws** - - `java.lang.IllegalArgumentException `__ - if one or more arguments do not match class or field type. + - `java.lang.IllegalArgumentException `__ - if one or more arguments do not match class or field type. @@ -7202,7 +10362,7 @@ lessThan :header-rows: 1 * - | public :ref:`RealmQuery ` :ref:`lessThan ` ( - | `String `__ fieldName, + | `String `__ fieldName, | **int** value | ) @@ -7237,7 +10397,7 @@ lessThan **Throws** - - `java.lang.IllegalArgumentException `__ - if one or more arguments do not match class or field type. + - `java.lang.IllegalArgumentException `__ - if one or more arguments do not match class or field type. @@ -7295,7 +10455,7 @@ lessThanOrEqualTo :header-rows: 1 * - | public :ref:`RealmQuery ` :ref:`lessThanOrEqualTo ` ( - | `String `__ fieldName, + | `String `__ fieldName, | **ObjectId** value | ) @@ -7330,7 +10490,7 @@ lessThanOrEqualTo **Throws** - - `java.lang.IllegalArgumentException `__ - if one or more arguments do not match class or field type. + - `java.lang.IllegalArgumentException `__ - if one or more arguments do not match class or field type. @@ -7369,7 +10529,7 @@ lessThanOrEqualTo :header-rows: 1 * - | public :ref:`RealmQuery ` :ref:`lessThanOrEqualTo ` ( - | `String `__ fieldName, + | `String `__ fieldName, | **Decimal128** value | ) @@ -7404,7 +10564,7 @@ lessThanOrEqualTo **Throws** - - `java.lang.IllegalArgumentException `__ - if one or more arguments do not match class or field type. + - `java.lang.IllegalArgumentException `__ - if one or more arguments do not match class or field type. @@ -7443,7 +10603,7 @@ lessThanOrEqualTo :header-rows: 1 * - | public :ref:`RealmQuery ` :ref:`lessThanOrEqualTo ` ( - | `String `__ fieldName, + | `String `__ fieldName, | **long** value | ) @@ -7478,7 +10638,7 @@ lessThanOrEqualTo **Throws** - - `java.lang.IllegalArgumentException `__ - if one or more arguments do not match class or field type. + - `java.lang.IllegalArgumentException `__ - if one or more arguments do not match class or field type. @@ -7517,14 +10677,190 @@ lessThanOrEqualTo :header-rows: 1 * - | public :ref:`RealmQuery ` :ref:`lessThanOrEqualTo ` ( - | `String `__ fieldName, + | `String `__ fieldName, | **int** value | ) - * - Less-than-or-equal-to comparison. + * - 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. + + + + + + + + + + + + +.. _like: + +.. _like__: + +.. _RealmQuery_like: + +.. _RealmQuery_like__: + +.. _io_realm_RealmQuery_like: + +.. _io_realm_RealmQuery_like__: + + + +like +---- + +.. _io_realm_RealmQuery_like_java_lang_String_io_realm_RealmAny_io_realm_Case_: + +.. _io_realm_RealmQuery_like_java_lang_String__io_realm_RealmAny__io_realm_Case_: + +.. _io_realm_RealmQuery_like_java_lang_String_io_realm_RealmAny_Case_: + +.. _io_realm_RealmQuery_like_java_lang_String__io_realm_RealmAny__Case_: + +.. _io_realm_RealmQuery_like_java_lang_String_RealmAny_io_realm_Case_: + +.. _io_realm_RealmQuery_like_java_lang_String__RealmAny__io_realm_Case_: + +.. _io_realm_RealmQuery_like_java_lang_String_RealmAny_Case_: + +.. _io_realm_RealmQuery_like_java_lang_String__RealmAny__Case_: + +.. _io_realm_RealmQuery_like_String_io_realm_RealmAny_io_realm_Case_: + +.. _io_realm_RealmQuery_like_String__io_realm_RealmAny__io_realm_Case_: + +.. _io_realm_RealmQuery_like_String_io_realm_RealmAny_Case_: + +.. _io_realm_RealmQuery_like_String__io_realm_RealmAny__Case_: + +.. _io_realm_RealmQuery_like_String_RealmAny_io_realm_Case_: + +.. _io_realm_RealmQuery_like_String__RealmAny__io_realm_Case_: + +.. _io_realm_RealmQuery_like_String_RealmAny_Case_: + +.. _io_realm_RealmQuery_like_String__RealmAny__Case_: + +.. _like_java_lang_String_io_realm_RealmAny_io_realm_Case_: + +.. _like_java_lang_String__io_realm_RealmAny__io_realm_Case_: + +.. _like_java_lang_String_io_realm_RealmAny_Case_: + +.. _like_java_lang_String__io_realm_RealmAny__Case_: + +.. _like_java_lang_String_RealmAny_io_realm_Case_: + +.. _like_java_lang_String__RealmAny__io_realm_Case_: + +.. _like_java_lang_String_RealmAny_Case_: + +.. _like_java_lang_String__RealmAny__Case_: + +.. _like_String_io_realm_RealmAny_io_realm_Case_: + +.. _like_String__io_realm_RealmAny__io_realm_Case_: + +.. _like_String_io_realm_RealmAny_Case_: + +.. _like_String__io_realm_RealmAny__Case_: + +.. _like_String_RealmAny_io_realm_Case_: + +.. _like_String__RealmAny__io_realm_Case_: + +.. _like_String_RealmAny_Case_: + +.. _like_String__RealmAny__Case_: + +.. _RealmQuery_like_java_lang_String_io_realm_RealmAny_io_realm_Case_: + +.. _RealmQuery_like_java_lang_String__io_realm_RealmAny__io_realm_Case_: + +.. _RealmQuery_like_java_lang_String_io_realm_RealmAny_Case_: + +.. _RealmQuery_like_java_lang_String__io_realm_RealmAny__Case_: + +.. _RealmQuery_like_java_lang_String_RealmAny_io_realm_Case_: + +.. _RealmQuery_like_java_lang_String__RealmAny__io_realm_Case_: + +.. _RealmQuery_like_java_lang_String_RealmAny_Case_: + +.. _RealmQuery_like_java_lang_String__RealmAny__Case_: + +.. _RealmQuery_like_String_io_realm_RealmAny_io_realm_Case_: + +.. _RealmQuery_like_String__io_realm_RealmAny__io_realm_Case_: + +.. _RealmQuery_like_String_io_realm_RealmAny_Case_: + +.. _RealmQuery_like_String__io_realm_RealmAny__Case_: + +.. _RealmQuery_like_String_RealmAny_io_realm_Case_: + +.. _RealmQuery_like_String__RealmAny__io_realm_Case_: + +.. _RealmQuery_like_String_RealmAny_Case_: + +.. _RealmQuery_like_String__RealmAny__Case_: + +.. list-table:: + :header-rows: 1 + + * - | public :ref:`RealmQuery ` :ref:`like ` ( + | `String `__ fieldName, + | :ref:`RealmAny ` value, + | :ref:`Case ` casing + | ) + + + + + * - Condition that the value of field matches with the specified substring, with wildcards: + + - '\*' matches [0, n] unicode chars + + + - '?' matches a single unicode char. + + + + + @@ -7535,7 +10871,13 @@ lessThanOrEqualTo - - ``value`` - the value to compare with. + - ``value`` - the wildcard string. + + + + - ``casing`` - how to handle casing. Setting this to :ref:`Case.INSENSITIVE ` only works for Latin-1 characters. + + @@ -7552,7 +10894,7 @@ lessThanOrEqualTo **Throws** - - `java.lang.IllegalArgumentException `__ - if one or more arguments do not match class or field type. + - `java.lang.IllegalArgumentException `__ - if one or more arguments do not match class or field type. @@ -7563,25 +10905,6 @@ lessThanOrEqualTo - - -.. _like: - -.. _like__: - -.. _RealmQuery_like: - -.. _RealmQuery_like__: - -.. _io_realm_RealmQuery_like: - -.. _io_realm_RealmQuery_like__: - - - -like ----- - .. _io_realm_RealmQuery_like_java_lang_String_java_lang_String_io_realm_Case_: .. _io_realm_RealmQuery_like_java_lang_String__java_lang_String__io_realm_Case_: @@ -7682,8 +11005,8 @@ like :header-rows: 1 * - | public :ref:`RealmQuery ` :ref:`like ` ( - | `String `__ fieldName, - | `String `__ value, + | `String `__ fieldName, + | `String `__ value, | :ref:`Case ` casing | ) @@ -7734,7 +11057,115 @@ like **Throws** - - `java.lang.IllegalArgumentException `__ - if one or more arguments do not match class or field type. + - `java.lang.IllegalArgumentException `__ - if one or more arguments do not match class or field type. + + + + + + + + + + +.. _io_realm_RealmQuery_like_java_lang_String_io_realm_RealmAny_: + +.. _io_realm_RealmQuery_like_java_lang_String__io_realm_RealmAny_: + +.. _io_realm_RealmQuery_like_java_lang_String_RealmAny_: + +.. _io_realm_RealmQuery_like_java_lang_String__RealmAny_: + +.. _io_realm_RealmQuery_like_String_io_realm_RealmAny_: + +.. _io_realm_RealmQuery_like_String__io_realm_RealmAny_: + +.. _io_realm_RealmQuery_like_String_RealmAny_: + +.. _io_realm_RealmQuery_like_String__RealmAny_: + +.. _like_java_lang_String_io_realm_RealmAny_: + +.. _like_java_lang_String__io_realm_RealmAny_: + +.. _like_java_lang_String_RealmAny_: + +.. _like_java_lang_String__RealmAny_: + +.. _like_String_io_realm_RealmAny_: + +.. _like_String__io_realm_RealmAny_: + +.. _like_String_RealmAny_: + +.. _like_String__RealmAny_: + +.. _RealmQuery_like_java_lang_String_io_realm_RealmAny_: + +.. _RealmQuery_like_java_lang_String__io_realm_RealmAny_: + +.. _RealmQuery_like_java_lang_String_RealmAny_: + +.. _RealmQuery_like_java_lang_String__RealmAny_: + +.. _RealmQuery_like_String_io_realm_RealmAny_: + +.. _RealmQuery_like_String__io_realm_RealmAny_: + +.. _RealmQuery_like_String_RealmAny_: + +.. _RealmQuery_like_String__RealmAny_: + +.. list-table:: + :header-rows: 1 + + * - | public :ref:`RealmQuery ` :ref:`like ` ( + | `String `__ fieldName, + | :ref:`RealmAny ` value + | ) + + + + + * - Condition that the value of field matches with the specified substring, with wildcards: + + - '\*' matches [0, n] unicode chars + + + - '?' matches a single unicode char. + + + + + + + + + + **Parameters** + + - ``fieldName`` - the field to compare. + + + + - ``value`` - the wildcard string. + + + + + + + + **Returns** + + the query object. + + + + + **Throws** + + - `java.lang.IllegalArgumentException `__ - if one or more arguments do not match class or field type. @@ -7797,8 +11228,8 @@ like :header-rows: 1 * - | public :ref:`RealmQuery ` :ref:`like ` ( - | `String `__ fieldName, - | `String `__ value + | `String `__ fieldName, + | `String `__ value | ) @@ -7842,7 +11273,7 @@ like **Throws** - - `java.lang.IllegalArgumentException `__ - if one or more arguments do not match class or field type. + - `java.lang.IllegalArgumentException `__ - if one or more arguments do not match class or field type. @@ -7888,7 +11319,7 @@ limit - * - Limits the number of objects returned in case the query matched more objects.Note that when using this method in combination with :ref:`sort(String) ` and :ref:`distinct(String) ` they will be executed in the order they where added which can affect the end result. + * - Limits the number of objects returned in case the query matched more objects.Note that when using this method in combination with :ref:`sort(String) ` and :ref:`distinct(String, String...) ` they will be executed in the order they where added which can affect the end result. @@ -7913,7 +11344,7 @@ limit **Throws** - - `IllegalArgumentException `__ - if the provided ``limit`` is less than 1. + - `IllegalArgumentException `__ - if the provided ``limit`` is less than 1. @@ -7960,8 +11391,8 @@ max .. list-table:: :header-rows: 1 - * - | public `Number `__ :ref:`max ` ( - | `String `__ fieldName + * - | public `Number `__ :ref:`max ` ( + | `String `__ fieldName | ) @@ -7993,7 +11424,7 @@ max **Throws** - - `java.lang.IllegalArgumentException `__ - if the field is not a number type. + - `java.lang.IllegalArgumentException `__ - if the field is not a number type. @@ -8012,6 +11443,86 @@ max +.. _maxRealmAny: + +.. _maxRealmAny__: + +.. _RealmQuery_maxRealmAny: + +.. _RealmQuery_maxRealmAny__: + +.. _io_realm_RealmQuery_maxRealmAny: + +.. _io_realm_RealmQuery_maxRealmAny__: + + + +maxRealmAny +----------- + +.. _io_realm_RealmQuery_maxRealmAny_java_lang_String_: + +.. _io_realm_RealmQuery_maxRealmAny_String_: + +.. _maxRealmAny_java_lang_String_: + +.. _maxRealmAny_String_: + +.. _RealmQuery_maxRealmAny_java_lang_String_: + +.. _RealmQuery_maxRealmAny_String_: + +.. list-table:: + :header-rows: 1 + + * - | public :ref:`RealmAny ` :ref:`maxRealmAny ` ( + | `String `__ fieldName + | ) + + + + + * - Finds the maximum value of a :ref:`RealmAny ` field. + + + + + + + **Parameters** + + - ``fieldName`` - the field containing a RealmAny value. + + + + + + + + **Returns** + + if no objects exist or they all have ``null`` as the value for the given RealmAny field, :ref:`RealmAny.Type.NULL ` will be returned. Otherwise the maximum RealmAny is returned. When determining the maximum RealmAny, objects with ``null`` values are ignored. See the :ref:`RealmAny ` documentation for more details on how RealmAny values are compared. + + + + + + + **Throws** + + - `java.lang.UnsupportedOperationException `__ - if the query is not valid ("syntax error"). + + + + + + + + + + + + .. _maximumDate: .. _maximumDate__: @@ -8022,43 +11533,121 @@ max .. _io_realm_RealmQuery_maximumDate: -.. _io_realm_RealmQuery_maximumDate__: +.. _io_realm_RealmQuery_maximumDate__: + + + +maximumDate +----------- + +.. _io_realm_RealmQuery_maximumDate_java_lang_String_: + +.. _io_realm_RealmQuery_maximumDate_String_: + +.. _maximumDate_java_lang_String_: + +.. _maximumDate_String_: + +.. _RealmQuery_maximumDate_java_lang_String_: + +.. _RealmQuery_maximumDate_String_: + +.. list-table:: + :header-rows: 1 + + * - | public `Date `__ :ref:`maximumDate ` ( + | `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"). + + + + + + + + + + + + +.. _min: + +.. _min__: + +.. _RealmQuery_min: + +.. _RealmQuery_min__: + +.. _io_realm_RealmQuery_min: + +.. _io_realm_RealmQuery_min__: -maximumDate ------------ +min +---- -.. _io_realm_RealmQuery_maximumDate_java_lang_String_: +.. _io_realm_RealmQuery_min_java_lang_String_: -.. _io_realm_RealmQuery_maximumDate_String_: +.. _io_realm_RealmQuery_min_String_: -.. _maximumDate_java_lang_String_: +.. _min_java_lang_String_: -.. _maximumDate_String_: +.. _min_String_: -.. _RealmQuery_maximumDate_java_lang_String_: +.. _RealmQuery_min_java_lang_String_: -.. _RealmQuery_maximumDate_String_: +.. _RealmQuery_min_String_: .. list-table:: :header-rows: 1 - * - | public `Date `__ :ref:`maximumDate ` ( - | `String `__ fieldName + * - | public `Number `__ :ref:`min ` ( + | `String `__ fieldName | ) - * - Finds the maximum value of a field. + * - Finds the minimum value of a field. **Parameters** - - ``fieldName`` - the field name. + - ``fieldName`` - the field to look for a minimum on. Only number fields are supported. @@ -8068,7 +11657,7 @@ maximumDate **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. + 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. @@ -8077,7 +11666,13 @@ maximumDate **Throws** - - `java.lang.UnsupportedOperationException `__ - if the query is not valid ("syntax error"). + - `java.lang.IllegalArgumentException `__ - if the field is not a number type. + + + + - :ref:`RealmException ` - if called from the UI thread after opting out via :ref:`RealmConfiguration.Builder.allowQueriesOnUiThread(boolean) ` . + + @@ -8090,53 +11685,55 @@ maximumDate -.. _min: +.. _minRealmAny: -.. _min__: +.. _minRealmAny__: -.. _RealmQuery_min: +.. _RealmQuery_minRealmAny: -.. _RealmQuery_min__: +.. _RealmQuery_minRealmAny__: -.. _io_realm_RealmQuery_min: +.. _io_realm_RealmQuery_minRealmAny: -.. _io_realm_RealmQuery_min__: +.. _io_realm_RealmQuery_minRealmAny__: -min ----- +minRealmAny +----------- -.. _io_realm_RealmQuery_min_java_lang_String_: +.. _io_realm_RealmQuery_minRealmAny_java_lang_String_: -.. _io_realm_RealmQuery_min_String_: +.. _io_realm_RealmQuery_minRealmAny_String_: -.. _min_java_lang_String_: +.. _minRealmAny_java_lang_String_: -.. _min_String_: +.. _minRealmAny_String_: -.. _RealmQuery_min_java_lang_String_: +.. _RealmQuery_minRealmAny_java_lang_String_: -.. _RealmQuery_min_String_: +.. _RealmQuery_minRealmAny_String_: .. list-table:: :header-rows: 1 - * - | public `Number `__ :ref:`min ` ( - | `String `__ fieldName + * - | public :ref:`RealmAny ` :ref:`minRealmAny ` ( + | `String `__ fieldName | ) - * - Finds the minimum value of a field. + * - Finds the minimum value of a :ref:`RealmAny ` field. + + **Parameters** - - ``fieldName`` - the field to look for a minimum on. Only number fields are supported. + - ``fieldName`` - the field containing a RealmAny value. @@ -8146,7 +11743,7 @@ min **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. + if no objects exist or they all have ``null`` as the value for the given RealmAny field, :ref:`RealmAny.Type.NULL ` will be returned. Otherwise the minimum RealmAny is returned. When determining the minimum RealmAny, objects with ``null`` values are ignored. See the :ref:`RealmAny ` documentation for more details on how RealmAny values are compared. @@ -8155,7 +11752,7 @@ min **Throws** - - `java.lang.IllegalArgumentException `__ - if the field is not a number type. + - `java.lang.UnsupportedOperationException `__ - if the query is not valid ("syntax error"). @@ -8206,8 +11803,8 @@ minimumDate .. list-table:: :header-rows: 1 - * - | public `Date `__ :ref:`minimumDate ` ( - | `String `__ fieldName + * - | public `Date `__ :ref:`minimumDate ` ( + | `String `__ fieldName | ) @@ -8239,7 +11836,7 @@ minimumDate **Throws** - - `java.lang.UnsupportedOperationException `__ - if the query is not valid ("syntax error"). + - `java.lang.UnsupportedOperationException `__ - if the query is not valid ("syntax error"). @@ -8350,7 +11947,7 @@ notEqualTo :header-rows: 1 * - | public :ref:`RealmQuery ` :ref:`notEqualTo ` ( - | `String `__ fieldName, + | `String `__ fieldName, | **ObjectId** value | ) @@ -8385,7 +11982,7 @@ notEqualTo **Throws** - - `java.lang.IllegalArgumentException `__ - if one or more arguments do not match class or field type. + - `java.lang.IllegalArgumentException `__ - if one or more arguments do not match class or field type. @@ -8424,7 +12021,7 @@ notEqualTo :header-rows: 1 * - | public :ref:`RealmQuery ` :ref:`notEqualTo ` ( - | `String `__ fieldName, + | `String `__ fieldName, | **Decimal128** value | ) @@ -8459,7 +12056,160 @@ notEqualTo **Throws** - - `java.lang.IllegalArgumentException `__ - if one or more arguments do not match class or field type. + - `java.lang.IllegalArgumentException `__ - if one or more arguments do not match class or field type. + + + + + + + + + + +.. _io_realm_RealmQuery_notEqualTo_java_lang_String_io_realm_RealmAny_io_realm_Case_: + +.. _io_realm_RealmQuery_notEqualTo_java_lang_String__io_realm_RealmAny__io_realm_Case_: + +.. _io_realm_RealmQuery_notEqualTo_java_lang_String_io_realm_RealmAny_Case_: + +.. _io_realm_RealmQuery_notEqualTo_java_lang_String__io_realm_RealmAny__Case_: + +.. _io_realm_RealmQuery_notEqualTo_java_lang_String_RealmAny_io_realm_Case_: + +.. _io_realm_RealmQuery_notEqualTo_java_lang_String__RealmAny__io_realm_Case_: + +.. _io_realm_RealmQuery_notEqualTo_java_lang_String_RealmAny_Case_: + +.. _io_realm_RealmQuery_notEqualTo_java_lang_String__RealmAny__Case_: + +.. _io_realm_RealmQuery_notEqualTo_String_io_realm_RealmAny_io_realm_Case_: + +.. _io_realm_RealmQuery_notEqualTo_String__io_realm_RealmAny__io_realm_Case_: + +.. _io_realm_RealmQuery_notEqualTo_String_io_realm_RealmAny_Case_: + +.. _io_realm_RealmQuery_notEqualTo_String__io_realm_RealmAny__Case_: + +.. _io_realm_RealmQuery_notEqualTo_String_RealmAny_io_realm_Case_: + +.. _io_realm_RealmQuery_notEqualTo_String__RealmAny__io_realm_Case_: + +.. _io_realm_RealmQuery_notEqualTo_String_RealmAny_Case_: + +.. _io_realm_RealmQuery_notEqualTo_String__RealmAny__Case_: + +.. _notEqualTo_java_lang_String_io_realm_RealmAny_io_realm_Case_: + +.. _notEqualTo_java_lang_String__io_realm_RealmAny__io_realm_Case_: + +.. _notEqualTo_java_lang_String_io_realm_RealmAny_Case_: + +.. _notEqualTo_java_lang_String__io_realm_RealmAny__Case_: + +.. _notEqualTo_java_lang_String_RealmAny_io_realm_Case_: + +.. _notEqualTo_java_lang_String__RealmAny__io_realm_Case_: + +.. _notEqualTo_java_lang_String_RealmAny_Case_: + +.. _notEqualTo_java_lang_String__RealmAny__Case_: + +.. _notEqualTo_String_io_realm_RealmAny_io_realm_Case_: + +.. _notEqualTo_String__io_realm_RealmAny__io_realm_Case_: + +.. _notEqualTo_String_io_realm_RealmAny_Case_: + +.. _notEqualTo_String__io_realm_RealmAny__Case_: + +.. _notEqualTo_String_RealmAny_io_realm_Case_: + +.. _notEqualTo_String__RealmAny__io_realm_Case_: + +.. _notEqualTo_String_RealmAny_Case_: + +.. _notEqualTo_String__RealmAny__Case_: + +.. _RealmQuery_notEqualTo_java_lang_String_io_realm_RealmAny_io_realm_Case_: + +.. _RealmQuery_notEqualTo_java_lang_String__io_realm_RealmAny__io_realm_Case_: + +.. _RealmQuery_notEqualTo_java_lang_String_io_realm_RealmAny_Case_: + +.. _RealmQuery_notEqualTo_java_lang_String__io_realm_RealmAny__Case_: + +.. _RealmQuery_notEqualTo_java_lang_String_RealmAny_io_realm_Case_: + +.. _RealmQuery_notEqualTo_java_lang_String__RealmAny__io_realm_Case_: + +.. _RealmQuery_notEqualTo_java_lang_String_RealmAny_Case_: + +.. _RealmQuery_notEqualTo_java_lang_String__RealmAny__Case_: + +.. _RealmQuery_notEqualTo_String_io_realm_RealmAny_io_realm_Case_: + +.. _RealmQuery_notEqualTo_String__io_realm_RealmAny__io_realm_Case_: + +.. _RealmQuery_notEqualTo_String_io_realm_RealmAny_Case_: + +.. _RealmQuery_notEqualTo_String__io_realm_RealmAny__Case_: + +.. _RealmQuery_notEqualTo_String_RealmAny_io_realm_Case_: + +.. _RealmQuery_notEqualTo_String__RealmAny__io_realm_Case_: + +.. _RealmQuery_notEqualTo_String_RealmAny_Case_: + +.. _RealmQuery_notEqualTo_String__RealmAny__Case_: + +.. list-table:: + :header-rows: 1 + + * - | public :ref:`RealmQuery ` :ref:`notEqualTo ` ( + | `String `__ fieldName, + | :ref:`RealmAny ` value, + | :ref:`Case ` casing + | ) + + + + + * - Not-equal-to comparison. + + + + + **Parameters** + + - ``fieldName`` - the field to compare. + + + + - ``value`` - the value to compare with. + + + + - ``casing`` - how casing is handled. :ref:`Case.INSENSITIVE ` works only for the Latin-1 characters. + + + + + + + + + + **Returns** + + the query object. + + + + + **Throws** + + - `java.lang.IllegalArgumentException `__ - if one or more arguments do not match class or field type. @@ -8570,8 +12320,8 @@ notEqualTo :header-rows: 1 * - | public :ref:`RealmQuery ` :ref:`notEqualTo ` ( - | `String `__ fieldName, - | `String `__ value, + | `String `__ fieldName, + | `String `__ value, | :ref:`Case ` casing | ) @@ -8612,7 +12362,7 @@ notEqualTo **Throws** - - `java.lang.IllegalArgumentException `__ - if one or more arguments do not match class or field type. + - `java.lang.IllegalArgumentException `__ - if one or more arguments do not match class or field type. @@ -8675,8 +12425,8 @@ notEqualTo :header-rows: 1 * - | public :ref:`RealmQuery ` :ref:`notEqualTo ` ( - | `String `__ fieldName, - | `String `__ value + | `String `__ fieldName, + | `String `__ value | ) @@ -8710,7 +12460,7 @@ notEqualTo **Throws** - - `java.lang.IllegalArgumentException `__ - if one or more arguments do not match class or field type. + - `java.lang.IllegalArgumentException `__ - if one or more arguments do not match class or field type. @@ -8770,6 +12520,182 @@ or +.. _rawPredicate: + +.. _rawPredicate__: + +.. _RealmQuery_rawPredicate: + +.. _RealmQuery_rawPredicate__: + +.. _io_realm_RealmQuery_rawPredicate: + +.. _io_realm_RealmQuery_rawPredicate__: + + + +rawPredicate +------------ + +.. _io_realm_RealmQuery_rawPredicate_java_lang_String_java_lang_Object_: + +.. _io_realm_RealmQuery_rawPredicate_java_lang_String__java_lang_Object_: + +.. _io_realm_RealmQuery_rawPredicate_java_lang_String_Object_: + +.. _io_realm_RealmQuery_rawPredicate_java_lang_String__Object_: + +.. _io_realm_RealmQuery_rawPredicate_java_lang_String_Object____: + +.. _io_realm_RealmQuery_rawPredicate_java_lang_String__Object____: + +.. _io_realm_RealmQuery_rawPredicate_String_java_lang_Object_: + +.. _io_realm_RealmQuery_rawPredicate_String__java_lang_Object_: + +.. _io_realm_RealmQuery_rawPredicate_String_Object_: + +.. _io_realm_RealmQuery_rawPredicate_String__Object_: + +.. _io_realm_RealmQuery_rawPredicate_String_Object____: + +.. _io_realm_RealmQuery_rawPredicate_String__Object____: + +.. _rawPredicate_java_lang_String_java_lang_Object_: + +.. _rawPredicate_java_lang_String__java_lang_Object_: + +.. _rawPredicate_java_lang_String_Object_: + +.. _rawPredicate_java_lang_String__Object_: + +.. _rawPredicate_java_lang_String_Object____: + +.. _rawPredicate_java_lang_String__Object____: + +.. _rawPredicate_String_java_lang_Object_: + +.. _rawPredicate_String__java_lang_Object_: + +.. _rawPredicate_String_Object_: + +.. _rawPredicate_String__Object_: + +.. _rawPredicate_String_Object____: + +.. _rawPredicate_String__Object____: + +.. _RealmQuery_rawPredicate_java_lang_String_java_lang_Object_: + +.. _RealmQuery_rawPredicate_java_lang_String__java_lang_Object_: + +.. _RealmQuery_rawPredicate_java_lang_String_Object_: + +.. _RealmQuery_rawPredicate_java_lang_String__Object_: + +.. _RealmQuery_rawPredicate_java_lang_String_Object____: + +.. _RealmQuery_rawPredicate_java_lang_String__Object____: + +.. _RealmQuery_rawPredicate_String_java_lang_Object_: + +.. _RealmQuery_rawPredicate_String__java_lang_Object_: + +.. _RealmQuery_rawPredicate_String_Object_: + +.. _RealmQuery_rawPredicate_String__Object_: + +.. _RealmQuery_rawPredicate_String_Object____: + +.. _RealmQuery_rawPredicate_String__Object____: + +.. list-table:: + :header-rows: 1 + + * - | public :ref:`RealmQuery ` :ref:`rawPredicate ` ( + | `String `__ predicate, + | `java.lang.Object[] `__ arguments + | ) + + + + + * - Create a text-based predicate using the Realm Query Language. This predicate can be combined with other raw or type safe predicates, it accepts Realm values as arguments.Class and property names used in the raw predicate can be either the names defined in the Realm Model classes or the internal names defined using the :ref:`io.realm.annotations.RealmClass ` or :ref:`io.realm.annotations.RealmField ` annotations. If a class or property name contains spaces those must be escaped. + + + + Arguments are defined in the string predicate as $argument_index, where $argument_index is a decimal integer that specifies the position of the argument in the argument list. The first argument is referenced by $0, the second by $1, etc.See `these docs `__ for a more detailed description of the Realm Query Language. + + Examples: + + + .. code-block:: java + + + RealmQuery query = realm.where(Person.class); + + // Simple query + query.rawPredicate("name = 'Jane'"); + + // Spaces in property name + query.rawPredicate("my\ property = 'Jane'"); + + // Multiple predicates + query.rawPredicate("name = 'Jane' OR name = 'John'") + + // Collection queries + query.rawPredicate("children.@count > 3") + query.rawPredicate("ALL children.age > 18") + + // Sub queries + query.rawPredicate("SUBQUERY(children, $child, $child.age > 21 AND $child.gender = 'male').@count > 0"); + + // Sort, Distinct, Limit + query.rawPredicate("name = 'Jane' SORT(lastName ASC) DISTINCT(city) LIMIT(5)"); + + // Arguments + query.rawPredicate("name = $0 AND age > $1", "Jane", 18); + + + + + + + + + + + **Parameters** + + - ``predicate`` - a Realm Query Language predicate. + + + + - ``arguments`` - Realm values for the predicate. + + + + + + + + + + **Throws** + + - `java.lang.IllegalArgumentException `__ - if there is an syntax error. + + + + + + + + + + + + .. _sort: .. _sort__: @@ -8901,7 +12827,7 @@ sort :header-rows: 1 * - | public :ref:`RealmQuery ` :ref:`sort ` ( - | `java.lang.String[] `__ fieldNames, + | `java.lang.String[] `__ fieldNames, | :ref:`io.realm.Sort[] ` sortOrders | ) @@ -8933,11 +12859,11 @@ sort **Throws** - - `IllegalArgumentException `__ - if the field name does not exist. + - `IllegalArgumentException `__ - if the field name does not exist. - - `IllegalStateException `__ - if a sorting order was already defined. + - `IllegalStateException `__ - if a sorting order was already defined. @@ -9144,9 +13070,9 @@ sort :header-rows: 1 * - | public :ref:`RealmQuery ` :ref:`sort ` ( - | `String `__ fieldName1, + | `String `__ fieldName1, | :ref:`Sort ` sortOrder1, - | `String `__ fieldName2, + | `String `__ fieldName2, | :ref:`Sort ` sortOrder2 | ) @@ -9188,11 +13114,11 @@ sort **Throws** - - `IllegalArgumentException `__ - if the field name does not exist. + - `IllegalArgumentException `__ - if the field name does not exist. - - `IllegalStateException `__ - if a sorting order was already defined. + - `IllegalStateException `__ - if a sorting order was already defined. @@ -9255,7 +13181,7 @@ sort :header-rows: 1 * - | public :ref:`RealmQuery ` :ref:`sort ` ( - | `String `__ fieldName, + | `String `__ fieldName, | :ref:`Sort ` sortOrder | ) @@ -9287,11 +13213,11 @@ sort **Throws** - - `IllegalArgumentException `__ - if the field name does not exist. + - `IllegalArgumentException `__ - if the field name does not exist. - - `IllegalStateException `__ - if a sorting order was already defined. + - `IllegalStateException `__ - if a sorting order was already defined. @@ -9318,7 +13244,7 @@ sort :header-rows: 1 * - | public :ref:`RealmQuery ` :ref:`sort ` ( - | `String `__ fieldName + | `String `__ fieldName | ) @@ -9345,11 +13271,11 @@ sort **Throws** - - `IllegalArgumentException `__ - if the field name does not exist. + - `IllegalArgumentException `__ - if the field name does not exist. - - `IllegalStateException `__ - if a sorting order was already defined. + - `IllegalStateException `__ - if a sorting order was already defined. @@ -9394,8 +13320,8 @@ sum .. list-table:: :header-rows: 1 - * - | public `Number `__ :ref:`sum ` ( - | `String `__ fieldName + * - | public `Number `__ :ref:`sum ` ( + | `String `__ fieldName | ) @@ -9408,7 +13334,7 @@ sum **Parameters** - - ``fieldName`` - the field to sum. Only number fields are supported. + - ``fieldName`` - the field to sum. Only number and RealmAny fields are supported. @@ -9418,7 +13344,7 @@ sum **Returns** - the sum of fields of the matching objects. 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. + the sum of fields of the matching objects. 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. When applied to a RealmAny field, only numeric values will be summed up (Byte/Integer/Integer/Long/Float/Double/Decimal128) and the returning type will be ``Decimal128`` . @@ -9427,7 +13353,7 @@ sum **Throws** - - `java.lang.IllegalArgumentException `__ - if the field is not a number type. + - `java.lang.IllegalArgumentException `__ - if the field is not a number type. diff --git a/source/sdk/java/api/io/realm/RealmResults.txt b/source/sdk/java/api/io/realm/RealmResults.txt index 6941534c88..36c25ee5bc 100644 --- a/source/sdk/java/api/io/realm/RealmResults.txt +++ b/source/sdk/java/api/io/realm/RealmResults.txt @@ -18,16 +18,16 @@ io.realm ======== - | `java.lang.Object `__ - | `java.util.AbstractCollection `__ - | `java.util.AbstractList `__ + | `java.lang.Object `__ + | `java.util.AbstractCollection `__ + | `java.util.AbstractList `__ | **io.realm.OrderedRealmCollectionImpl** | io.realm.RealmResults This class holds all the matches of a :ref:`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, **Realm.refresh()** must be called to update the results. +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, **Realm.refresh()** must be called to update the results. @@ -123,7 +123,7 @@ Method Summary - * - public `String `__ + * - public `String `__ - | :ref:`asJSON ` () | @@ -140,7 +140,9 @@ Method Summary | - Returns a frozen snapshot of this collection. + + + @@ -150,7 +152,9 @@ Method Summary | - Returns whether or not this object is frozen. + + + @@ -211,7 +215,7 @@ Method Summary * - public **void** - | :ref:`setBlob ` ( - | `String `__ fieldName, + | `String `__ fieldName, | **byte[]** value | ) @@ -223,7 +227,7 @@ Method Summary * - public **void** - | :ref:`setBoolean ` ( - | `String `__ fieldName, + | `String `__ fieldName, | **boolean** value | ) @@ -237,7 +241,7 @@ Method Summary * - public **void** - | :ref:`setByte ` ( - | `String `__ fieldName, + | `String `__ fieldName, | **byte** value | ) @@ -251,8 +255,8 @@ Method Summary * - public **void** - | :ref:`setDate ` ( - | `String `__ fieldName, - | `Date `__ value + | `String `__ fieldName, + | `Date `__ value | ) @@ -265,7 +269,7 @@ Method Summary * - public **void** - | :ref:`setDecimal128 ` ( - | `String `__ fieldName, + | `String `__ fieldName, | **Decimal128** value | ) @@ -279,7 +283,7 @@ Method Summary * - public **void** - | :ref:`setDouble ` ( - | `String `__ fieldName, + | `String `__ fieldName, | **double** value | ) @@ -293,7 +297,7 @@ Method Summary * - public **void** - | :ref:`setFloat ` ( - | `String `__ fieldName, + | `String `__ fieldName, | **float** value | ) @@ -307,7 +311,7 @@ Method Summary * - public **void** - | :ref:`setInt ` ( - | `String `__ fieldName, + | `String `__ fieldName, | **int** value | ) @@ -321,7 +325,7 @@ Method Summary * - public **void** - | :ref:`setList ` <**T** >( - | `String `__ fieldName, + | `String `__ fieldName, | :ref:`io.realm.RealmList\ ` list | ) @@ -333,7 +337,7 @@ Method Summary * - public **void** - | :ref:`setLong ` ( - | `String `__ fieldName, + | `String `__ fieldName, | **long** value | ) @@ -347,7 +351,7 @@ Method Summary * - public **void** - | :ref:`setNull ` ( - | `String `__ fieldName + | `String `__ fieldName | ) @@ -360,7 +364,7 @@ Method Summary * - public **void** - | :ref:`setObject ` ( - | `String `__ fieldName, + | `String `__ fieldName, | :ref:`RealmModel ` value | ) @@ -372,7 +376,7 @@ Method Summary * - public **void** - | :ref:`setObjectId ` ( - | `String `__ fieldName, + | `String `__ fieldName, | **ObjectId** value | ) @@ -386,7 +390,7 @@ Method Summary * - public **void** - | :ref:`setShort ` ( - | `String `__ fieldName, + | `String `__ fieldName, | **short** value | ) @@ -400,8 +404,8 @@ Method Summary * - public **void** - | :ref:`setString ` ( - | `String `__ fieldName, - | `String `__ value + | `String `__ fieldName, + | `String `__ value | ) @@ -412,10 +416,24 @@ Method Summary + * - public **void** + - | :ref:`setUUID ` ( + | `String `__ fieldName, + | `UUID `__ value + | ) + + + Sets the ``UUID`` value of the given field in all of the objects in the collection. + + + + + + * - public **void** - | :ref:`setValue ` ( - | `String `__ fieldName, - | `Object `__ value + | `String `__ fieldName, + | `Object `__ value | ) @@ -428,9 +446,9 @@ Method Summary * - public :ref:`RealmResults ` - | :ref:`sort ` ( - | `String `__ fieldName1, + | `String `__ fieldName1, | :ref:`Sort ` sortOrder1, - | `String `__ fieldName2, + | `String `__ fieldName2, | :ref:`Sort ` sortOrder2 | ) @@ -460,10 +478,10 @@ Inherited Methods -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` -- Methods inherited from class `java.util.AbstractCollection `__ : ``iterator`` , ``size`` , ``isEmpty`` , ``contains`` , ``toArray`` , ``toArray`` , ``add`` , ``remove`` , ``containsAll`` , ``addAll`` , ``removeAll`` , ``retainAll`` , ``clear`` , ``toString`` -- Methods inherited from class `java.util.AbstractList `__ : ``add`` , ``get`` , ``set`` , ``add`` , ``remove`` , ``indexOf`` , ``lastIndexOf`` , ``clear`` , ``addAll`` , ``iterator`` , ``listIterator`` , ``listIterator`` , ``subList`` , ``equals`` , ``hashCode`` , ``removeRange`` -- Methods inherited from class **io.realm.OrderedRealmCollectionImpl**: ``isValid`` , ``isManaged`` , ``contains`` , ``get`` , ``first`` , ``first`` , ``last`` , ``last`` , ``deleteFromRealm`` , ``deleteAllFromRealm`` , ``iterator`` , ``listIterator`` , ``listIterator`` , ``sort`` , ``sort`` , ``sort`` , ``sort`` , ``size`` , ``min`` , ``minDate`` , ``max`` , ``maxDate`` , ``sum`` , ``average`` , ``remove`` , ``remove`` , ``removeAll`` , ``set`` , ``retainAll`` , ``deleteLastFromRealm`` , ``deleteFirstFromRealm`` , ``clear`` , ``add`` , ``add`` , ``addAll`` , ``addAll`` , ``createSnapshot`` , ``getRealm`` +- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` +- Methods inherited from class `java.util.AbstractCollection `__ : ``iterator`` , ``size`` , ``isEmpty`` , ``contains`` , ``toArray`` , ``toArray`` , ``add`` , ``remove`` , ``containsAll`` , ``addAll`` , ``removeAll`` , ``retainAll`` , ``clear`` , ``toString`` +- Methods inherited from class `java.util.AbstractList `__ : ``add`` , ``get`` , ``set`` , ``add`` , ``remove`` , ``indexOf`` , ``lastIndexOf`` , ``clear`` , ``addAll`` , ``iterator`` , ``listIterator`` , ``listIterator`` , ``subList`` , ``equals`` , ``hashCode`` , ``removeRange`` +- Methods inherited from class **io.realm.OrderedRealmCollectionImpl**: ``isValid`` , ``isManaged`` , ``contains`` , ``get`` , ``first`` , ``first`` , ``last`` , ``last`` , ``deleteFromRealm`` , ``deleteAllFromRealm`` , ``iterator`` , ``listIterator`` , ``listIterator`` , ``sort`` , ``sort`` , ``sort`` , ``sort`` , ``size`` , ``min`` , ``minDate`` , ``max`` , ``maxDate`` , ``sum`` , ``average`` , ``remove`` , ``remove`` , ``removeAll`` , ``set`` , ``retainAll`` , ``deleteLastFromRealm`` , ``deleteFirstFromRealm`` , ``clear`` , ``add`` , ``add`` , ``addAll`` , ``addAll`` , ``createSnapshot`` , ``getRealm`` , ``getCollectionOperator`` @@ -561,13 +579,13 @@ addChangeListener **Throws** - - `IllegalArgumentException `__ - if the change listener is ``null`` . + - `IllegalArgumentException `__ - if the change listener is ``null`` . - - `IllegalStateException `__ - if you try to add a listener from a non-Looper or `android.app.IntentService `__ thread. + - `IllegalStateException `__ - if you try to add a listener from a non-Looper or `android.app.IntentService `__ thread. @@ -653,13 +671,13 @@ addChangeListener **Throws** - - `IllegalArgumentException `__ - if the change listener is ``null`` . + - `IllegalArgumentException `__ - if the change listener is ``null`` . - - `IllegalStateException `__ - if you try to add a listener from a non-Looper or `android.app.IntentService `__ thread. + - `IllegalStateException `__ - if you try to add a listener from a non-Looper or `android.app.IntentService `__ thread. @@ -745,11 +763,11 @@ asChangesetObservable **Throws** - - `UnsupportedOperationException `__ - if the required RxJava framework is not on the classpath or the corresponding Realm instance doesn't support RxJava. + - `UnsupportedOperationException `__ - if the required RxJava framework is not on the classpath or the corresponding Realm instance doesn't support RxJava. - - `IllegalStateException `__ - if the Realm wasn't opened on a Looper thread. + - `IllegalStateException `__ - if the Realm wasn't opened on a Looper thread. @@ -763,7 +781,7 @@ asChangesetObservable - - `RxJava and Realm `__ + - `RxJava and Realm `__ @@ -862,11 +880,11 @@ asFlowable **Throws** - - `UnsupportedOperationException `__ - if the required RxJava framework is not on the classpath or the corresponding Realm instance doesn't support RxJava. + - `UnsupportedOperationException `__ - if the required RxJava framework is not on the classpath or the corresponding Realm instance doesn't support RxJava. - - `IllegalStateException `__ - if the Realm wasn't opened on a Looper thread. + - `IllegalStateException `__ - if the Realm wasn't opened on a Looper thread. @@ -880,7 +898,7 @@ asFlowable - - `RxJava and Realm `__ + - `RxJava and Realm `__ @@ -914,7 +932,7 @@ asJSON .. list-table:: :header-rows: 1 - * - | public `String `__ :ref:`asJSON ` () + * - | public `String `__ :ref:`asJSON ` () | @@ -971,15 +989,7 @@ freeze - * - Returns a frozen snapshot of this collection. The frozen copy can be read and queried from any thread without throwing an `IllegalStateException `__ . - - Freezing a collection also creates a Realm which has its own lifecycle, but if the live Realm that spawned the original collection is fully closed (i.e. all instances across all threads are closed), the frozen Realm and this collection will be closed as well. - - Frozen collections can be queried as normal, but trying to mutate it in any way or attempting to register a listener will throw an `IllegalStateException `__ . - - - - Note: Keeping a large number of frozen collections with different versions alive can have a negative impact on the filesize of the Realm. In order to avoid such a situation, it is possible to set :ref:`RealmConfiguration.Builder.maxNumberOfActiveVersions(long) ` . + * - @@ -990,13 +1000,6 @@ freeze - **Returns** - - a frozen copy of this collection. - - - - @@ -1030,17 +1033,12 @@ isFrozen - * - Returns whether or not this object is frozen. - + * - - **Returns** - - ``true`` if the object is frozen, ``false`` if it is not. - @@ -1192,7 +1190,7 @@ removeAllChangeListeners **Throws** - - `IllegalStateException `__ - if you try to remove listeners from a non-Looper Thread. + - `IllegalStateException `__ - if you try to remove listeners from a non-Looper Thread. @@ -1279,13 +1277,13 @@ removeChangeListener **Throws** - - `IllegalArgumentException `__ - if the change listener is ``null`` . + - `IllegalArgumentException `__ - if the change listener is ``null`` . - - `IllegalStateException `__ - if you try to remove a listener from a non-Looper Thread. + - `IllegalStateException `__ - if you try to remove a listener from a non-Looper Thread. @@ -1353,13 +1351,13 @@ removeChangeListener **Throws** - - `IllegalArgumentException `__ - if the change listener is ``null`` . + - `IllegalArgumentException `__ - if the change listener is ``null`` . - - `IllegalStateException `__ - if you try to remove a listener from a non-Looper Thread. + - `IllegalStateException `__ - if you try to remove a listener from a non-Looper Thread. @@ -1457,7 +1455,7 @@ setBlob :header-rows: 1 * - | public **void** :ref:`setBlob ` ( - | `String `__ fieldName, + | `String `__ fieldName, | **byte[]** value | ) @@ -1487,7 +1485,7 @@ setBlob **Throws** - - `IllegalArgumentException `__ - if field name doesn't exist, is a primary key property or isn't a binary field. + - `IllegalArgumentException `__ - if field name doesn't exist, is a primary key property or isn't a binary field. @@ -1545,7 +1543,7 @@ setBoolean :header-rows: 1 * - | public **void** :ref:`setBoolean ` ( - | `String `__ fieldName, + | `String `__ fieldName, | **boolean** value | ) @@ -1577,7 +1575,7 @@ setBoolean **Throws** - - `IllegalArgumentException `__ - if field name doesn't exist, is a primary key property or isn't a boolean field. + - `IllegalArgumentException `__ - if field name doesn't exist, is a primary key property or isn't a boolean field. @@ -1635,7 +1633,7 @@ setByte :header-rows: 1 * - | public **void** :ref:`setByte ` ( - | `String `__ fieldName, + | `String `__ fieldName, | **byte** value | ) @@ -1667,7 +1665,7 @@ setByte **Throws** - - `IllegalArgumentException `__ - if field name doesn't exist, is a primary key property or isn't a byte field. + - `IllegalArgumentException `__ - if field name doesn't exist, is a primary key property or isn't a byte field. @@ -1749,8 +1747,8 @@ setDate :header-rows: 1 * - | public **void** :ref:`setDate ` ( - | `String `__ fieldName, - | `Date `__ value + | `String `__ fieldName, + | `Date `__ value | ) @@ -1781,7 +1779,7 @@ setDate **Throws** - - `IllegalArgumentException `__ - if field name doesn't exist, is a primary key property or isn't a ``Date`` field. + - `IllegalArgumentException `__ - if field name doesn't exist, is a primary key property or isn't a ``Date`` field. @@ -1841,7 +1839,7 @@ setDecimal128 :header-rows: 1 * - | public **void** :ref:`setDecimal128 ` ( - | `String `__ fieldName, + | `String `__ fieldName, | **Decimal128** value | ) @@ -1873,7 +1871,7 @@ setDecimal128 **Throws** - - `IllegalArgumentException `__ - if field name doesn't exist, is a primary key property or isn't a ``Decimal128`` field. + - `IllegalArgumentException `__ - if field name doesn't exist, is a primary key property or isn't a ``Decimal128`` field. @@ -1933,7 +1931,7 @@ setDouble :header-rows: 1 * - | public **void** :ref:`setDouble ` ( - | `String `__ fieldName, + | `String `__ fieldName, | **double** value | ) @@ -1965,7 +1963,7 @@ setDouble **Throws** - - `IllegalArgumentException `__ - if field name doesn't exist, is a primary key property or isn't a double field. + - `IllegalArgumentException `__ - if field name doesn't exist, is a primary key property or isn't a double field. @@ -2023,7 +2021,7 @@ setFloat :header-rows: 1 * - | public **void** :ref:`setFloat ` ( - | `String `__ fieldName, + | `String `__ fieldName, | **float** value | ) @@ -2055,7 +2053,7 @@ setFloat **Throws** - - `IllegalArgumentException `__ - if field name doesn't exist, is a primary key property or isn't a float field. + - `IllegalArgumentException `__ - if field name doesn't exist, is a primary key property or isn't a float field. @@ -2113,7 +2111,7 @@ setInt :header-rows: 1 * - | public **void** :ref:`setInt ` ( - | `String `__ fieldName, + | `String `__ fieldName, | **int** value | ) @@ -2145,7 +2143,7 @@ setInt **Throws** - - `IllegalArgumentException `__ - if field name doesn't exist, is a primary key property or isn't an integer field. + - `IllegalArgumentException `__ - if field name doesn't exist, is a primary key property or isn't an integer field. @@ -2229,7 +2227,7 @@ setList :header-rows: 1 * - | public **void** :ref:`setList ` <**T** >( - | `String `__ fieldName, + | `String `__ fieldName, | :ref:`io.realm.RealmList\ ` list | ) @@ -2259,7 +2257,7 @@ setList **Throws** - - `IllegalArgumentException `__ - if field name doesn't exist, isn't a RealmList field , if the objects in the list are not managed or the type of the objects in the list are wrong. + - `IllegalArgumentException `__ - if field name doesn't exist, isn't a RealmList field , if the objects in the list are not managed or the type of the objects in the list are wrong. @@ -2317,7 +2315,7 @@ setLong :header-rows: 1 * - | public **void** :ref:`setLong ` ( - | `String `__ fieldName, + | `String `__ fieldName, | **long** value | ) @@ -2349,7 +2347,7 @@ setLong **Throws** - - `IllegalArgumentException `__ - if field name doesn't exist, is a primary key property or isn't a long field. + - `IllegalArgumentException `__ - if field name doesn't exist, is a primary key property or isn't a long field. @@ -2395,7 +2393,7 @@ setNull :header-rows: 1 * - | public **void** :ref:`setNull ` ( - | `String `__ fieldName + | `String `__ fieldName | ) @@ -2422,11 +2420,11 @@ setNull **Throws** - - `IllegalArgumentException `__ - if field name doesn't exist or is a primary key property. + - `IllegalArgumentException `__ - if field name doesn't exist or is a primary key property. - - `IllegalStateException `__ - if the field cannot hold ``null`` values. + - `IllegalStateException `__ - if the field cannot hold ``null`` values. @@ -2510,7 +2508,7 @@ setObject :header-rows: 1 * - | public **void** :ref:`setObject ` ( - | `String `__ fieldName, + | `String `__ fieldName, | :ref:`RealmModel ` value | ) @@ -2540,7 +2538,7 @@ setObject **Throws** - - `IllegalArgumentException `__ - if field name doesn't exist, is a primary key property or isn't an Object reference field. + - `IllegalArgumentException `__ - if field name doesn't exist, is a primary key property or isn't an Object reference field. @@ -2598,7 +2596,7 @@ setObjectId :header-rows: 1 * - | public **void** :ref:`setObjectId ` ( - | `String `__ fieldName, + | `String `__ fieldName, | **ObjectId** value | ) @@ -2630,7 +2628,7 @@ setObjectId **Throws** - - `IllegalArgumentException `__ - if field name doesn't exist, is a primary key property or isn't a ``ObjectId`` field. + - `IllegalArgumentException `__ - if field name doesn't exist, is a primary key property or isn't a ``ObjectId`` field. @@ -2690,7 +2688,7 @@ setShort :header-rows: 1 * - | public **void** :ref:`setShort ` ( - | `String `__ fieldName, + | `String `__ fieldName, | **short** value | ) @@ -2722,7 +2720,7 @@ setShort **Throws** - - `IllegalArgumentException `__ - if field name doesn't exist, is a primary key property or isn't a short field. + - `IllegalArgumentException `__ - if field name doesn't exist, is a primary key property or isn't a short field. @@ -2804,8 +2802,8 @@ setString :header-rows: 1 * - | public **void** :ref:`setString ` ( - | `String `__ fieldName, - | `String `__ value + | `String `__ fieldName, + | `String `__ value | ) @@ -2836,7 +2834,123 @@ setString **Throws** - - `IllegalArgumentException `__ - if field name doesn't exist, is a primary key property or isn't a String field. + - `IllegalArgumentException `__ - if field name doesn't exist, is a primary key property or isn't a String field. + + + + + + + + + + + + +.. _setUUID: + +.. _setUUID__: + +.. _RealmResults_setUUID: + +.. _RealmResults_setUUID__: + +.. _io_realm_RealmResults_setUUID: + +.. _io_realm_RealmResults_setUUID__: + + + +setUUID +------- + +.. _io_realm_RealmResults_setUUID_java_lang_String_java_util_UUID_: + +.. _io_realm_RealmResults_setUUID_java_lang_String__java_util_UUID_: + +.. _io_realm_RealmResults_setUUID_java_lang_String_UUID_: + +.. _io_realm_RealmResults_setUUID_java_lang_String__UUID_: + +.. _io_realm_RealmResults_setUUID_String_java_util_UUID_: + +.. _io_realm_RealmResults_setUUID_String__java_util_UUID_: + +.. _io_realm_RealmResults_setUUID_String_UUID_: + +.. _io_realm_RealmResults_setUUID_String__UUID_: + +.. _setUUID_java_lang_String_java_util_UUID_: + +.. _setUUID_java_lang_String__java_util_UUID_: + +.. _setUUID_java_lang_String_UUID_: + +.. _setUUID_java_lang_String__UUID_: + +.. _setUUID_String_java_util_UUID_: + +.. _setUUID_String__java_util_UUID_: + +.. _setUUID_String_UUID_: + +.. _setUUID_String__UUID_: + +.. _RealmResults_setUUID_java_lang_String_java_util_UUID_: + +.. _RealmResults_setUUID_java_lang_String__java_util_UUID_: + +.. _RealmResults_setUUID_java_lang_String_UUID_: + +.. _RealmResults_setUUID_java_lang_String__UUID_: + +.. _RealmResults_setUUID_String_java_util_UUID_: + +.. _RealmResults_setUUID_String__java_util_UUID_: + +.. _RealmResults_setUUID_String_UUID_: + +.. _RealmResults_setUUID_String__UUID_: + +.. list-table:: + :header-rows: 1 + + * - | public **void** :ref:`setUUID ` ( + | `String `__ fieldName, + | `UUID `__ value + | ) + + + + + * - Sets the ``UUID`` value of the given field in all of the objects in the collection. + + + + + + + **Parameters** + + - ``fieldName`` - name of the field to update. + + + + - ``value`` - new value for the field. + + + + + + + + + + **Throws** + + - `IllegalArgumentException `__ - if field name doesn't exist, is a primary key property or isn't a ``UUID`` field. + + @@ -2918,8 +3032,8 @@ setValue :header-rows: 1 * - | public **void** :ref:`setValue ` ( - | `String `__ fieldName, - | `Object `__ value + | `String `__ fieldName, + | `Object `__ value | ) @@ -2958,7 +3072,7 @@ setValue **Throws** - - `IllegalArgumentException `__ - if the field could not be found, could not be updated or the argument didn't match the field type or could not be converted to match the underlying field type. + - `IllegalArgumentException `__ - if the field could not be found, could not be updated or the argument didn't match the field type or could not be converted to match the underlying field type. @@ -3184,9 +3298,9 @@ sort :header-rows: 1 * - | public :ref:`RealmResults ` :ref:`sort ` ( - | `String `__ fieldName1, + | `String `__ fieldName1, | :ref:`Sort ` sortOrder1, - | `String `__ fieldName2, + | `String `__ fieldName2, | :ref:`Sort ` sortOrder2 | ) diff --git a/source/sdk/java/api/io/realm/RealmSchema.txt b/source/sdk/java/api/io/realm/RealmSchema.txt index a9dec5825b..7b7e8b09f6 100644 --- a/source/sdk/java/api/io/realm/RealmSchema.txt +++ b/source/sdk/java/api/io/realm/RealmSchema.txt @@ -18,7 +18,7 @@ io.realm ======== - | `java.lang.Object `__ + | `java.lang.Object `__ | io.realm.RealmSchema @@ -56,7 +56,7 @@ Method Summary * - public **boolean** - | :ref:`contains ` ( - | `String `__ className + | `String `__ className | ) @@ -67,7 +67,7 @@ Method Summary * - public abstract :ref:`RealmObjectSchema ` - | :ref:`create ` ( - | `String `__ className + | `String `__ className | ) @@ -76,11 +76,21 @@ Method Summary + * - public **void** + - | :ref:`createKeyPathMapping ` () + | + + + Create the underlying keypath mapping. + + + + * - public abstract :ref:`RealmObjectSchema ` - | :ref:`createWithPrimaryKeyField ` ( - | `String `__ className, - | `String `__ primaryKeyFieldName, - | `java.lang.Class\ `__ fieldType, + | `String `__ className, + | `String `__ primaryKeyFieldName, + | `java.lang.Class\ `__ fieldType, | :ref:`io.realm.FieldAttribute[] ` attributes | ) @@ -92,7 +102,7 @@ Method Summary * - public abstract :ref:`RealmObjectSchema ` - | :ref:`get ` ( - | `String `__ className + | `String `__ className | ) @@ -103,7 +113,7 @@ Method Summary - * - public abstract `Set `__ + * - public abstract `Set `__ - | :ref:`getAll ` () | @@ -117,7 +127,7 @@ Method Summary * - protected final **ColumnInfo** - | :ref:`getColumnInfo ` ( - | `String `__ className + | `String `__ className | ) @@ -128,7 +138,7 @@ Method Summary * - public abstract **void** - | :ref:`remove ` ( - | `String `__ className + | `String `__ className | ) @@ -139,8 +149,8 @@ Method Summary * - public abstract :ref:`RealmObjectSchema ` - | :ref:`rename ` ( - | `String `__ oldClassName, - | `String `__ newClassName + | `String `__ oldClassName, + | `String `__ newClassName | ) @@ -157,7 +167,7 @@ Inherited Methods -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` +- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` @@ -198,7 +208,7 @@ contains :header-rows: 1 * - | public **boolean** :ref:`contains ` ( - | `String `__ className + | `String `__ className | ) @@ -268,7 +278,7 @@ create :header-rows: 1 * - | public abstract :ref:`RealmObjectSchema ` :ref:`create ` ( - | `String `__ className + | `String `__ className | ) @@ -298,7 +308,7 @@ create **Throws** - - `UnsupportedOperationException `__ - if this :ref:`RealmSchema ` is immutable. + - `UnsupportedOperationException `__ - if this :ref:`RealmSchema ` is immutable. @@ -313,6 +323,48 @@ create +.. _createKeyPathMapping: + +.. _createKeyPathMapping__: + +.. _RealmSchema_createKeyPathMapping: + +.. _RealmSchema_createKeyPathMapping__: + +.. _io_realm_RealmSchema_createKeyPathMapping: + +.. _io_realm_RealmSchema_createKeyPathMapping__: + + + +createKeyPathMapping +-------------------- + +.. list-table:: + :header-rows: 1 + + * - | public **void** :ref:`createKeyPathMapping ` () + | + + + + + * - Create the underlying keypath mapping. Should only be called by typed Realms. + + + + + + + + + + + + + + + .. _createWithPrimaryKeyField: .. _createWithPrimaryKeyField__: @@ -624,9 +676,9 @@ createWithPrimaryKeyField :header-rows: 1 * - | public abstract :ref:`RealmObjectSchema ` :ref:`createWithPrimaryKeyField ` ( - | `String `__ className, - | `String `__ primaryKeyFieldName, - | `java.lang.Class\ `__ fieldType, + | `String `__ className, + | `String `__ primaryKeyFieldName, + | `java.lang.Class\ `__ fieldType, | :ref:`io.realm.FieldAttribute[] ` attributes | ) @@ -673,7 +725,7 @@ createWithPrimaryKeyField **Throws** - - `UnsupportedOperationException `__ - if this :ref:`RealmSchema ` is immutable. + - `UnsupportedOperationException `__ - if this :ref:`RealmSchema ` is immutable. @@ -721,13 +773,13 @@ get :header-rows: 1 * - | public abstract :ref:`RealmObjectSchema ` :ref:`get ` ( - | `String `__ className + | `String `__ className | ) - * - Returns the :ref:`RealmObjectSchema ` for a given class. If this :ref:`RealmSchema ` is immutable, an immutable :ref:`RealmObjectSchema ` will be returned. Otherwise, it returns an mutable :ref:`RealmObjectSchema ` . + * - Returns the :ref:`RealmObjectSchema ` for a given class. If this :ref:`RealmSchema ` is immutable, an immutable :ref:`RealmObjectSchema ` will be returned. Otherwise, it returns a mutable :ref:`RealmObjectSchema ` . @@ -780,7 +832,7 @@ getAll .. list-table:: :header-rows: 1 - * - | public abstract `Set `__ :ref:`getAll ` () + * - | public abstract `Set `__ :ref:`getAll ` () | @@ -842,7 +894,7 @@ getColumnInfo :header-rows: 1 * - | protected final **ColumnInfo** :ref:`getColumnInfo ` ( - | `String `__ className + | `String `__ className | ) @@ -897,13 +949,13 @@ remove :header-rows: 1 * - | public abstract **void** :ref:`remove ` ( - | `String `__ className + | `String `__ className | ) - * - Removes a class from the Realm. All data will be removed. Removing a class while other classes point to it will throw an `IllegalStateException `__ . Removes those classes or fields first. + * - Removes a class from the Realm. All data will be removed. Removing a class while other classes point to it will throw an `IllegalStateException `__ . Removes those classes or fields first. @@ -924,7 +976,7 @@ remove **Throws** - - `UnsupportedOperationException `__ - if this :ref:`RealmSchema ` is immutable or of a synced Realm. + - `UnsupportedOperationException `__ - if this :ref:`RealmSchema ` is immutable or of a synced Realm. @@ -1008,8 +1060,8 @@ rename :header-rows: 1 * - | public abstract :ref:`RealmObjectSchema ` :ref:`rename ` ( - | `String `__ oldClassName, - | `String `__ newClassName + | `String `__ oldClassName, + | `String `__ newClassName | ) @@ -1043,7 +1095,7 @@ rename **Throws** - - `UnsupportedOperationException `__ - if this :ref:`RealmSchema ` is immutable or of a synced Realm. + - `UnsupportedOperationException `__ - if this :ref:`RealmSchema ` is immutable or of a synced Realm. diff --git a/source/sdk/java/api/io/realm/RealmSet.txt b/source/sdk/java/api/io/realm/RealmSet.txt new file mode 100644 index 0000000000..4575cab8f9 --- /dev/null +++ b/source/sdk/java/api/io/realm/RealmSet.txt @@ -0,0 +1,2721 @@ + +.. contents:: On this page + :local: + :backlinks: none + :depth: 2 + :class: singlecol + + + +Class RealmSet +^^^^^^^^^^^^^^ + +.. _io_realm_RealmSet: + + + +io.realm +======== + + + | `java.lang.Object `__ + | io.realm.RealmSet + + +**Implemented interfaces:** + + + +- `java.util.Set `__ +- :ref:`io.realm.RealmCollection ` +- `java.util.Collection `__ +- `java.lang.Iterable `__ +- `java.util.Collection `__ +- `java.lang.Iterable `__ + + +RealmSet is a collection that contains no duplicate elements.Similarly to :ref:`RealmList ` s, a RealmSet can operate in managed and unmanaged modes. In managed mode a RealmSet persists all its contents inside a Realm whereas in unmanaged mode it functions like a `HashSet `__ . + + + +Managed RealmSets can only be created by Realm and will automatically update their content whenever the underlying Realm is updated. Managed RealmSet can only be accessed using the getter that points to a RealmSet field of a :ref:`RealmObject ` . + + + +Unmanaged elements in this set can be added to a Realm using the :ref:`Realm.copyToRealm(Iterable, ImportFlag...) ` method. + + + +**Warning: **the following methods are not supported for classes containing set fields yet: + + + +- :ref:`Realm.insert(RealmModel) ` + + + + +- :ref:`Realm.insert(Collection) ` + + + + +- :ref:`Realm.insertOrUpdate(RealmModel) ` + + + + +- :ref:`Realm.insertOrUpdate(Collection) ` + + + + +- **Realm.createAllFromJson(Class, String)** + + + + +- :ref:`Realm.createAllFromJson(Class, JSONArray) ` + + + + +- **Realm.createAllFromJson(Class, InputStream)** + + + + +- **Realm.createObjectFromJson(Class, String)** + + + + +- :ref:`Realm.createObjectFromJson(Class, JSONObject) ` } + + + + +- **Realm.createObjectFromJson(Class, InputStream)**} + + + + +- **Realm.createOrUpdateAllFromJson(Class, String)** + + + + +- :ref:`Realm.createOrUpdateAllFromJson(Class, JSONArray) ` + + + + +- **Realm.createOrUpdateAllFromJson(Class, InputStream)** + + + + +- **Realm.createOrUpdateObjectFromJson(Class, String)** + + + + +- :ref:`Realm.createOrUpdateObjectFromJson(Class, JSONObject) ` + + + + +- **Realm.createOrUpdateObjectFromJson(Class, InputStream)** + + + + + + + + + +Constructors +============ + +.. list-table:: + :header-rows: 1 + + * - Constructor and Description + + * - | :ref:`RealmSet ` () + | + + + Instantiates a RealmSet in unmanaged mode. + + + + + * - | :ref:`RealmSet ` ( + | `java.util.Collection\ `__ collection + | ) + + + Instantiates a RealmSet in unmanaged mode with another collection. + + + + + * - | :ref:`RealmSet ` ( + | **BaseRealm** baseRealm, + | **OsSet** osSet, + | `java.lang.Class\ `__ valueClass + | ) + + + Instantiates a RealmSet in managed mode. + + + + + * - | :ref:`RealmSet ` ( + | **BaseRealm** baseRealm, + | **OsSet** osSet, + | `String `__ className + | ) + + + Instantiates a RealmSet in managed mode. + + + + + + + +Method Summary +============== + +.. list-table:: + :header-rows: 1 + + * - Modifier and Type + - Method and Description + + * - public **boolean** + - | :ref:`add ` ( + | **E** e + | ) + + + + + + + + + + * - public **boolean** + - | :ref:`addAll ` ( + | `java.util.Collection\ `__ c + | ) + + + + + + + + + + * - public **void** + - | :ref:`addChangeListener ` ( + | :ref:`io.realm.SetChangeListener\ ` listener + | ) + + + Adds a change listener to this :ref:`RealmSet ` . + + + + + + + * - public **void** + - | :ref:`addChangeListener ` ( + | :ref:`io.realm.RealmChangeListener\> ` listener + | ) + + + Adds a change listener to this :ref:`RealmSet ` . + + + + + + + * - public **double** + - | :ref:`average ` ( + | `String `__ fieldName + | ) + + + Returns the average of a given field. + + + + + * - public **void** + - | :ref:`clear ` () + | + + + + + + + + + + * - public **boolean** + - | :ref:`contains ` ( + | `Object `__ o + | ) + + + Tests whether this ``Collection`` contains the specified object. + + + + + + + * - public **boolean** + - | :ref:`containsAll ` ( + | `java.util.Collection\ `__ c + | ) + + + + + + + + + + * - public **boolean** + - | :ref:`deleteAllFromRealm ` () + | + + + This deletes all objects in the collection from the underlying Realm as well as from the collection. + + + + + * - public :ref:`RealmSet ` + - | :ref:`freeze ` () + | + + + + + + + + + + * - public `Class `__ + - | :ref:`getValueClass ` () + | + + + + + + + + * - public `String `__ + - | :ref:`getValueClassName ` () + | + + + + + + + + * - public **boolean** + - | :ref:`isEmpty ` () + | + + + + + + + + + + * - public **boolean** + - | :ref:`isFrozen ` () + | + + + + + + + + + + * - public **boolean** + - | :ref:`isLoaded ` () + | + + + Checks if a collection has finished loading its data yet. + + + + + * - public **boolean** + - | :ref:`isManaged ` () + | + + + Checks if the collection is managed by Realm. + + + + + * - public **boolean** + - | :ref:`isValid ` () + | + + + Checks if the collection is still valid to use, i.e., the :ref:`io.realm.Realm ` instance hasn't been closed. + + + + + + + * - public `Iterator `__ + - | :ref:`iterator ` () + | + + + + + + + + + + * - public **boolean** + - | :ref:`load ` () + | + + + Blocks the collection until all data are available. + + + + + * - public `Number `__ + - | :ref:`max ` ( + | `String `__ fieldName + | ) + + + Finds the maximum value of a field. + + + + + * - public `Date `__ + - | :ref:`maxDate ` ( + | `String `__ fieldName + | ) + + + Finds the maximum date. + + + + + * - public `Number `__ + - | :ref:`min ` ( + | `String `__ fieldName + | ) + + + Finds the minimum value of a field. + + + + + * - public `Date `__ + - | :ref:`minDate ` ( + | `String `__ fieldName + | ) + + + Finds the minimum date. + + + + + * - public **boolean** + - | :ref:`remove ` ( + | `Object `__ o + | ) + + + + + + + + + + * - public **boolean** + - | :ref:`removeAll ` ( + | `java.util.Collection\ `__ c + | ) + + + + + + + + + + * - public **void** + - | :ref:`removeAllChangeListeners ` () + | + + + Removes all user-defined change listeners. + + + + + * - public **void** + - | :ref:`removeChangeListener ` ( + | :ref:`io.realm.SetChangeListener\ ` listener + | ) + + + Removes the specified change listener. + + + + + * - public **void** + - | :ref:`removeChangeListener ` ( + | :ref:`io.realm.RealmChangeListener\> ` listener + | ) + + + Removes the specified change listener. + + + + + * - public **boolean** + - | :ref:`retainAll ` ( + | `java.util.Collection\ `__ c + | ) + + + + + + + + + + * - public **int** + - | :ref:`size ` () + | + + + + + + + + + + * - public `Number `__ + - | :ref:`sum ` ( + | `String `__ fieldName + | ) + + + Calculates the sum of a given field. + + + + + * - public **T** + - | :ref:`toArray ` <**T** >( + | **T[]** a + | ) + + + + + + + + + + * - public `Object `__ + - | :ref:`toArray ` () + | + + + + + + + + + + * - public :ref:`RealmQuery ` + - | :ref:`where ` () + | + + + Returns a RealmQuery, which can be used to query for specific objects of this class. + + + + + + + +Inherited Methods +================= + + + +- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` + + + + +Constructor Detail +================== + +.. _RealmSet: + +.. _RealmSet__: + +.. _io_realm_RealmSet: + +.. _io_realm_RealmSet__: + +.. list-table:: + :header-rows: 1 + + * - | public :ref:`RealmSet ` () + | + + + + + * - Instantiates a RealmSet in unmanaged mode. + + + + + + + + + + + +.. _RealmSet: + +.. _RealmSet__: + +.. _io_realm_RealmSet: + +.. _io_realm_RealmSet__: + +.. list-table:: + :header-rows: 1 + + * - | public :ref:`RealmSet ` ( + | `java.util.Collection\ `__ collection + | ) + + + + + * - Instantiates a RealmSet in unmanaged mode with another collection. + + + + + **Parameters** + + - ``collection`` - the collection with which the set will be initially populated. + + + + + + + + + + + + +.. _RealmSet: + +.. _RealmSet__: + +.. _io_realm_RealmSet: + +.. _io_realm_RealmSet__: + +.. list-table:: + :header-rows: 1 + + * - | public :ref:`RealmSet ` ( + | **BaseRealm** baseRealm, + | **OsSet** osSet, + | `java.lang.Class\ `__ valueClass + | ) + + + + + * - Instantiates a RealmSet in managed mode. This constructor is used internally by Realm. + + + + + **Parameters** + + - ``baseRealm`` - + + + + - ``osSet`` - + + + + - ``valueClass`` - + + + + + + + + + + + + +.. _RealmSet: + +.. _RealmSet__: + +.. _io_realm_RealmSet: + +.. _io_realm_RealmSet__: + +.. list-table:: + :header-rows: 1 + + * - | public :ref:`RealmSet ` ( + | **BaseRealm** baseRealm, + | **OsSet** osSet, + | `String `__ className + | ) + + + + + * - Instantiates a RealmSet in managed mode. This constructor is used internally by a Dynamic Realm. + + + + + **Parameters** + + - ``baseRealm`` - + + + + - ``osSet`` - + + + + - ``className`` - + + + + + + + + + + + + + + +Method Detail +============= + +.. _add: + +.. _add__: + +.. _RealmSet_add: + +.. _RealmSet_add__: + +.. _io_realm_RealmSet_add: + +.. _io_realm_RealmSet_add__: + + + +add +---- + +.. _io_realm_RealmSet_add_E_: + +.. _add_E_: + +.. _RealmSet_add_E_: + +.. list-table:: + :header-rows: 1 + + * - | public **boolean** :ref:`add ` ( + | **E** e + | ) + + + + + * - + + + + + + + + + + + + + + + + + +.. _addAll: + +.. _addAll__: + +.. _RealmSet_addAll: + +.. _RealmSet_addAll__: + +.. _io_realm_RealmSet_addAll: + +.. _io_realm_RealmSet_addAll__: + + + +addAll +------ + +.. _io_realm_RealmSet_addAll_java_util_Collection_: + +.. _io_realm_RealmSet_addAll_Collection_: + +.. _io_realm_RealmSet_addAll_Collection___extends_E__: + +.. _addAll_java_util_Collection_: + +.. _addAll_Collection_: + +.. _addAll_Collection___extends_E__: + +.. _RealmSet_addAll_java_util_Collection_: + +.. _RealmSet_addAll_Collection_: + +.. _RealmSet_addAll_Collection___extends_E__: + +.. list-table:: + :header-rows: 1 + + * - | public **boolean** :ref:`addAll ` ( + | `java.util.Collection\ `__ c + | ) + + + + + * - + + + + + + + + + + + + + + + + + +.. _addChangeListener: + +.. _addChangeListener__: + +.. _RealmSet_addChangeListener: + +.. _RealmSet_addChangeListener__: + +.. _io_realm_RealmSet_addChangeListener: + +.. _io_realm_RealmSet_addChangeListener__: + + + +addChangeListener +----------------- + +.. _io_realm_RealmSet_addChangeListener_io_realm_SetChangeListener_: + +.. _io_realm_RealmSet_addChangeListener_SetChangeListener_: + +.. _addChangeListener_io_realm_SetChangeListener_: + +.. _addChangeListener_SetChangeListener_: + +.. _RealmSet_addChangeListener_io_realm_SetChangeListener_: + +.. _RealmSet_addChangeListener_SetChangeListener_: + +.. _io_realm_RealmSet_addChangeListener_SetChangeListener_E__: + +.. list-table:: + :header-rows: 1 + + * - | public **void** :ref:`addChangeListener ` ( + | :ref:`io.realm.SetChangeListener\ ` listener + | ) + + + + + * - Adds a change listener to this :ref:`RealmSet ` . + + Registering a change listener will not prevent the underlying RealmSet from being garbage collected. If the RealmSet 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. + + + + .. code-block:: java + + + public class MyActivity extends Activity { + + private RealmSet dogs; // Strong reference to keep listeners alive + + @Override + protected void onCreate(Bundle savedInstanceState) { + super.onCreate(savedInstanceState); + dogs = realm.where(Person.class).findFirst().getDogs(); + dogs.addChangeListener(new SetChangeListener() { + @Override + public void onChange(RealmSet set, SetChangeSet changeSet) { + // React to change + } + }); + } + } + + + + + + + + + + + **Parameters** + + - ``listener`` - the 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 `android.app.IntentService `__ thread. + + + + + + + + + + + + +.. _io_realm_RealmSet_addChangeListener_io_realm_RealmChangeListener_: + +.. _io_realm_RealmSet_addChangeListener_RealmChangeListener_: + +.. _addChangeListener_io_realm_RealmChangeListener_: + +.. _addChangeListener_RealmChangeListener_: + +.. _RealmSet_addChangeListener_io_realm_RealmChangeListener_: + +.. _RealmSet_addChangeListener_RealmChangeListener_: + +.. _io_realm_RealmSet_addChangeListener_RealmChangeListener_RealmSet_E___: + +.. list-table:: + :header-rows: 1 + + * - | public **void** :ref:`addChangeListener ` ( + | :ref:`io.realm.RealmChangeListener\> ` listener + | ) + + + + + * - Adds a change listener to this :ref:`RealmSet ` . + + Registering a change listener will not prevent the underlying RealmSet from being garbage collected. If the RealmSet 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. + + + + .. code-block:: java + + + public class MyActivity extends Activity { + + private RealmSet dogs; // Strong reference to keep listeners alive + + @Override + protected void onCreate(Bundle savedInstanceState) { + super.onCreate(savedInstanceState); + dogs = realm.where(Person.class).findFirst().getDogs(); + dogs.addChangeListener(new RealmChangeListener>() { + @Override + public void onChange(RealmSet map) { + // React to change + } + }); + } + } + + + + + + + + + + + **Parameters** + + - ``listener`` - the 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 `android.app.IntentService `__ thread. + + + + + + + + + + + + + + +.. _average: + +.. _average__: + +.. _RealmSet_average: + +.. _RealmSet_average__: + +.. _io_realm_RealmSet_average: + +.. _io_realm_RealmSet_average__: + + + +average +------- + +.. _io_realm_RealmSet_average_java_lang_String_: + +.. _io_realm_RealmSet_average_String_: + +.. _average_java_lang_String_: + +.. _average_String_: + +.. _RealmSet_average_java_lang_String_: + +.. _RealmSet_average_String_: + +.. list-table:: + :header-rows: 1 + + * - | public **double** :ref:`average ` ( + | `String `__ fieldName + | ) + + + + + * - Returns the average of a given field. + + + + + + + **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. + + + + + + + + + + + + + +.. _clear: + +.. _clear__: + +.. _RealmSet_clear: + +.. _RealmSet_clear__: + +.. _io_realm_RealmSet_clear: + +.. _io_realm_RealmSet_clear__: + + + +clear +----- + +.. list-table:: + :header-rows: 1 + + * - | public **void** :ref:`clear ` () + | + + + + + * - + + + + + + + + + + + + + + + + + +.. _contains: + +.. _contains__: + +.. _RealmSet_contains: + +.. _RealmSet_contains__: + +.. _io_realm_RealmSet_contains: + +.. _io_realm_RealmSet_contains__: + + + +contains +-------- + +.. _io_realm_RealmSet_contains_java_lang_Object_: + +.. _io_realm_RealmSet_contains_Object_: + +.. _contains_java_lang_Object_: + +.. _contains_Object_: + +.. _RealmSet_contains_java_lang_Object_: + +.. _RealmSet_contains_Object_: + +.. list-table:: + :header-rows: 1 + + * - | public **boolean** :ref:`contains ` ( + | `Object `__ o + | ) + + + + + * - Tests whether this ``Collection`` contains the specified object. Returns ``true`` if and only if at least one element ``elem`` in this ``Collection`` meets following requirement: ``(object==null ? elem==null : object.equals(elem))`` . + + + + + + + + + **Returns** + + ``true`` if object is an element of this ``Collection`` , ``false`` otherwise. + + + + + + + + + + + + + +.. _containsAll: + +.. _containsAll__: + +.. _RealmSet_containsAll: + +.. _RealmSet_containsAll__: + +.. _io_realm_RealmSet_containsAll: + +.. _io_realm_RealmSet_containsAll__: + + + +containsAll +----------- + +.. _io_realm_RealmSet_containsAll_java_util_Collection_: + +.. _io_realm_RealmSet_containsAll_Collection_: + +.. _containsAll_java_util_Collection_: + +.. _containsAll_Collection_: + +.. _RealmSet_containsAll_java_util_Collection_: + +.. _RealmSet_containsAll_Collection_: + +.. _io_realm_RealmSet_containsAll_Collection____: + +.. list-table:: + :header-rows: 1 + + * - | public **boolean** :ref:`containsAll ` ( + | `java.util.Collection\ `__ c + | ) + + + + + * - + + + + + + + + + + + + + + + + + +.. _deleteAllFromRealm: + +.. _deleteAllFromRealm__: + +.. _RealmSet_deleteAllFromRealm: + +.. _RealmSet_deleteAllFromRealm__: + +.. _io_realm_RealmSet_deleteAllFromRealm: + +.. _io_realm_RealmSet_deleteAllFromRealm__: + + + +deleteAllFromRealm +------------------ + +.. list-table:: + :header-rows: 1 + + * - | public **boolean** :ref:`deleteAllFromRealm ` () + | + + + + + * - This deletes all objects in the collection from the underlying Realm as well as from the collection. + + + + + + + **Returns** + + ``true`` if objects was deleted, ``false`` otherwise. + + + + + + + + + + + + + +.. _freeze: + +.. _freeze__: + +.. _RealmSet_freeze: + +.. _RealmSet_freeze__: + +.. _io_realm_RealmSet_freeze: + +.. _io_realm_RealmSet_freeze__: + + + +freeze +------ + +.. list-table:: + :header-rows: 1 + + * - | public :ref:`RealmSet ` :ref:`freeze ` () + | + + + + + * - + + + + + + + + + + + + + + + + + +.. _getValueClass: + +.. _getValueClass__: + +.. _RealmSet_getValueClass: + +.. _RealmSet_getValueClass__: + +.. _io_realm_RealmSet_getValueClass: + +.. _io_realm_RealmSet_getValueClass__: + + + +getValueClass +------------- + +.. list-table:: + :header-rows: 1 + + * - | public `Class `__ :ref:`getValueClass ` () + | + + + + + * - + + + + + + + + + + + + + + + +.. _getValueClassName: + +.. _getValueClassName__: + +.. _RealmSet_getValueClassName: + +.. _RealmSet_getValueClassName__: + +.. _io_realm_RealmSet_getValueClassName: + +.. _io_realm_RealmSet_getValueClassName__: + + + +getValueClassName +----------------- + +.. list-table:: + :header-rows: 1 + + * - | public `String `__ :ref:`getValueClassName ` () + | + + + + + * - + + + + + + + + + + + + + + + +.. _isEmpty: + +.. _isEmpty__: + +.. _RealmSet_isEmpty: + +.. _RealmSet_isEmpty__: + +.. _io_realm_RealmSet_isEmpty: + +.. _io_realm_RealmSet_isEmpty__: + + + +isEmpty +------- + +.. list-table:: + :header-rows: 1 + + * - | public **boolean** :ref:`isEmpty ` () + | + + + + + * - + + + + + + + + + + + + + + + + + +.. _isFrozen: + +.. _isFrozen__: + +.. _RealmSet_isFrozen: + +.. _RealmSet_isFrozen__: + +.. _io_realm_RealmSet_isFrozen: + +.. _io_realm_RealmSet_isFrozen__: + + + +isFrozen +-------- + +.. list-table:: + :header-rows: 1 + + * - | public **boolean** :ref:`isFrozen ` () + | + + + + + * - + + + + + + + + + + + + + + + + + +.. _isLoaded: + +.. _isLoaded__: + +.. _RealmSet_isLoaded: + +.. _RealmSet_isLoaded__: + +.. _io_realm_RealmSet_isLoaded: + +.. _io_realm_RealmSet_isLoaded__: + + + +isLoaded +-------- + +.. list-table:: + :header-rows: 1 + + * - | public **boolean** :ref:`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. + + + + + + + + + + + + + +.. _isManaged: + +.. _isManaged__: + +.. _RealmSet_isManaged: + +.. _RealmSet_isManaged__: + +.. _io_realm_RealmSet_isManaged: + +.. _io_realm_RealmSet_isManaged__: + + + +isManaged +--------- + +.. list-table:: + :header-rows: 1 + + * - | public **boolean** :ref:`isManaged ` () + | + + + + + * - Checks if the collection is managed by Realm. A managed collection is just a wrapper around the data in the underlying Realm file. On Looper threads, a managed collection will be live-updated so it always points to the latest data. Managed collections are thread confined so that they cannot be accessed from other threads than the one that created them.If this method returns ``false`` , the collection is unmanaged. An unmanaged collection is just a normal java collection, so it will not be live updated. + + + + + + + + + + + **Returns** + + ``true`` if this is a managed :ref:`RealmCollection ` , ``false`` otherwise. + + + + + + + + + + + + + +.. _isValid: + +.. _isValid__: + +.. _RealmSet_isValid: + +.. _RealmSet_isValid__: + +.. _io_realm_RealmSet_isValid: + +.. _io_realm_RealmSet_isValid__: + + + +isValid +------- + +.. list-table:: + :header-rows: 1 + + * - | public **boolean** :ref:`isValid ` () + | + + + + + * - Checks if the collection is still valid to use, i.e., the :ref:`io.realm.Realm ` instance hasn't been closed. It will always return ``true`` for an unmanaged collection. + + + + + + + + + **Returns** + + ``true`` if it is still valid to use or an unmanaged collection, ``false`` otherwise. + + + + + + + + + + + + + +.. _iterator: + +.. _iterator__: + +.. _RealmSet_iterator: + +.. _RealmSet_iterator__: + +.. _io_realm_RealmSet_iterator: + +.. _io_realm_RealmSet_iterator__: + + + +iterator +-------- + +.. list-table:: + :header-rows: 1 + + * - | public `Iterator `__ :ref:`iterator ` () + | + + + + + * - + + + + + + + + + + + + + + + + + +.. _load: + +.. _load__: + +.. _RealmSet_load: + +.. _RealmSet_load__: + +.. _io_realm_RealmSet_load: + +.. _io_realm_RealmSet_load__: + + + +load +---- + +.. list-table:: + :header-rows: 1 + + * - | public **boolean** :ref:`load ` () + | + + + + + * - Blocks the collection until all data are available. + + + + + + + **Returns** + + ``true`` if the data could be successfully loaded, ``false`` otherwise. + + + + + + + + + + + + + +.. _max: + +.. _max__: + +.. _RealmSet_max: + +.. _RealmSet_max__: + +.. _io_realm_RealmSet_max: + +.. _io_realm_RealmSet_max__: + + + +max +---- + +.. _io_realm_RealmSet_max_java_lang_String_: + +.. _io_realm_RealmSet_max_String_: + +.. _max_java_lang_String_: + +.. _max_String_: + +.. _RealmSet_max_java_lang_String_: + +.. _RealmSet_max_String_: + +.. list-table:: + :header-rows: 1 + + * - | public `Number `__ :ref:`max ` ( + | `String `__ fieldName + | ) + + + + + * - Finds the maximum value of a field. + + + + + + + **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: + +.. _maxDate__: + +.. _RealmSet_maxDate: + +.. _RealmSet_maxDate__: + +.. _io_realm_RealmSet_maxDate: + +.. _io_realm_RealmSet_maxDate__: + + + +maxDate +------- + +.. _io_realm_RealmSet_maxDate_java_lang_String_: + +.. _io_realm_RealmSet_maxDate_String_: + +.. _maxDate_java_lang_String_: + +.. _maxDate_String_: + +.. _RealmSet_maxDate_java_lang_String_: + +.. _RealmSet_maxDate_String_: + +.. list-table:: + :header-rows: 1 + + * - | public `Date `__ :ref:`maxDate ` ( + | `String `__ fieldName + | ) + + + + + * - Finds the maximum date. + + + + + + + **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. + + + + + + + + + + + + + +.. _min: + +.. _min__: + +.. _RealmSet_min: + +.. _RealmSet_min__: + +.. _io_realm_RealmSet_min: + +.. _io_realm_RealmSet_min__: + + + +min +---- + +.. _io_realm_RealmSet_min_java_lang_String_: + +.. _io_realm_RealmSet_min_String_: + +.. _min_java_lang_String_: + +.. _min_String_: + +.. _RealmSet_min_java_lang_String_: + +.. _RealmSet_min_String_: + +.. list-table:: + :header-rows: 1 + + * - | public `Number `__ :ref:`min ` ( + | `String `__ fieldName + | ) + + + + + * - Finds the minimum value of a field. + + + + + + + **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: + +.. _minDate__: + +.. _RealmSet_minDate: + +.. _RealmSet_minDate__: + +.. _io_realm_RealmSet_minDate: + +.. _io_realm_RealmSet_minDate__: + + + +minDate +------- + +.. _io_realm_RealmSet_minDate_java_lang_String_: + +.. _io_realm_RealmSet_minDate_String_: + +.. _minDate_java_lang_String_: + +.. _minDate_String_: + +.. _RealmSet_minDate_java_lang_String_: + +.. _RealmSet_minDate_String_: + +.. list-table:: + :header-rows: 1 + + * - | public `Date `__ :ref:`minDate ` ( + | `String `__ fieldName + | ) + + + + + * - Finds the minimum date. + + + + + + + **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. + + + + + + + + + + + + + +.. _remove: + +.. _remove__: + +.. _RealmSet_remove: + +.. _RealmSet_remove__: + +.. _io_realm_RealmSet_remove: + +.. _io_realm_RealmSet_remove__: + + + +remove +------ + +.. _io_realm_RealmSet_remove_java_lang_Object_: + +.. _io_realm_RealmSet_remove_Object_: + +.. _remove_java_lang_Object_: + +.. _remove_Object_: + +.. _RealmSet_remove_java_lang_Object_: + +.. _RealmSet_remove_Object_: + +.. list-table:: + :header-rows: 1 + + * - | public **boolean** :ref:`remove ` ( + | `Object `__ o + | ) + + + + + * - + + + + + + + + + + + + + + + + + +.. _removeAll: + +.. _removeAll__: + +.. _RealmSet_removeAll: + +.. _RealmSet_removeAll__: + +.. _io_realm_RealmSet_removeAll: + +.. _io_realm_RealmSet_removeAll__: + + + +removeAll +--------- + +.. _io_realm_RealmSet_removeAll_java_util_Collection_: + +.. _io_realm_RealmSet_removeAll_Collection_: + +.. _removeAll_java_util_Collection_: + +.. _removeAll_Collection_: + +.. _RealmSet_removeAll_java_util_Collection_: + +.. _RealmSet_removeAll_Collection_: + +.. _io_realm_RealmSet_removeAll_Collection____: + +.. list-table:: + :header-rows: 1 + + * - | public **boolean** :ref:`removeAll ` ( + | `java.util.Collection\ `__ c + | ) + + + + + * - + + + + + + + + + + + + + + + + + +.. _removeAllChangeListeners: + +.. _removeAllChangeListeners__: + +.. _RealmSet_removeAllChangeListeners: + +.. _RealmSet_removeAllChangeListeners__: + +.. _io_realm_RealmSet_removeAllChangeListeners: + +.. _io_realm_RealmSet_removeAllChangeListeners__: + + + +removeAllChangeListeners +------------------------ + +.. list-table:: + :header-rows: 1 + + * - | public **void** :ref:`removeAllChangeListeners ` () + | + + + + + * - Removes all user-defined change listeners. + + + + + + + + + **Throws** + + - `IllegalStateException `__ - if you try to remove listeners from a non-Looper Thread. + + + + + + + + + + .. seealso:: + + + + - :ref:`io.realm.RealmChangeListener ` + + + + + + + + + + + + +.. _removeChangeListener: + +.. _removeChangeListener__: + +.. _RealmSet_removeChangeListener: + +.. _RealmSet_removeChangeListener__: + +.. _io_realm_RealmSet_removeChangeListener: + +.. _io_realm_RealmSet_removeChangeListener__: + + + +removeChangeListener +-------------------- + +.. _io_realm_RealmSet_removeChangeListener_io_realm_SetChangeListener_: + +.. _io_realm_RealmSet_removeChangeListener_SetChangeListener_: + +.. _removeChangeListener_io_realm_SetChangeListener_: + +.. _removeChangeListener_SetChangeListener_: + +.. _RealmSet_removeChangeListener_io_realm_SetChangeListener_: + +.. _RealmSet_removeChangeListener_SetChangeListener_: + +.. _io_realm_RealmSet_removeChangeListener_SetChangeListener_E__: + +.. list-table:: + :header-rows: 1 + + * - | public **void** :ref:`removeChangeListener ` ( + | :ref:`io.realm.SetChangeListener\ ` 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. + + + + + + + + + + +.. _io_realm_RealmSet_removeChangeListener_io_realm_RealmChangeListener_: + +.. _io_realm_RealmSet_removeChangeListener_RealmChangeListener_: + +.. _removeChangeListener_io_realm_RealmChangeListener_: + +.. _removeChangeListener_RealmChangeListener_: + +.. _RealmSet_removeChangeListener_io_realm_RealmChangeListener_: + +.. _RealmSet_removeChangeListener_RealmChangeListener_: + +.. _io_realm_RealmSet_removeChangeListener_RealmChangeListener_RealmSet_E___: + +.. list-table:: + :header-rows: 1 + + * - | public **void** :ref:`removeChangeListener ` ( + | :ref:`io.realm.RealmChangeListener\> ` 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. + + + + + + + + + + + + +.. _retainAll: + +.. _retainAll__: + +.. _RealmSet_retainAll: + +.. _RealmSet_retainAll__: + +.. _io_realm_RealmSet_retainAll: + +.. _io_realm_RealmSet_retainAll__: + + + +retainAll +--------- + +.. _io_realm_RealmSet_retainAll_java_util_Collection_: + +.. _io_realm_RealmSet_retainAll_Collection_: + +.. _retainAll_java_util_Collection_: + +.. _retainAll_Collection_: + +.. _RealmSet_retainAll_java_util_Collection_: + +.. _RealmSet_retainAll_Collection_: + +.. _io_realm_RealmSet_retainAll_Collection____: + +.. list-table:: + :header-rows: 1 + + * - | public **boolean** :ref:`retainAll ` ( + | `java.util.Collection\ `__ c + | ) + + + + + * - + + + + + + + + + + + + + + + + + +.. _size: + +.. _size__: + +.. _RealmSet_size: + +.. _RealmSet_size__: + +.. _io_realm_RealmSet_size: + +.. _io_realm_RealmSet_size__: + + + +size +---- + +.. list-table:: + :header-rows: 1 + + * - | public **int** :ref:`size ` () + | + + + + + * - + + + + + + + + + + + + + + + + + +.. _sum: + +.. _sum__: + +.. _RealmSet_sum: + +.. _RealmSet_sum__: + +.. _io_realm_RealmSet_sum: + +.. _io_realm_RealmSet_sum__: + + + +sum +---- + +.. _io_realm_RealmSet_sum_java_lang_String_: + +.. _io_realm_RealmSet_sum_String_: + +.. _sum_java_lang_String_: + +.. _sum_String_: + +.. _RealmSet_sum_java_lang_String_: + +.. _RealmSet_sum_String_: + +.. list-table:: + :header-rows: 1 + + * - | public `Number `__ :ref:`sum ` ( + | `String `__ fieldName + | ) + + + + + * - Calculates the sum of a given field. + + + + + + + **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. + + + + + + + + + + + + + +.. _toArray: + +.. _toArray__: + +.. _RealmSet_toArray: + +.. _RealmSet_toArray__: + +.. _io_realm_RealmSet_toArray: + +.. _io_realm_RealmSet_toArray__: + + + +toArray +------- + +.. _io_realm_RealmSet_toArray_T_: + +.. _io_realm_RealmSet_toArray_T____: + +.. _toArray_T_: + +.. _toArray_T____: + +.. _RealmSet_toArray_T_: + +.. _RealmSet_toArray_T____: + +.. _io_realm_RealmSet_toArray_T[]_: + +.. list-table:: + :header-rows: 1 + + * - | public **T** :ref:`toArray ` <**T** >( + | **T[]** a + | ) + + + + + * - + + + + + + + + + + + + + + + +.. list-table:: + :header-rows: 1 + + * - | public `Object `__ :ref:`toArray ` () + | + + + + + * - + + + + + + + + + + + + + + + + + +.. _where: + +.. _where__: + +.. _RealmSet_where: + +.. _RealmSet_where__: + +.. _io_realm_RealmSet_where: + +.. _io_realm_RealmSet_where__: + + + +where +----- + +.. list-table:: + :header-rows: 1 + + * - | public :ref:`RealmQuery ` :ref:`where ` () + | + + + + + * - Returns a RealmQuery, which can be used to query for specific objects of this class. + + + + + + + **Returns** + + a RealmQuery object. + + + + + **Throws** + + - `IllegalStateException `__ - if Realm instance has been closed or parent object has been removed. + + + + + + + + + + .. seealso:: + + + + - :ref:`io.realm.RealmQuery ` + + + + + + + + + + + + + diff --git a/source/sdk/java/api/io/realm/SetChangeListener.txt b/source/sdk/java/api/io/realm/SetChangeListener.txt new file mode 100644 index 0000000000..dde9ee19e7 --- /dev/null +++ b/source/sdk/java/api/io/realm/SetChangeListener.txt @@ -0,0 +1,164 @@ + +.. contents:: On this page + :local: + :backlinks: none + :depth: 2 + :class: singlecol + + + +Interface SetChangeListener +^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. _io_realm_SetChangeListener: + + + +io.realm +======== + +:ref:`SetChangeListener ` can be registered with a :ref:`RealmSet ` to receive a notification with a :ref:`SetChangeSet ` to describe the details of what have been changed in the set since last time. + +Realm instances on a thread without an `android.os.Looper `__ cannot register a :ref:`SetChangeListener ` . + + + + + + +.. seealso:: + + + + - :ref:`RealmSet.addChangeListener(SetChangeListener) ` + + + + + + + + + +Method Summary +============== + +.. list-table:: + :header-rows: 1 + + * - Modifier and Type + - Method and Description + + * - public **void** + - | :ref:`onChange ` ( + | :ref:`io.realm.RealmSet\ ` set, + | :ref:`SetChangeSet ` changes + | ) + + + + + + + + + + +Method Detail +============= + +.. _onChange: + +.. _onChange__: + +.. _SetChangeListener_onChange: + +.. _SetChangeListener_onChange__: + +.. _io_realm_SetChangeListener_onChange: + +.. _io_realm_SetChangeListener_onChange__: + + + +onChange +-------- + +.. _io_realm_SetChangeListener_onChange_io_realm_RealmSet_io_realm_SetChangeSet_: + +.. _io_realm_SetChangeListener_onChange_io_realm_RealmSet__io_realm_SetChangeSet_: + +.. _io_realm_SetChangeListener_onChange_io_realm_RealmSet_SetChangeSet_: + +.. _io_realm_SetChangeListener_onChange_io_realm_RealmSet__SetChangeSet_: + +.. _io_realm_SetChangeListener_onChange_RealmSet_io_realm_SetChangeSet_: + +.. _io_realm_SetChangeListener_onChange_RealmSet__io_realm_SetChangeSet_: + +.. _io_realm_SetChangeListener_onChange_RealmSet_SetChangeSet_: + +.. _io_realm_SetChangeListener_onChange_RealmSet__SetChangeSet_: + +.. _onChange_io_realm_RealmSet_io_realm_SetChangeSet_: + +.. _onChange_io_realm_RealmSet__io_realm_SetChangeSet_: + +.. _onChange_io_realm_RealmSet_SetChangeSet_: + +.. _onChange_io_realm_RealmSet__SetChangeSet_: + +.. _onChange_RealmSet_io_realm_SetChangeSet_: + +.. _onChange_RealmSet__io_realm_SetChangeSet_: + +.. _onChange_RealmSet_SetChangeSet_: + +.. _onChange_RealmSet__SetChangeSet_: + +.. _SetChangeListener_onChange_io_realm_RealmSet_io_realm_SetChangeSet_: + +.. _SetChangeListener_onChange_io_realm_RealmSet__io_realm_SetChangeSet_: + +.. _SetChangeListener_onChange_io_realm_RealmSet_SetChangeSet_: + +.. _SetChangeListener_onChange_io_realm_RealmSet__SetChangeSet_: + +.. _SetChangeListener_onChange_RealmSet_io_realm_SetChangeSet_: + +.. _SetChangeListener_onChange_RealmSet__io_realm_SetChangeSet_: + +.. _SetChangeListener_onChange_RealmSet_SetChangeSet_: + +.. _SetChangeListener_onChange_RealmSet__SetChangeSet_: + +.. _io_realm_SetChangeListener_onChange_RealmSet_T___SetChangeSet_: + +.. list-table:: + :header-rows: 1 + + * - | public **void** :ref:`onChange ` ( + | :ref:`io.realm.RealmSet\ ` set, + | :ref:`SetChangeSet ` changes + | ) + + + + + * - + + + + + + + + + + + + + + + + diff --git a/source/sdk/java/api/io/realm/SetChangeSet.txt b/source/sdk/java/api/io/realm/SetChangeSet.txt new file mode 100644 index 0000000000..8a295d6735 --- /dev/null +++ b/source/sdk/java/api/io/realm/SetChangeSet.txt @@ -0,0 +1,284 @@ + +.. contents:: On this page + :local: + :backlinks: none + :depth: 2 + :class: singlecol + + + +Class SetChangeSet +^^^^^^^^^^^^^^^^^^ + +.. _io_realm_SetChangeSet: + + + +io.realm +======== + + + | `java.lang.Object `__ + | io.realm.SetChangeSet + + +This class describes the changes made to a set during the last update.:ref:`SetChangeSet ` is passed to the :ref:`SetChangeListener ` which is registered by :ref:`RealmSet.addChangeListener(SetChangeListener) ` . + + + + + + +Constructors +============ + +.. list-table:: + :header-rows: 1 + + * - Constructor and Description + + * - | :ref:`SetChangeSet ` ( + | **OsCollectionChangeSet** osCollectionChangeSet + | ) + + + + + + + + + + +Method Summary +============== + +.. list-table:: + :header-rows: 1 + + * - Modifier and Type + - Method and Description + + * - public **int** + - | :ref:`getNumberOfDeletions ` () + | + + + The number of entries that have been deleted + + + + + * - public **int** + - | :ref:`getNumberOfInsertions ` () + | + + + The number of entries that have been inserted. + + + + + * - public **boolean** + - | :ref:`isEmpty ` () + | + + + Whether the change set is empty or not. + + + + + + + +Inherited Methods +================= + + + +- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` + + + + +Constructor Detail +================== + +.. _SetChangeSet: + +.. _SetChangeSet__: + +.. _io_realm_SetChangeSet: + +.. _io_realm_SetChangeSet__: + +.. list-table:: + :header-rows: 1 + + * - | public :ref:`SetChangeSet ` ( + | **OsCollectionChangeSet** osCollectionChangeSet + | ) + + + + + * - + + + + + + + + + + + + + +Method Detail +============= + +.. _getNumberOfDeletions: + +.. _getNumberOfDeletions__: + +.. _SetChangeSet_getNumberOfDeletions: + +.. _SetChangeSet_getNumberOfDeletions__: + +.. _io_realm_SetChangeSet_getNumberOfDeletions: + +.. _io_realm_SetChangeSet_getNumberOfDeletions__: + + + +getNumberOfDeletions +-------------------- + +.. list-table:: + :header-rows: 1 + + * - | public **int** :ref:`getNumberOfDeletions ` () + | + + + + + * - The number of entries that have been deleted + + + + + + + **Returns** + + the number of deletions + + + + + + + + + + + +.. _getNumberOfInsertions: + +.. _getNumberOfInsertions__: + +.. _SetChangeSet_getNumberOfInsertions: + +.. _SetChangeSet_getNumberOfInsertions__: + +.. _io_realm_SetChangeSet_getNumberOfInsertions: + +.. _io_realm_SetChangeSet_getNumberOfInsertions__: + + + +getNumberOfInsertions +--------------------- + +.. list-table:: + :header-rows: 1 + + * - | public **int** :ref:`getNumberOfInsertions ` () + | + + + + + * - The number of entries that have been inserted. + + + + + + + **Returns** + + the number of insertions. + + + + + + + + + + + +.. _isEmpty: + +.. _isEmpty__: + +.. _SetChangeSet_isEmpty: + +.. _SetChangeSet_isEmpty__: + +.. _io_realm_SetChangeSet_isEmpty: + +.. _io_realm_SetChangeSet_isEmpty__: + + + +isEmpty +------- + +.. list-table:: + :header-rows: 1 + + * - | public **boolean** :ref:`isEmpty ` () + | + + + + + * - Whether the change set is empty or not. This is needed to detect whether a notification has been triggered right after subscription. + + + + + + + **Returns** + + whether the change set contains changes. + + + + + + + + + + + + diff --git a/source/sdk/java/api/io/realm/Sort.txt b/source/sdk/java/api/io/realm/Sort.txt index a2ea122da4..4a842679b5 100644 --- a/source/sdk/java/api/io/realm/Sort.txt +++ b/source/sdk/java/api/io/realm/Sort.txt @@ -18,8 +18,8 @@ io.realm ======== - | `java.lang.Object `__ - | `java.lang.Enum `__ + | `java.lang.Object `__ + | `java.lang.Enum `__ | io.realm.Sort @@ -86,7 +86,7 @@ Method Summary * - public static :ref:`Sort ` - | :ref:`valueOf ` ( - | `String `__ name + | `String `__ name | ) @@ -113,8 +113,8 @@ Inherited Methods -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` -- Methods inherited from class `java.lang.Enum `__ : ``name`` , ``ordinal`` , ``toString`` , ``equals`` , ``hashCode`` , ``clone`` , ``compareTo`` , ``getDeclaringClass`` , ``valueOf`` , ``finalize`` +- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` +- Methods inherited from class `java.lang.Enum `__ : ``name`` , ``ordinal`` , ``toString`` , ``equals`` , ``hashCode`` , ``clone`` , ``compareTo`` , ``getDeclaringClass`` , ``valueOf`` , ``finalize`` @@ -237,7 +237,7 @@ valueOf :header-rows: 1 * - | public static :ref:`Sort ` :ref:`valueOf ` ( - | `String `__ name + | `String `__ name | ) diff --git a/source/sdk/java/api/io/realm/annotations/Beta.txt b/source/sdk/java/api/io/realm/annotations/Beta.txt index 0c39561e51..9671157537 100644 --- a/source/sdk/java/api/io/realm/annotations/Beta.txt +++ b/source/sdk/java/api/io/realm/annotations/Beta.txt @@ -21,7 +21,7 @@ io.realm.annotations -- `java.lang.annotation.Annotation `__ +- `java.lang.annotation.Annotation `__ This annotation is added to classes, constructors or methods which are considered in beta phase. It indicates that any public interface can change without prior announcements. Moreover, classes, constructors, and methods annotated as beta are not considered at production quality, and should be used with care. diff --git a/source/sdk/java/api/io/realm/annotations/Ignore.txt b/source/sdk/java/api/io/realm/annotations/Ignore.txt index 09826ea265..41c9e42362 100644 --- a/source/sdk/java/api/io/realm/annotations/Ignore.txt +++ b/source/sdk/java/api/io/realm/annotations/Ignore.txt @@ -21,7 +21,7 @@ io.realm.annotations -- `java.lang.annotation.Annotation `__ +- `java.lang.annotation.Annotation `__ diff --git a/source/sdk/java/api/io/realm/annotations/Index.txt b/source/sdk/java/api/io/realm/annotations/Index.txt index e6a388223f..05cc36e549 100644 --- a/source/sdk/java/api/io/realm/annotations/Index.txt +++ b/source/sdk/java/api/io/realm/annotations/Index.txt @@ -21,7 +21,7 @@ io.realm.annotations -- `java.lang.annotation.Annotation `__ +- `java.lang.annotation.Annotation `__ This annotation will add a search index to the field. A search index will make the Realm file larger and inserts slower but queries will be faster.NOTICE: Only String, int, byte, short, long, boolean and Date fields can be indexed. diff --git a/source/sdk/java/api/io/realm/annotations/LinkingObjects.txt b/source/sdk/java/api/io/realm/annotations/LinkingObjects.txt index a15b9a51e9..dfde56eeb6 100644 --- a/source/sdk/java/api/io/realm/annotations/LinkingObjects.txt +++ b/source/sdk/java/api/io/realm/annotations/LinkingObjects.txt @@ -21,7 +21,7 @@ io.realm.annotations -- `java.lang.annotation.Annotation `__ +- `java.lang.annotation.Annotation `__ Annotation for defining a reverse relationship from one class to another. This annotation can only be added to a field of the type ``RealmResults`` . @@ -132,7 +132,7 @@ Note that when the source of the reverse reference (\`dog\` in the case above) i Querying inverse relationship is like querying any ``RealmResults`` . This means that an inverse relationship cannot be ``null`` but it can be empty (length is 0). It is possible to query fields in the source class. This is equivalent to link queries. Please read -`for more information `__ . +`for more information `__ . @@ -146,7 +146,7 @@ Optional Element Summary * - Modifier and Type - Optional Element and Description - * - public `String `__ + * - public `String `__ - The name of a field that contains a relation to an instance of the class containing this annotation. diff --git a/source/sdk/java/api/io/realm/annotations/PrimaryKey.txt b/source/sdk/java/api/io/realm/annotations/PrimaryKey.txt index e033d8f7c5..aeea3a41ef 100644 --- a/source/sdk/java/api/io/realm/annotations/PrimaryKey.txt +++ b/source/sdk/java/api/io/realm/annotations/PrimaryKey.txt @@ -21,16 +21,16 @@ io.realm.annotations -- `java.lang.annotation.Annotation `__ +- `java.lang.annotation.Annotation `__ -The @PrimaryKey annotation will mark a field as a primary key inside Realm. Only one field in a RealmObject class can have this annotation, and the field should uniquely identify the object. Trying to insert an object with an existing primary key will result in an :ref:`io.realm.exceptions.RealmPrimaryKeyConstraintException ` . Primary key cannot be changed after the object created. +The @PrimaryKey annotation will mark a field as a primary key inside Realm. Only one field in a RealmObject class can have this annotation, and the field should uniquely identify the object. Trying to insert an object with an existing primary key will result in an ``io.realm.exceptions.RealmPrimaryKeyConstraintException`` . Primary key cannot be changed after the object created. Primary keys also count as having the :ref:`Index ` annotation. -It is allowed to apply this annotation on the following primitive types: byte, short, int, and long. String, Byte, Short, Integer, Long and ObjectId are also allowed, and further permitted to have ``null`` as a primary key value. +It is allowed to apply this annotation on the following primitive types: byte, short, int, and long. String, Byte, Short, Integer, Long, ObjectId and UUID are also allowed, and further permitted to have ``null`` as a primary key value. diff --git a/source/sdk/java/api/io/realm/annotations/RealmClass.txt b/source/sdk/java/api/io/realm/annotations/RealmClass.txt index eb94106dbb..fe7f2ca283 100644 --- a/source/sdk/java/api/io/realm/annotations/RealmClass.txt +++ b/source/sdk/java/api/io/realm/annotations/RealmClass.txt @@ -21,7 +21,7 @@ io.realm.annotations -- `java.lang.annotation.Annotation `__ +- `java.lang.annotation.Annotation `__ Interface used to mark a class that can be persisted by Realm. @@ -52,7 +52,7 @@ Optional Element Summary - * - public `String `__ + * - public `String `__ - Manually set the internal name used by Realm for this class. @@ -60,7 +60,7 @@ Optional Element Summary - * - public `String `__ + * - public `String `__ - Manually set the internal name used by Realm for this class. diff --git a/source/sdk/java/api/io/realm/annotations/RealmField.txt b/source/sdk/java/api/io/realm/annotations/RealmField.txt index c1eeed094d..5d820c73a2 100644 --- a/source/sdk/java/api/io/realm/annotations/RealmField.txt +++ b/source/sdk/java/api/io/realm/annotations/RealmField.txt @@ -21,7 +21,7 @@ io.realm.annotations -- `java.lang.annotation.Annotation `__ +- `java.lang.annotation.Annotation `__ Annotation used on fields in Realm model classes. It describes metadata about the field. @@ -36,7 +36,7 @@ Optional Element Summary * - Modifier and Type - Optional Element and Description - * - public `String `__ + * - public `String `__ - Manually set the internal name used by Realm for this field. @@ -44,7 +44,7 @@ Optional Element Summary - * - public `String `__ + * - public `String `__ - Manually set the internal name used by Realm for this field. diff --git a/source/sdk/java/api/io/realm/annotations/RealmModule.txt b/source/sdk/java/api/io/realm/annotations/RealmModule.txt index 829e6bffa6..5afe5e39eb 100644 --- a/source/sdk/java/api/io/realm/annotations/RealmModule.txt +++ b/source/sdk/java/api/io/realm/annotations/RealmModule.txt @@ -21,7 +21,7 @@ io.realm.annotations -- `java.lang.annotation.Annotation `__ +- `java.lang.annotation.Annotation `__ By default a Realm can store all classes extending RealmObject in a project. However, if you want to restrict a Realm to only contain a subset of classes or want to share them between a library project and an app project, you must use a RealmModule.A RealmModule is a collection of classes extending RealmObject that can be combined with other RealmModules to create the schema for a Realm. This makes it easier to control versioning and migration of those Realms. @@ -58,7 +58,7 @@ App developers are not required to specify any modules, as they implicitly use t - - `Example of a project using modules `__ + - `Example of a project using modules `__ @@ -94,7 +94,7 @@ Optional Element Summary - * - public `Class `__ + * - public `Class `__ - Specifies the classes extending RealmObject that should be part of this module. diff --git a/source/sdk/java/api/io/realm/annotations/RealmNamingPolicy.txt b/source/sdk/java/api/io/realm/annotations/RealmNamingPolicy.txt index db48d42e10..94937d9bfd 100644 --- a/source/sdk/java/api/io/realm/annotations/RealmNamingPolicy.txt +++ b/source/sdk/java/api/io/realm/annotations/RealmNamingPolicy.txt @@ -18,8 +18,8 @@ io.realm.annotations ==================== - | `java.lang.Object `__ - | `java.lang.Enum `__ + | `java.lang.Object `__ + | `java.lang.Enum `__ | io.realm.annotations.RealmNamingPolicy @@ -102,12 +102,12 @@ When automatically converting Java variable names, each variable name is normali -#. Anytime you switch from a lower case character to an upper case character as identified by `Character.isUpperCase(int) `__ and `Character.isLowerCase(int) `__ . Example is "FirstName" which becomes "First" and "Name". +#. Anytime you switch from a lower case character to an upper case character as identified by `Character.isUpperCase(int) `__ and `Character.isLowerCase(int) `__ . Example is "FirstName" which becomes "First" and "Name". -#. Anytime you switch from more than one uppercase character to a lower case one. The last upper case letter is assumed to be part of the next word. This is identified by using `Character.isUpperCase(int) `__ and `Character.isLowerCase(int) `__ . Example is "FIRSTName" which becomes "FIRST" and "Name. +#. Anytime you switch from more than one uppercase character to a lower case one. The last upper case letter is assumed to be part of the next word. This is identified by using `Character.isUpperCase(int) `__ and `Character.isLowerCase(int) `__ . Example is "FIRSTName" which becomes "FIRST" and "Name. @@ -227,7 +227,7 @@ Method Summary * - public static :ref:`RealmNamingPolicy ` - | :ref:`valueOf ` ( - | `String `__ name + | `String `__ name | ) @@ -254,8 +254,8 @@ Inherited Methods -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` -- Methods inherited from class `java.lang.Enum `__ : ``name`` , ``ordinal`` , ``toString`` , ``equals`` , ``hashCode`` , ``clone`` , ``compareTo`` , ``getDeclaringClass`` , ``valueOf`` , ``finalize`` +- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` +- Methods inherited from class `java.lang.Enum `__ : ``name`` , ``ordinal`` , ``toString`` , ``equals`` , ``hashCode`` , ``clone`` , ``compareTo`` , ``getDeclaringClass`` , ``valueOf`` , ``finalize`` @@ -392,7 +392,7 @@ valueOf :header-rows: 1 * - | public static :ref:`RealmNamingPolicy ` :ref:`valueOf ` ( - | `String `__ name + | `String `__ name | ) diff --git a/source/sdk/java/api/io/realm/annotations/Required.txt b/source/sdk/java/api/io/realm/annotations/Required.txt index dd17b1d72c..09f4ca6490 100644 --- a/source/sdk/java/api/io/realm/annotations/Required.txt +++ b/source/sdk/java/api/io/realm/annotations/Required.txt @@ -21,10 +21,10 @@ io.realm.annotations -- `java.lang.annotation.Annotation `__ +- `java.lang.annotation.Annotation `__ -This annotation will mark the field or the element in :ref:`io.realm.RealmList ` as not nullable. +This annotation will mark the field or the element in ``io.realm.RealmList`` as not nullable. When a field of type ``Boolean, Byte, Short, Integer, Long, Float, Double, String, byte[], Date`` is annotated with :ref:`Required ` , it cannot be set to ``null`` and Realm will throw an exception if it happens. @@ -38,7 +38,11 @@ If this annotation is used on a ``RealmList`` , the annotation is applied to the -Compiling will fail if the :ref:`Required ` annotation is put an a :ref:`io.realm.RealmList ` containing references to other Realm objects. +This annotation cannot be used on a ``RealmAny`` , as the inner value of a RealmAny field is always nullable. Realm will throw an exception if you attempt mark a ``RealmAny`` as ``@Required`` . + + + +Compiling will fail if the :ref:`Required ` annotation is put an a ``RealmList`` containing references to other Realm objects. diff --git a/source/sdk/java/api/io/realm/coroutines/RealmFlowFactory.txt b/source/sdk/java/api/io/realm/coroutines/RealmFlowFactory.txt index 7e3028456e..3e03c12fd5 100644 --- a/source/sdk/java/api/io/realm/coroutines/RealmFlowFactory.txt +++ b/source/sdk/java/api/io/realm/coroutines/RealmFlowFactory.txt @@ -18,7 +18,7 @@ io.realm.coroutines =================== - | `java.lang.Object `__ + | `java.lang.Object `__ | io.realm.coroutines.RealmFlowFactory @@ -47,7 +47,7 @@ Constructors * - Constructor and Description * - | :ref:`RealmFlowFactory ` ( - | `Boolean `__ returnFrozenObjects + | `Boolean `__ returnFrozenObjects | ) @@ -270,7 +270,7 @@ Inherited Methods -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` +- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` @@ -290,7 +290,7 @@ Constructor Detail :header-rows: 1 * - | public :ref:`RealmFlowFactory ` ( - | `Boolean `__ returnFrozenObjects + | `Boolean `__ returnFrozenObjects | ) diff --git a/source/sdk/java/api/io/realm/exceptions/DownloadingRealmInterruptedException.txt b/source/sdk/java/api/io/realm/exceptions/DownloadingRealmInterruptedException.txt index 11ab06cf3f..8326b8be82 100644 --- a/source/sdk/java/api/io/realm/exceptions/DownloadingRealmInterruptedException.txt +++ b/source/sdk/java/api/io/realm/exceptions/DownloadingRealmInterruptedException.txt @@ -18,10 +18,10 @@ io.realm.exceptions =================== - | `java.lang.Object `__ - | `java.lang.Throwable `__ - | `java.lang.Exception `__ - | `java.lang.RuntimeException `__ + | `java.lang.Object `__ + | `java.lang.Throwable `__ + | `java.lang.Exception `__ + | `java.lang.RuntimeException `__ | io.realm.exceptions.DownloadingRealmInterruptedException @@ -40,7 +40,7 @@ Constructors * - | :ref:`DownloadingRealmInterruptedException ` ( | :ref:`SyncConfiguration ` syncConfig, - | `Throwable `__ exception + | `Throwable `__ exception | ) @@ -51,7 +51,7 @@ Constructors * - | :ref:`DownloadingRealmInterruptedException ` ( | :ref:`SyncConfiguration ` syncConfig, - | `String `__ message + | `String `__ message | ) @@ -68,8 +68,8 @@ Inherited Methods -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` -- Methods inherited from class `java.lang.Throwable `__ : ``getMessage`` , ``getLocalizedMessage`` , ``getCause`` , ``initCause`` , ``toString`` , ``printStackTrace`` , ``printStackTrace`` , ``printStackTrace`` , ``fillInStackTrace`` , ``getStackTrace`` , ``setStackTrace`` , ``addSuppressed`` , ``getSuppressed`` +- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` +- Methods inherited from class `java.lang.Throwable `__ : ``getMessage`` , ``getLocalizedMessage`` , ``getCause`` , ``initCause`` , ``toString`` , ``printStackTrace`` , ``printStackTrace`` , ``printStackTrace`` , ``fillInStackTrace`` , ``getStackTrace`` , ``setStackTrace`` , ``addSuppressed`` , ``getSuppressed`` @@ -90,7 +90,7 @@ Constructor Detail * - | public :ref:`DownloadingRealmInterruptedException ` ( | :ref:`SyncConfiguration ` syncConfig, - | `Throwable `__ exception + | `Throwable `__ exception | ) @@ -121,7 +121,7 @@ Constructor Detail * - | public :ref:`DownloadingRealmInterruptedException ` ( | :ref:`SyncConfiguration ` syncConfig, - | `String `__ message + | `String `__ message | ) diff --git a/source/sdk/java/api/io/realm/exceptions/RealmError.txt b/source/sdk/java/api/io/realm/exceptions/RealmError.txt index 402fddaeb6..728f1c6b44 100644 --- a/source/sdk/java/api/io/realm/exceptions/RealmError.txt +++ b/source/sdk/java/api/io/realm/exceptions/RealmError.txt @@ -18,13 +18,13 @@ io.realm.exceptions =================== - | `java.lang.Object `__ - | `java.lang.Throwable `__ - | `java.lang.Error `__ + | `java.lang.Object `__ + | `java.lang.Throwable `__ + | `java.lang.Error `__ | io.realm.exceptions.RealmError -RealmError is Realm specific Error used when unrecoverable problems happen in the underlying storage engine. An RealmError should never be caught or ignored. By doing so, the Realm could possibly get corrupted. +RealmError is a Realm specific Error used when unrecoverable problems happen in the underlying storage engine. A RealmError should never be caught or ignored. By doing so, the Realm could possibly get corrupted. Constructors @@ -36,7 +36,7 @@ Constructors * - Constructor and Description * - | :ref:`RealmError ` ( - | `String `__ detailMessage + | `String `__ detailMessage | ) @@ -53,8 +53,8 @@ Inherited Methods -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` -- Methods inherited from class `java.lang.Throwable `__ : ``getMessage`` , ``getLocalizedMessage`` , ``getCause`` , ``initCause`` , ``toString`` , ``printStackTrace`` , ``printStackTrace`` , ``printStackTrace`` , ``fillInStackTrace`` , ``getStackTrace`` , ``setStackTrace`` , ``addSuppressed`` , ``getSuppressed`` +- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` +- Methods inherited from class `java.lang.Throwable `__ : ``getMessage`` , ``getLocalizedMessage`` , ``getCause`` , ``initCause`` , ``toString`` , ``printStackTrace`` , ``printStackTrace`` , ``printStackTrace`` , ``fillInStackTrace`` , ``getStackTrace`` , ``setStackTrace`` , ``addSuppressed`` , ``getSuppressed`` @@ -74,7 +74,7 @@ Constructor Detail :header-rows: 1 * - | public :ref:`RealmError ` ( - | `String `__ detailMessage + | `String `__ detailMessage | ) diff --git a/source/sdk/java/api/io/realm/exceptions/RealmException.txt b/source/sdk/java/api/io/realm/exceptions/RealmException.txt index 574b8820e7..6095088709 100644 --- a/source/sdk/java/api/io/realm/exceptions/RealmException.txt +++ b/source/sdk/java/api/io/realm/exceptions/RealmException.txt @@ -18,14 +18,14 @@ io.realm.exceptions =================== - | `java.lang.Object `__ - | `java.lang.Throwable `__ - | `java.lang.Exception `__ - | `java.lang.RuntimeException `__ + | `java.lang.Object `__ + | `java.lang.Throwable `__ + | `java.lang.Exception `__ + | `java.lang.RuntimeException `__ | io.realm.exceptions.RealmException -RealmException is Realm specific exceptions. +RealmException is for Realm specific exceptions. Constructors @@ -37,7 +37,7 @@ Constructors * - Constructor and Description * - | :ref:`RealmException ` ( - | `String `__ detailMessage + | `String `__ detailMessage | ) @@ -47,8 +47,8 @@ Constructors * - | :ref:`RealmException ` ( - | `String `__ detailMessage, - | `Throwable `__ exception + | `String `__ detailMessage, + | `Throwable `__ exception | ) @@ -65,8 +65,8 @@ Inherited Methods -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` -- Methods inherited from class `java.lang.Throwable `__ : ``getMessage`` , ``getLocalizedMessage`` , ``getCause`` , ``initCause`` , ``toString`` , ``printStackTrace`` , ``printStackTrace`` , ``printStackTrace`` , ``fillInStackTrace`` , ``getStackTrace`` , ``setStackTrace`` , ``addSuppressed`` , ``getSuppressed`` +- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` +- Methods inherited from class `java.lang.Throwable `__ : ``getMessage`` , ``getLocalizedMessage`` , ``getCause`` , ``initCause`` , ``toString`` , ``printStackTrace`` , ``printStackTrace`` , ``printStackTrace`` , ``fillInStackTrace`` , ``getStackTrace`` , ``setStackTrace`` , ``addSuppressed`` , ``getSuppressed`` @@ -86,7 +86,7 @@ Constructor Detail :header-rows: 1 * - | public :ref:`RealmException ` ( - | `String `__ detailMessage + | `String `__ detailMessage | ) @@ -116,8 +116,8 @@ Constructor Detail :header-rows: 1 * - | public :ref:`RealmException ` ( - | `String `__ detailMessage, - | `Throwable `__ exception + | `String `__ detailMessage, + | `Throwable `__ exception | ) diff --git a/source/sdk/java/api/io/realm/exceptions/RealmFileException.txt b/source/sdk/java/api/io/realm/exceptions/RealmFileException.txt index f871715f6b..0643959ca2 100644 --- a/source/sdk/java/api/io/realm/exceptions/RealmFileException.txt +++ b/source/sdk/java/api/io/realm/exceptions/RealmFileException.txt @@ -18,10 +18,10 @@ io.realm.exceptions =================== - | `java.lang.Object `__ - | `java.lang.Throwable `__ - | `java.lang.Exception `__ - | `java.lang.RuntimeException `__ + | `java.lang.Object `__ + | `java.lang.Throwable `__ + | `java.lang.Exception `__ + | `java.lang.RuntimeException `__ | io.realm.exceptions.RealmFileException @@ -38,7 +38,7 @@ Constructors * - | :ref:`RealmFileException ` ( | **byte** value, - | `String `__ message + | `String `__ message | ) @@ -49,7 +49,7 @@ Constructors * - | :ref:`RealmFileException ` ( | :ref:`RealmFileException.Kind ` kind, - | `String `__ message + | `String `__ message | ) @@ -60,7 +60,7 @@ Constructors * - | :ref:`RealmFileException ` ( | :ref:`RealmFileException.Kind ` kind, - | `Throwable `__ cause + | `Throwable `__ cause | ) @@ -71,8 +71,8 @@ Constructors * - | :ref:`RealmFileException ` ( | :ref:`RealmFileException.Kind ` kind, - | `String `__ message, - | `Throwable `__ cause + | `String `__ message, + | `Throwable `__ cause | ) @@ -121,7 +121,7 @@ Method Summary - * - public `String `__ + * - public `String `__ - | :ref:`toString ` () | @@ -139,8 +139,8 @@ Inherited Methods -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` -- Methods inherited from class `java.lang.Throwable `__ : ``getMessage`` , ``getLocalizedMessage`` , ``getCause`` , ``initCause`` , ``toString`` , ``printStackTrace`` , ``printStackTrace`` , ``printStackTrace`` , ``fillInStackTrace`` , ``getStackTrace`` , ``setStackTrace`` , ``addSuppressed`` , ``getSuppressed`` +- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` +- Methods inherited from class `java.lang.Throwable `__ : ``getMessage`` , ``getLocalizedMessage`` , ``getCause`` , ``initCause`` , ``toString`` , ``printStackTrace`` , ``printStackTrace`` , ``printStackTrace`` , ``fillInStackTrace`` , ``getStackTrace`` , ``setStackTrace`` , ``addSuppressed`` , ``getSuppressed`` @@ -161,7 +161,7 @@ Constructor Detail * - | public :ref:`RealmFileException ` ( | **byte** value, - | `String `__ message + | `String `__ message | ) @@ -192,7 +192,7 @@ Constructor Detail * - | public :ref:`RealmFileException ` ( | :ref:`RealmFileException.Kind ` kind, - | `String `__ message + | `String `__ message | ) @@ -223,7 +223,7 @@ Constructor Detail * - | public :ref:`RealmFileException ` ( | :ref:`RealmFileException.Kind ` kind, - | `Throwable `__ cause + | `Throwable `__ cause | ) @@ -254,8 +254,8 @@ Constructor Detail * - | public :ref:`RealmFileException ` ( | :ref:`RealmFileException.Kind ` kind, - | `String `__ message, - | `Throwable `__ cause + | `String `__ message, + | `Throwable `__ cause | ) @@ -349,7 +349,7 @@ toString .. list-table:: :header-rows: 1 - * - | public `String `__ :ref:`toString ` () + * - | public `String `__ :ref:`toString ` () | @@ -368,7 +368,7 @@ toString **Overrides** - ``toString`` in class `Throwable `__ + ``toString`` in class `Throwable `__ diff --git a/source/sdk/java/api/io/realm/exceptions/RealmFileException/Kind.txt b/source/sdk/java/api/io/realm/exceptions/RealmFileException/Kind.txt index 5c49153784..6ae016ee0b 100644 --- a/source/sdk/java/api/io/realm/exceptions/RealmFileException/Kind.txt +++ b/source/sdk/java/api/io/realm/exceptions/RealmFileException/Kind.txt @@ -18,8 +18,8 @@ io.realm.exceptions =================== - | `java.lang.Object `__ - | `java.lang.Enum `__ + | `java.lang.Object `__ + | `java.lang.Enum `__ | io.realm.exceptions.RealmFileException.Kind @@ -114,7 +114,7 @@ Method Summary * - public static :ref:`RealmFileException.Kind ` - | :ref:`valueOf ` ( - | `String `__ name + | `String `__ name | ) @@ -141,8 +141,8 @@ Inherited Methods -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` -- Methods inherited from class `java.lang.Enum `__ : ``name`` , ``ordinal`` , ``toString`` , ``equals`` , ``hashCode`` , ``clone`` , ``compareTo`` , ``getDeclaringClass`` , ``valueOf`` , ``finalize`` +- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` +- Methods inherited from class `java.lang.Enum `__ : ``name`` , ``ordinal`` , ``toString`` , ``equals`` , ``hashCode`` , ``clone`` , ``compareTo`` , ``getDeclaringClass`` , ``valueOf`` , ``finalize`` @@ -312,7 +312,7 @@ valueOf :header-rows: 1 * - | public static :ref:`RealmFileException.Kind ` :ref:`valueOf ` ( - | `String `__ name + | `String `__ name | ) diff --git a/source/sdk/java/api/io/realm/exceptions/RealmMigrationNeededException.txt b/source/sdk/java/api/io/realm/exceptions/RealmMigrationNeededException.txt index c61ae1e1a8..c6c246261b 100644 --- a/source/sdk/java/api/io/realm/exceptions/RealmMigrationNeededException.txt +++ b/source/sdk/java/api/io/realm/exceptions/RealmMigrationNeededException.txt @@ -18,10 +18,10 @@ io.realm.exceptions =================== - | `java.lang.Object `__ - | `java.lang.Throwable `__ - | `java.lang.Exception `__ - | `java.lang.RuntimeException `__ + | `java.lang.Object `__ + | `java.lang.Throwable `__ + | `java.lang.Exception `__ + | `java.lang.RuntimeException `__ | io.realm.exceptions.RealmMigrationNeededException @@ -37,8 +37,8 @@ Constructors * - Constructor and Description * - | :ref:`RealmMigrationNeededException ` ( - | `String `__ canonicalRealmPath, - | `String `__ detailMessage + | `String `__ canonicalRealmPath, + | `String `__ detailMessage | ) @@ -59,7 +59,7 @@ Method Summary * - Modifier and Type - Method and Description - * - public `String `__ + * - public `String `__ - | :ref:`getPath ` () | @@ -77,8 +77,8 @@ Inherited Methods -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` -- Methods inherited from class `java.lang.Throwable `__ : ``getMessage`` , ``getLocalizedMessage`` , ``getCause`` , ``initCause`` , ``toString`` , ``printStackTrace`` , ``printStackTrace`` , ``printStackTrace`` , ``fillInStackTrace`` , ``getStackTrace`` , ``setStackTrace`` , ``addSuppressed`` , ``getSuppressed`` +- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` +- Methods inherited from class `java.lang.Throwable `__ : ``getMessage`` , ``getLocalizedMessage`` , ``getCause`` , ``initCause`` , ``toString`` , ``printStackTrace`` , ``printStackTrace`` , ``printStackTrace`` , ``fillInStackTrace`` , ``getStackTrace`` , ``setStackTrace`` , ``addSuppressed`` , ``getSuppressed`` @@ -98,8 +98,8 @@ Constructor Detail :header-rows: 1 * - | public :ref:`RealmMigrationNeededException ` ( - | `String `__ canonicalRealmPath, - | `String `__ detailMessage + | `String `__ canonicalRealmPath, + | `String `__ detailMessage | ) @@ -142,7 +142,7 @@ getPath .. list-table:: :header-rows: 1 - * - | public `String `__ :ref:`getPath ` () + * - | public `String `__ :ref:`getPath ` () | @@ -172,7 +172,7 @@ getPath - - `File.getCanonicalPath() `__ + - `File.getCanonicalPath() `__ diff --git a/source/sdk/java/api/io/realm/exceptions/RealmPrimaryKeyConstraintException.txt b/source/sdk/java/api/io/realm/exceptions/RealmPrimaryKeyConstraintException.txt index bb43dc5fd7..a0f423f0b5 100644 --- a/source/sdk/java/api/io/realm/exceptions/RealmPrimaryKeyConstraintException.txt +++ b/source/sdk/java/api/io/realm/exceptions/RealmPrimaryKeyConstraintException.txt @@ -18,10 +18,10 @@ io.realm.exceptions =================== - | `java.lang.Object `__ - | `java.lang.Throwable `__ - | `java.lang.Exception `__ - | `java.lang.RuntimeException `__ + | `java.lang.Object `__ + | `java.lang.Throwable `__ + | `java.lang.Exception `__ + | `java.lang.RuntimeException `__ | io.realm.exceptions.RealmPrimaryKeyConstraintException @@ -51,7 +51,7 @@ Constructors * - Constructor and Description * - | :ref:`RealmPrimaryKeyConstraintException ` ( - | `String `__ message + | `String `__ message | ) @@ -68,8 +68,8 @@ Inherited Methods -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` -- Methods inherited from class `java.lang.Throwable `__ : ``getMessage`` , ``getLocalizedMessage`` , ``getCause`` , ``initCause`` , ``toString`` , ``printStackTrace`` , ``printStackTrace`` , ``printStackTrace`` , ``fillInStackTrace`` , ``getStackTrace`` , ``setStackTrace`` , ``addSuppressed`` , ``getSuppressed`` +- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` +- Methods inherited from class `java.lang.Throwable `__ : ``getMessage`` , ``getLocalizedMessage`` , ``getCause`` , ``initCause`` , ``toString`` , ``printStackTrace`` , ``printStackTrace`` , ``printStackTrace`` , ``fillInStackTrace`` , ``getStackTrace`` , ``setStackTrace`` , ``addSuppressed`` , ``getSuppressed`` @@ -89,7 +89,7 @@ Constructor Detail :header-rows: 1 * - | public :ref:`RealmPrimaryKeyConstraintException ` ( - | `String `__ message + | `String `__ message | ) diff --git a/source/sdk/java/api/io/realm/gradle.txt b/source/sdk/java/api/io/realm/gradle.txt new file mode 100644 index 0000000000..974a65c90d --- /dev/null +++ b/source/sdk/java/api/io/realm/gradle.txt @@ -0,0 +1,29 @@ + +.. contents:: On this page + :local: + :backlinks: none + :depth: 2 + :class: singlecol + + + +io.realm.gradle +^^^^^^^^^^^^^^^ + +.. toctree:: + :titlesonly: + :hidden: + + + RealmPluginExtension + RealmPluginExtension.PropertyChangedListener + + + +| + +- :ref:`io.realm.gradle.RealmPluginExtension ` +- :ref:`io.realm.gradle.RealmPluginExtension.PropertyChangedListener ` + + + diff --git a/source/sdk/java/api/io/realm/gradle/RealmPluginExtension.txt b/source/sdk/java/api/io/realm/gradle/RealmPluginExtension.txt new file mode 100644 index 0000000000..75199d08a7 --- /dev/null +++ b/source/sdk/java/api/io/realm/gradle/RealmPluginExtension.txt @@ -0,0 +1,528 @@ + +.. contents:: On this page + :local: + :backlinks: none + :depth: 2 + :class: singlecol + + + +Class RealmPluginExtension +^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. _io_realm_gradle_RealmPluginExtension: + + + +io.realm.gradle +=============== + + + | `java.lang.Object `__ + | io.realm.gradle.RealmPluginExtension + + + + + +Constructors +============ + +.. list-table:: + :header-rows: 1 + + * - Constructor and Description + + * - | :ref:`RealmPluginExtension ` () + | + + + + + + + + + + +Nested Class Summary +==================== + +.. list-table:: + :header-rows: 1 + + * - Modifier and Type + - Class and Description + + * - ``public static interface`` + - :ref:`RealmPluginExtension.PropertyChangedListener ` + + + + + +Field Summary +============= + +.. list-table:: + :header-rows: 1 + + * - Modifier and Type + - Field and Description + + * - public static final `String `__ + + + - :ref:`KEY_KOTLIN_EXTENSIONS_ENABLED ` + + + + + * - public static final `String `__ + + + - :ref:`KEY_SYNC_ENABLED ` + + + + + + + +Method Summary +============== + +.. list-table:: + :header-rows: 1 + + * - Modifier and Type + - Method and Description + + * - public **void** + - | :ref:`addPropertyListener ` ( + | `String `__ property, + | :ref:`io.realm.gradle.RealmPluginExtension.PropertyChangedListener ` listener + | ) + + + + + + + + * - public **boolean** + - | :ref:`isKotlinExtensionsEnabled ` () + | + + + + + + + + * - public **boolean** + - | :ref:`isSyncEnabled ` () + | + + + + + + + + * - public **void** + - | :ref:`setKotlinExtensionsEnabled ` ( + | **boolean** kotlinExtensionsEnabled + | ) + + + + + + + + * - public **void** + - | :ref:`setSyncEnabled ` ( + | **boolean** syncEnabled + | ) + + + + + + + + + + +Inherited Methods +================= + + + +- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` + + + + +Field Detail +============ + +.. _io_realm_gradle_RealmPluginExtension_KEY_KOTLIN_EXTENSIONS_ENABLED: + + + +``KEY_KOTLIN_EXTENSIONS_ENABLED`` +---------------------------------- + + + + +.. _io_realm_gradle_RealmPluginExtension_KEY_SYNC_ENABLED: + + + +``KEY_SYNC_ENABLED`` +--------------------- + + + + + + +Constructor Detail +================== + +.. _RealmPluginExtension: + +.. _RealmPluginExtension__: + +.. _io_realm_gradle_RealmPluginExtension: + +.. _io_realm_gradle_RealmPluginExtension__: + +.. list-table:: + :header-rows: 1 + + * - | public :ref:`RealmPluginExtension ` () + | + + + + + * - + + + + + + + + + + + + + +Method Detail +============= + +.. _addPropertyListener: + +.. _addPropertyListener__: + +.. _RealmPluginExtension_addPropertyListener: + +.. _RealmPluginExtension_addPropertyListener__: + +.. _io_realm_gradle_RealmPluginExtension_addPropertyListener: + +.. _io_realm_gradle_RealmPluginExtension_addPropertyListener__: + + + +addPropertyListener +------------------- + +.. _io_realm_gradle_RealmPluginExtension_addPropertyListener_java_lang_String_io_realm_gradle_RealmPluginExtension_PropertyChangedListener_: + +.. _io_realm_gradle_RealmPluginExtension_addPropertyListener_java_lang_String__io_realm_gradle_RealmPluginExtension_PropertyChangedListener_: + +.. _io_realm_gradle_RealmPluginExtension_addPropertyListener_java_lang_String_PropertyChangedListener_: + +.. _io_realm_gradle_RealmPluginExtension_addPropertyListener_java_lang_String__PropertyChangedListener_: + +.. _io_realm_gradle_RealmPluginExtension_addPropertyListener_java_lang_String_RealmPluginExtension_PropertyChangedListener_: + +.. _io_realm_gradle_RealmPluginExtension_addPropertyListener_java_lang_String__RealmPluginExtension_PropertyChangedListener_: + +.. _io_realm_gradle_RealmPluginExtension_addPropertyListener_String_io_realm_gradle_RealmPluginExtension_PropertyChangedListener_: + +.. _io_realm_gradle_RealmPluginExtension_addPropertyListener_String__io_realm_gradle_RealmPluginExtension_PropertyChangedListener_: + +.. _io_realm_gradle_RealmPluginExtension_addPropertyListener_String_PropertyChangedListener_: + +.. _io_realm_gradle_RealmPluginExtension_addPropertyListener_String__PropertyChangedListener_: + +.. _io_realm_gradle_RealmPluginExtension_addPropertyListener_String_RealmPluginExtension_PropertyChangedListener_: + +.. _io_realm_gradle_RealmPluginExtension_addPropertyListener_String__RealmPluginExtension_PropertyChangedListener_: + +.. _addPropertyListener_java_lang_String_io_realm_gradle_RealmPluginExtension_PropertyChangedListener_: + +.. _addPropertyListener_java_lang_String__io_realm_gradle_RealmPluginExtension_PropertyChangedListener_: + +.. _addPropertyListener_java_lang_String_PropertyChangedListener_: + +.. _addPropertyListener_java_lang_String__PropertyChangedListener_: + +.. _addPropertyListener_java_lang_String_RealmPluginExtension_PropertyChangedListener_: + +.. _addPropertyListener_java_lang_String__RealmPluginExtension_PropertyChangedListener_: + +.. _addPropertyListener_String_io_realm_gradle_RealmPluginExtension_PropertyChangedListener_: + +.. _addPropertyListener_String__io_realm_gradle_RealmPluginExtension_PropertyChangedListener_: + +.. _addPropertyListener_String_PropertyChangedListener_: + +.. _addPropertyListener_String__PropertyChangedListener_: + +.. _addPropertyListener_String_RealmPluginExtension_PropertyChangedListener_: + +.. _addPropertyListener_String__RealmPluginExtension_PropertyChangedListener_: + +.. _RealmPluginExtension_addPropertyListener_java_lang_String_io_realm_gradle_RealmPluginExtension_PropertyChangedListener_: + +.. _RealmPluginExtension_addPropertyListener_java_lang_String__io_realm_gradle_RealmPluginExtension_PropertyChangedListener_: + +.. _RealmPluginExtension_addPropertyListener_java_lang_String_PropertyChangedListener_: + +.. _RealmPluginExtension_addPropertyListener_java_lang_String__PropertyChangedListener_: + +.. _RealmPluginExtension_addPropertyListener_java_lang_String_RealmPluginExtension_PropertyChangedListener_: + +.. _RealmPluginExtension_addPropertyListener_java_lang_String__RealmPluginExtension_PropertyChangedListener_: + +.. _RealmPluginExtension_addPropertyListener_String_io_realm_gradle_RealmPluginExtension_PropertyChangedListener_: + +.. _RealmPluginExtension_addPropertyListener_String__io_realm_gradle_RealmPluginExtension_PropertyChangedListener_: + +.. _RealmPluginExtension_addPropertyListener_String_PropertyChangedListener_: + +.. _RealmPluginExtension_addPropertyListener_String__PropertyChangedListener_: + +.. _RealmPluginExtension_addPropertyListener_String_RealmPluginExtension_PropertyChangedListener_: + +.. _RealmPluginExtension_addPropertyListener_String__RealmPluginExtension_PropertyChangedListener_: + +.. list-table:: + :header-rows: 1 + + * - | public **void** :ref:`addPropertyListener ` ( + | `String `__ property, + | :ref:`io.realm.gradle.RealmPluginExtension.PropertyChangedListener ` listener + | ) + + + + + * - + + + + + + + + + + + + + + + +.. _isKotlinExtensionsEnabled: + +.. _isKotlinExtensionsEnabled__: + +.. _RealmPluginExtension_isKotlinExtensionsEnabled: + +.. _RealmPluginExtension_isKotlinExtensionsEnabled__: + +.. _io_realm_gradle_RealmPluginExtension_isKotlinExtensionsEnabled: + +.. _io_realm_gradle_RealmPluginExtension_isKotlinExtensionsEnabled__: + + + +isKotlinExtensionsEnabled +------------------------- + +.. list-table:: + :header-rows: 1 + + * - | public **boolean** :ref:`isKotlinExtensionsEnabled ` () + | + + + + + * - + + + + + + + + + + + + + + + +.. _isSyncEnabled: + +.. _isSyncEnabled__: + +.. _RealmPluginExtension_isSyncEnabled: + +.. _RealmPluginExtension_isSyncEnabled__: + +.. _io_realm_gradle_RealmPluginExtension_isSyncEnabled: + +.. _io_realm_gradle_RealmPluginExtension_isSyncEnabled__: + + + +isSyncEnabled +------------- + +.. list-table:: + :header-rows: 1 + + * - | public **boolean** :ref:`isSyncEnabled ` () + | + + + + + * - + + + + + + + + + + + + + + + +.. _setKotlinExtensionsEnabled: + +.. _setKotlinExtensionsEnabled__: + +.. _RealmPluginExtension_setKotlinExtensionsEnabled: + +.. _RealmPluginExtension_setKotlinExtensionsEnabled__: + +.. _io_realm_gradle_RealmPluginExtension_setKotlinExtensionsEnabled: + +.. _io_realm_gradle_RealmPluginExtension_setKotlinExtensionsEnabled__: + + + +setKotlinExtensionsEnabled +-------------------------- + +.. _io_realm_gradle_RealmPluginExtension_setKotlinExtensionsEnabled_boolean_: + +.. _setKotlinExtensionsEnabled_boolean_: + +.. _RealmPluginExtension_setKotlinExtensionsEnabled_boolean_: + +.. list-table:: + :header-rows: 1 + + * - | public **void** :ref:`setKotlinExtensionsEnabled ` ( + | **boolean** kotlinExtensionsEnabled + | ) + + + + + * - + + + + + + + + + + + + + + + +.. _setSyncEnabled: + +.. _setSyncEnabled__: + +.. _RealmPluginExtension_setSyncEnabled: + +.. _RealmPluginExtension_setSyncEnabled__: + +.. _io_realm_gradle_RealmPluginExtension_setSyncEnabled: + +.. _io_realm_gradle_RealmPluginExtension_setSyncEnabled__: + + + +setSyncEnabled +-------------- + +.. _io_realm_gradle_RealmPluginExtension_setSyncEnabled_boolean_: + +.. _setSyncEnabled_boolean_: + +.. _RealmPluginExtension_setSyncEnabled_boolean_: + +.. list-table:: + :header-rows: 1 + + * - | public **void** :ref:`setSyncEnabled ` ( + | **boolean** syncEnabled + | ) + + + + + * - + + + + + + + + + + + + + + + + diff --git a/source/sdk/java/api/io/realm/gradle/RealmPluginExtension/PropertyChangedListener.txt b/source/sdk/java/api/io/realm/gradle/RealmPluginExtension/PropertyChangedListener.txt new file mode 100644 index 0000000000..806fa6b2c1 --- /dev/null +++ b/source/sdk/java/api/io/realm/gradle/RealmPluginExtension/PropertyChangedListener.txt @@ -0,0 +1,110 @@ + +.. contents:: On this page + :local: + :backlinks: none + :depth: 2 + :class: singlecol + + + +Interface RealmPluginExtension.PropertyChangedListener +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. _io_realm_gradle_RealmPluginExtension_PropertyChangedListener: + + + +io.realm.gradle +=============== + + + +**Enclosing class:** + +:ref:`RealmPluginExtension ` + + + + + + +Method Summary +============== + +.. list-table:: + :header-rows: 1 + + * - Modifier and Type + - Method and Description + + * - public **void** + - | :ref:`onChange ` ( + | **T** value + | ) + + + + + + + + + + +Method Detail +============= + +.. _onChange: + +.. _onChange__: + +.. _PropertyChangedListener_onChange: + +.. _PropertyChangedListener_onChange__: + +.. _RealmPluginExtension_PropertyChangedListener_onChange: + +.. _RealmPluginExtension_PropertyChangedListener_onChange__: + +.. _io_realm_gradle_RealmPluginExtension_PropertyChangedListener_onChange: + +.. _io_realm_gradle_RealmPluginExtension_PropertyChangedListener_onChange__: + + + +onChange +-------- + +.. _io_realm_gradle_RealmPluginExtension_PropertyChangedListener_onChange_T_: + +.. _onChange_T_: + +.. _RealmPluginExtension_PropertyChangedListener_onChange_T_: + +.. list-table:: + :header-rows: 1 + + * - | public **void** :ref:`onChange ` ( + | **T** value + | ) + + + + + * - + + + + + + + + + + + + + + + + diff --git a/source/sdk/java/api/io/realm/log/LogLevel.txt b/source/sdk/java/api/io/realm/log/LogLevel.txt index ad1cfe1936..d85b1888e2 100644 --- a/source/sdk/java/api/io/realm/log/LogLevel.txt +++ b/source/sdk/java/api/io/realm/log/LogLevel.txt @@ -18,7 +18,7 @@ io.realm.log ============ - | `java.lang.Object `__ + | `java.lang.Object `__ | io.realm.log.LogLevel @@ -142,7 +142,7 @@ Inherited Methods -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` +- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` diff --git a/source/sdk/java/api/io/realm/log/RealmLog.txt b/source/sdk/java/api/io/realm/log/RealmLog.txt index cb395bc328..b597aff52f 100644 --- a/source/sdk/java/api/io/realm/log/RealmLog.txt +++ b/source/sdk/java/api/io/realm/log/RealmLog.txt @@ -18,7 +18,7 @@ io.realm.log ============ - | `java.lang.Object `__ + | `java.lang.Object `__ | io.realm.log.RealmLog @@ -79,9 +79,9 @@ Method Summary * - public static **void** - | :ref:`debug ` ( - | `Throwable `__ throwable, - | `String `__ message, - | `java.lang.Object[] `__ args + | `Throwable `__ throwable, + | `String `__ message, + | `java.lang.Object[] `__ args | ) @@ -94,8 +94,8 @@ Method Summary * - public static **void** - | :ref:`debug ` ( - | `String `__ message, - | `java.lang.Object[] `__ args + | `String `__ message, + | `java.lang.Object[] `__ args | ) @@ -108,7 +108,7 @@ Method Summary * - public static **void** - | :ref:`debug ` ( - | `Throwable `__ throwable + | `Throwable `__ throwable | ) @@ -121,9 +121,9 @@ Method Summary * - public static **void** - | :ref:`error ` ( - | `Throwable `__ throwable, - | `String `__ message, - | `java.lang.Object[] `__ args + | `Throwable `__ throwable, + | `String `__ message, + | `java.lang.Object[] `__ args | ) @@ -136,8 +136,8 @@ Method Summary * - public static **void** - | :ref:`error ` ( - | `String `__ message, - | `java.lang.Object[] `__ args + | `String `__ message, + | `java.lang.Object[] `__ args | ) @@ -150,7 +150,7 @@ Method Summary * - public static **void** - | :ref:`error ` ( - | `Throwable `__ throwable + | `Throwable `__ throwable | ) @@ -163,9 +163,9 @@ Method Summary * - public static **void** - | :ref:`fatal ` ( - | `Throwable `__ throwable, - | `String `__ message, - | `java.lang.Object[] `__ args + | `Throwable `__ throwable, + | `String `__ message, + | `java.lang.Object[] `__ args | ) @@ -178,8 +178,8 @@ Method Summary * - public static **void** - | :ref:`fatal ` ( - | `String `__ message, - | `java.lang.Object[] `__ args + | `String `__ message, + | `java.lang.Object[] `__ args | ) @@ -192,7 +192,7 @@ Method Summary * - public static **void** - | :ref:`fatal ` ( - | `Throwable `__ throwable + | `Throwable `__ throwable | ) @@ -217,9 +217,9 @@ Method Summary * - public static **void** - | :ref:`info ` ( - | `Throwable `__ throwable, - | `String `__ message, - | `java.lang.Object[] `__ args + | `Throwable `__ throwable, + | `String `__ message, + | `java.lang.Object[] `__ args | ) @@ -232,8 +232,8 @@ Method Summary * - public static **void** - | :ref:`info ` ( - | `String `__ message, - | `java.lang.Object[] `__ args + | `String `__ message, + | `java.lang.Object[] `__ args | ) @@ -246,7 +246,7 @@ Method Summary * - public static **void** - | :ref:`info ` ( - | `Throwable `__ throwable + | `Throwable `__ throwable | ) @@ -293,9 +293,9 @@ Method Summary * - public static **void** - | :ref:`trace ` ( - | `Throwable `__ throwable, - | `String `__ message, - | `java.lang.Object[] `__ args + | `Throwable `__ throwable, + | `String `__ message, + | `java.lang.Object[] `__ args | ) @@ -308,8 +308,8 @@ Method Summary * - public static **void** - | :ref:`trace ` ( - | `String `__ message, - | `java.lang.Object[] `__ args + | `String `__ message, + | `java.lang.Object[] `__ args | ) @@ -322,7 +322,7 @@ Method Summary * - public static **void** - | :ref:`trace ` ( - | `Throwable `__ throwable + | `Throwable `__ throwable | ) @@ -335,9 +335,9 @@ Method Summary * - public static **void** - | :ref:`warn ` ( - | `Throwable `__ throwable, - | `String `__ message, - | `java.lang.Object[] `__ args + | `Throwable `__ throwable, + | `String `__ message, + | `java.lang.Object[] `__ args | ) @@ -350,8 +350,8 @@ Method Summary * - public static **void** - | :ref:`warn ` ( - | `String `__ message, - | `java.lang.Object[] `__ args + | `String `__ message, + | `java.lang.Object[] `__ args | ) @@ -364,7 +364,7 @@ Method Summary * - public static **void** - | :ref:`warn ` ( - | `Throwable `__ throwable + | `Throwable `__ throwable | ) @@ -383,7 +383,7 @@ Inherited Methods -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` +- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` @@ -699,9 +699,9 @@ debug :header-rows: 1 * - | public static **void** :ref:`debug ` ( - | `Throwable `__ throwable, - | `String `__ message, - | `java.lang.Object[] `__ args + | `Throwable `__ throwable, + | `String `__ message, + | `java.lang.Object[] `__ args | ) @@ -724,7 +724,7 @@ debug - - ``args`` - optional args used to format the message using `String.format(String, Object...) `__ . + - ``args`` - optional args used to format the message using `String.format(String, Object...) `__ . @@ -817,8 +817,8 @@ debug :header-rows: 1 * - | public static **void** :ref:`debug ` ( - | `String `__ message, - | `java.lang.Object[] `__ args + | `String `__ message, + | `java.lang.Object[] `__ args | ) @@ -837,7 +837,7 @@ debug - - ``args`` - optional args used to format the message using `String.format(String, Object...) `__ . + - ``args`` - optional args used to format the message using `String.format(String, Object...) `__ . @@ -870,7 +870,7 @@ debug :header-rows: 1 * - | public static **void** :ref:`debug ` ( - | `Throwable `__ throwable + | `Throwable `__ throwable | ) @@ -1067,9 +1067,9 @@ error :header-rows: 1 * - | public static **void** :ref:`error ` ( - | `Throwable `__ throwable, - | `String `__ message, - | `java.lang.Object[] `__ args + | `Throwable `__ throwable, + | `String `__ message, + | `java.lang.Object[] `__ args | ) @@ -1092,7 +1092,7 @@ error - - ``args`` - optional args used to format the message using `String.format(String, Object...) `__ . + - ``args`` - optional args used to format the message using `String.format(String, Object...) `__ . @@ -1185,8 +1185,8 @@ error :header-rows: 1 * - | public static **void** :ref:`error ` ( - | `String `__ message, - | `java.lang.Object[] `__ args + | `String `__ message, + | `java.lang.Object[] `__ args | ) @@ -1205,7 +1205,7 @@ error - - ``args`` - optional args used to format the message using `String.format(String, Object...) `__ . + - ``args`` - optional args used to format the message using `String.format(String, Object...) `__ . @@ -1238,7 +1238,7 @@ error :header-rows: 1 * - | public static **void** :ref:`error ` ( - | `Throwable `__ throwable + | `Throwable `__ throwable | ) @@ -1435,9 +1435,9 @@ fatal :header-rows: 1 * - | public static **void** :ref:`fatal ` ( - | `Throwable `__ throwable, - | `String `__ message, - | `java.lang.Object[] `__ args + | `Throwable `__ throwable, + | `String `__ message, + | `java.lang.Object[] `__ args | ) @@ -1460,7 +1460,7 @@ fatal - - ``args`` - optional args used to format the message using `String.format(String, Object...) `__ . + - ``args`` - optional args used to format the message using `String.format(String, Object...) `__ . @@ -1553,8 +1553,8 @@ fatal :header-rows: 1 * - | public static **void** :ref:`fatal ` ( - | `String `__ message, - | `java.lang.Object[] `__ args + | `String `__ message, + | `java.lang.Object[] `__ args | ) @@ -1573,7 +1573,7 @@ fatal - - ``args`` - optional args used to format the message using `String.format(String, Object...) `__ . + - ``args`` - optional args used to format the message using `String.format(String, Object...) `__ . @@ -1606,7 +1606,7 @@ fatal :header-rows: 1 * - | public static **void** :ref:`fatal ` ( - | `Throwable `__ throwable + | `Throwable `__ throwable | ) @@ -1854,9 +1854,9 @@ info :header-rows: 1 * - | public static **void** :ref:`info ` ( - | `Throwable `__ throwable, - | `String `__ message, - | `java.lang.Object[] `__ args + | `Throwable `__ throwable, + | `String `__ message, + | `java.lang.Object[] `__ args | ) @@ -1879,7 +1879,7 @@ info - - ``args`` - optional args used to format the message using `String.format(String, Object...) `__ . + - ``args`` - optional args used to format the message using `String.format(String, Object...) `__ . @@ -1972,8 +1972,8 @@ info :header-rows: 1 * - | public static **void** :ref:`info ` ( - | `String `__ message, - | `java.lang.Object[] `__ args + | `String `__ message, + | `java.lang.Object[] `__ args | ) @@ -1992,7 +1992,7 @@ info - - ``args`` - optional args used to format the message using `String.format(String, Object...) `__ . + - ``args`` - optional args used to format the message using `String.format(String, Object...) `__ . @@ -2025,7 +2025,7 @@ info :header-rows: 1 * - | public static **void** :ref:`info ` ( - | `Throwable `__ throwable + | `Throwable `__ throwable | ) @@ -2387,9 +2387,9 @@ trace :header-rows: 1 * - | public static **void** :ref:`trace ` ( - | `Throwable `__ throwable, - | `String `__ message, - | `java.lang.Object[] `__ args + | `Throwable `__ throwable, + | `String `__ message, + | `java.lang.Object[] `__ args | ) @@ -2412,7 +2412,7 @@ trace - - ``args`` - optional args used to format the message using `String.format(String, Object...) `__ . + - ``args`` - optional args used to format the message using `String.format(String, Object...) `__ . @@ -2505,8 +2505,8 @@ trace :header-rows: 1 * - | public static **void** :ref:`trace ` ( - | `String `__ message, - | `java.lang.Object[] `__ args + | `String `__ message, + | `java.lang.Object[] `__ args | ) @@ -2525,7 +2525,7 @@ trace - - ``args`` - optional args used to format the message using `String.format(String, Object...) `__ . + - ``args`` - optional args used to format the message using `String.format(String, Object...) `__ . @@ -2558,7 +2558,7 @@ trace :header-rows: 1 * - | public static **void** :ref:`trace ` ( - | `Throwable `__ throwable + | `Throwable `__ throwable | ) @@ -2755,9 +2755,9 @@ warn :header-rows: 1 * - | public static **void** :ref:`warn ` ( - | `Throwable `__ throwable, - | `String `__ message, - | `java.lang.Object[] `__ args + | `Throwable `__ throwable, + | `String `__ message, + | `java.lang.Object[] `__ args | ) @@ -2780,7 +2780,7 @@ warn - - ``args`` - optional args used to format the message using `String.format(String, Object...) `__ . + - ``args`` - optional args used to format the message using `String.format(String, Object...) `__ . @@ -2873,8 +2873,8 @@ warn :header-rows: 1 * - | public static **void** :ref:`warn ` ( - | `String `__ message, - | `java.lang.Object[] `__ args + | `String `__ message, + | `java.lang.Object[] `__ args | ) @@ -2893,7 +2893,7 @@ warn - - ``args`` - optional args used to format the message using `String.format(String, Object...) `__ . + - ``args`` - optional args used to format the message using `String.format(String, Object...) `__ . @@ -2926,7 +2926,7 @@ warn :header-rows: 1 * - | public static **void** :ref:`warn ` ( - | `Throwable `__ throwable + | `Throwable `__ throwable | ) diff --git a/source/sdk/java/api/io/realm/log/RealmLogger.txt b/source/sdk/java/api/io/realm/log/RealmLogger.txt index 86a24151b3..7a76d8da15 100644 --- a/source/sdk/java/api/io/realm/log/RealmLogger.txt +++ b/source/sdk/java/api/io/realm/log/RealmLogger.txt @@ -34,9 +34,9 @@ Method Summary * - public **void** - | :ref:`log ` ( | **int** level, - | `String `__ tag, - | `Throwable `__ throwable, - | `String `__ message + | `String `__ tag, + | `Throwable `__ throwable, + | `String `__ message | ) @@ -169,9 +169,9 @@ log * - | public **void** :ref:`log ` ( | **int** level, - | `String `__ tag, - | `Throwable `__ throwable, - | `String `__ message + | `String `__ tag, + | `Throwable `__ throwable, + | `String `__ message | ) diff --git a/source/sdk/java/api/io/realm/mongodb/App.txt b/source/sdk/java/api/io/realm/mongodb/App.txt index 592f7a0ee6..0dfbe302b9 100644 --- a/source/sdk/java/api/io/realm/mongodb/App.txt +++ b/source/sdk/java/api/io/realm/mongodb/App.txt @@ -18,7 +18,7 @@ io.realm.mongodb ================ - | `java.lang.Object `__ + | `java.lang.Object `__ | io.realm.mongodb.App @@ -173,7 +173,7 @@ Constructors * - Constructor and Description * - | :ref:`App ` ( - | `String `__ appId + | `String `__ appId | ) @@ -224,7 +224,7 @@ Field Summary * - Modifier and Type - Field and Description - * - public static `ThreadPoolExecutor `__ + * - public static `ThreadPoolExecutor `__ - :ref:`NETWORK_POOL_EXECUTOR ` @@ -257,7 +257,7 @@ Method Summary - * - public `Map `__ + * - public `Map `__ - | :ref:`allUsers ` () | @@ -281,7 +281,7 @@ Method Summary * - public **boolean** - | :ref:`equals ` ( - | `Object `__ o + | `Object `__ o | ) @@ -432,7 +432,7 @@ Inherited Methods -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` +- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` @@ -469,7 +469,7 @@ Constructor Detail :header-rows: 1 * - | public :ref:`App ` ( - | `String `__ appId + | `String `__ appId | ) @@ -604,7 +604,7 @@ addAuthenticationListener **Throws** - - `IllegalArgumentException `__ - if ``listener`` is ``null`` . + - `IllegalArgumentException `__ - if ``listener`` is ``null`` . @@ -639,7 +639,7 @@ allUsers .. list-table:: :header-rows: 1 - * - | public `Map `__ :ref:`allUsers ` () + * - | public `Map `__ :ref:`allUsers ` () | @@ -756,7 +756,7 @@ equals :header-rows: 1 * - | public **boolean** :ref:`equals ` ( - | `Object `__ o + | `Object `__ o | ) @@ -777,7 +777,7 @@ equals **Overrides** - ``equals`` in class `Object `__ + ``equals`` in class `Object `__ @@ -1106,7 +1106,7 @@ hashCode **Overrides** - ``hashCode`` in class `Object `__ + ``hashCode`` in class `Object `__ @@ -1336,7 +1336,7 @@ loginAsync **Throws** - - `IllegalStateException `__ - if not called on a looper thread. + - `IllegalStateException `__ - if not called on a looper thread. @@ -1505,16 +1505,10 @@ removeUser setNetworkTransport ------------------- -.. _io_realm_mongodb_App_setNetworkTransport_io_realm_internal_objectstore_OsJavaNetworkTransport_: - .. _io_realm_mongodb_App_setNetworkTransport_OsJavaNetworkTransport_: -.. _setNetworkTransport_io_realm_internal_objectstore_OsJavaNetworkTransport_: - .. _setNetworkTransport_OsJavaNetworkTransport_: -.. _App_setNetworkTransport_io_realm_internal_objectstore_OsJavaNetworkTransport_: - .. _App_setNetworkTransport_OsJavaNetworkTransport_: .. list-table:: @@ -1607,7 +1601,7 @@ switchUser **Throws** - - `IllegalArgumentException `__ - if the user is is not :ref:`User.State.LOGGED_IN ` . + - `IllegalArgumentException `__ - if the user is is not :ref:`User.State.LOGGED_IN ` . diff --git a/source/sdk/java/api/io/realm/mongodb/App/Result.txt b/source/sdk/java/api/io/realm/mongodb/App/Result.txt index e80e911cff..d12a2228b6 100644 --- a/source/sdk/java/api/io/realm/mongodb/App/Result.txt +++ b/source/sdk/java/api/io/realm/mongodb/App/Result.txt @@ -18,7 +18,7 @@ io.realm.mongodb ================ - | `java.lang.Object `__ + | `java.lang.Object `__ | io.realm.mongodb.App.Result @@ -147,7 +147,7 @@ Inherited Methods -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` +- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` diff --git a/source/sdk/java/api/io/realm/mongodb/AppConfiguration.txt b/source/sdk/java/api/io/realm/mongodb/AppConfiguration.txt index 08430e97b1..c3fc96d070 100644 --- a/source/sdk/java/api/io/realm/mongodb/AppConfiguration.txt +++ b/source/sdk/java/api/io/realm/mongodb/AppConfiguration.txt @@ -18,7 +18,7 @@ io.realm.mongodb ================ - | `java.lang.Object `__ + | `java.lang.Object `__ | io.realm.mongodb.AppConfiguration @@ -58,7 +58,7 @@ Field Summary * - Modifier and Type - Field and Description - * - public static final `String `__ + * - public static final `String `__ - :ref:`DEFAULT_AUTHORIZATION_HEADER_NAME ` @@ -66,7 +66,7 @@ Field Summary The default header name used to carry authorization data when making network requests towards MongoDB Realm. - * - public static final `String `__ + * - public static final `String `__ - :ref:`DEFAULT_BASE_URL ` @@ -92,7 +92,7 @@ Field Summary The default request timeout for network requests towards MongoDB Realm in seconds. - * - public static final `Map `__ + * - public static final `Map `__ - :ref:`loginObfuscators ` @@ -120,7 +120,7 @@ Method Summary * - public **boolean** - | :ref:`equals ` ( - | `Object `__ o + | `Object `__ o | ) @@ -129,7 +129,7 @@ Method Summary - * - public `String `__ + * - public `String `__ - | :ref:`getAppId ` () | @@ -139,7 +139,7 @@ Method Summary - * - public `String `__ + * - public `String `__ - | :ref:`getAppName ` () | @@ -149,7 +149,7 @@ Method Summary - * - public `String `__ + * - public `String `__ - | :ref:`getAppVersion ` () | @@ -159,7 +159,7 @@ Method Summary - * - public `String `__ + * - public `String `__ - | :ref:`getAuthorizationHeaderName ` () | @@ -169,7 +169,7 @@ Method Summary - * - public `URL `__ + * - public `URL `__ - | :ref:`getBaseUrl ` () | @@ -179,7 +179,7 @@ Method Summary - * - public `Map `__ + * - public `Map `__ - | :ref:`getCustomRequestHeaders ` () | @@ -225,6 +225,18 @@ Method Summary + * - public :ref:`SyncClientResetStrategy ` + - | :ref:`getDefaultSyncClientResetStrategy ` () + | + + + Returns the default sync client reset strategy used by synced Realms if there are problems with their :ref:`SyncSession ` . + + + + + + * - public **byte** - | :ref:`getEncryptionKey ` () | @@ -257,7 +269,7 @@ Method Summary - * - public `File `__ + * - public `File `__ - | :ref:`getSyncRootDirectory ` () | @@ -285,7 +297,7 @@ Inherited Methods -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` +- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` @@ -493,7 +505,7 @@ equals :header-rows: 1 * - | public **boolean** :ref:`equals ` ( - | `Object `__ o + | `Object `__ o | ) @@ -512,7 +524,7 @@ equals **Overrides** - ``equals`` in class `Object `__ + ``equals`` in class `Object `__ @@ -539,7 +551,7 @@ getAppId .. list-table:: :header-rows: 1 - * - | public `String `__ :ref:`getAppId ` () + * - | public `String `__ :ref:`getAppId ` () | @@ -586,7 +598,7 @@ getAppName .. list-table:: :header-rows: 1 - * - | public `String `__ :ref:`getAppName ` () + * - | public `String `__ :ref:`getAppName ` () | @@ -633,7 +645,7 @@ getAppVersion .. list-table:: :header-rows: 1 - * - | public `String `__ :ref:`getAppVersion ` () + * - | public `String `__ :ref:`getAppVersion ` () | @@ -680,7 +692,7 @@ getAuthorizationHeaderName .. list-table:: :header-rows: 1 - * - | public `String `__ :ref:`getAuthorizationHeaderName ` () + * - | public `String `__ :ref:`getAuthorizationHeaderName ` () | @@ -727,7 +739,7 @@ getBaseUrl .. list-table:: :header-rows: 1 - * - | public `URL `__ :ref:`getBaseUrl ` () + * - | public `URL `__ :ref:`getBaseUrl ` () | @@ -774,7 +786,7 @@ getCustomRequestHeaders .. list-table:: :header-rows: 1 - * - | public `Map `__ :ref:`getCustomRequestHeaders ` () + * - | public `Map `__ :ref:`getCustomRequestHeaders ` () | @@ -968,6 +980,55 @@ getDefaultErrorHandler +.. _getDefaultSyncClientResetStrategy: + +.. _getDefaultSyncClientResetStrategy__: + +.. _AppConfiguration_getDefaultSyncClientResetStrategy: + +.. _AppConfiguration_getDefaultSyncClientResetStrategy__: + +.. _io_realm_mongodb_AppConfiguration_getDefaultSyncClientResetStrategy: + +.. _io_realm_mongodb_AppConfiguration_getDefaultSyncClientResetStrategy__: + + + +getDefaultSyncClientResetStrategy +--------------------------------- + +.. list-table:: + :header-rows: 1 + + * - | public :ref:`SyncClientResetStrategy ` :ref:`getDefaultSyncClientResetStrategy ` () + | + + + + + * - Returns the default sync client reset strategy used by synced Realms if there are problems with their :ref:`SyncSession ` . + + + + + + + + + **Returns** + + the app default error handler. + + + + + + + + + + + .. _getEncryptionKey: .. _getEncryptionKey__: @@ -1133,7 +1194,7 @@ getSyncRootDirectory .. list-table:: :header-rows: 1 - * - | public `File `__ :ref:`getSyncRootDirectory ` () + * - | public `File `__ :ref:`getSyncRootDirectory ` () | @@ -1199,7 +1260,7 @@ hashCode **Overrides** - ``hashCode`` in class `Object `__ + ``hashCode`` in class `Object `__ diff --git a/source/sdk/java/api/io/realm/mongodb/AppConfiguration/Builder.txt b/source/sdk/java/api/io/realm/mongodb/AppConfiguration/Builder.txt index 810e9ea269..0ee82aabd2 100644 --- a/source/sdk/java/api/io/realm/mongodb/AppConfiguration/Builder.txt +++ b/source/sdk/java/api/io/realm/mongodb/AppConfiguration/Builder.txt @@ -18,7 +18,7 @@ io.realm.mongodb ================ - | `java.lang.Object `__ + | `java.lang.Object `__ | io.realm.mongodb.AppConfiguration.Builder @@ -44,7 +44,7 @@ Constructors * - Constructor and Description * - | :ref:`Builder ` ( - | `String `__ appId + | `String `__ appId | ) @@ -67,8 +67,8 @@ Method Summary * - public :ref:`AppConfiguration.Builder ` - | :ref:`addCustomRequestHeader ` ( - | `String `__ headerName, - | `String `__ headerValue + | `String `__ headerName, + | `String `__ headerValue | ) @@ -79,7 +79,7 @@ Method Summary * - public :ref:`AppConfiguration.Builder ` - | :ref:`addCustomRequestHeaders ` ( - | `java.util.Map\ `__ headers + | `java.util.Map\ `__ headers | ) @@ -90,7 +90,7 @@ Method Summary * - public :ref:`AppConfiguration.Builder ` - | :ref:`appName ` ( - | `String `__ appName + | `String `__ appName | ) @@ -101,7 +101,7 @@ Method Summary * - public :ref:`AppConfiguration.Builder ` - | :ref:`appVersion ` ( - | `String `__ appVersion + | `String `__ appVersion | ) @@ -112,7 +112,7 @@ Method Summary * - public :ref:`AppConfiguration.Builder ` - | :ref:`authorizationHeaderName ` ( - | `String `__ headerName + | `String `__ headerName | ) @@ -123,7 +123,7 @@ Method Summary * - public :ref:`AppConfiguration.Builder ` - | :ref:`baseUrl ` ( - | `String `__ baseUrl + | `String `__ baseUrl | ) @@ -166,6 +166,28 @@ Method Summary + * - public :ref:`AppConfiguration.Builder ` + - | :ref:`defaultSyncClientResetStrategy ` ( + | :ref:`DiscardUnsyncedChangesStrategy ` strategy + | ) + + + Sets the default sync client reset strategy used by Synced Realms when they report a Client Reset. + + + + + * - public :ref:`AppConfiguration.Builder ` + - | :ref:`defaultSyncClientResetStrategy ` ( + | :ref:`ManuallyRecoverUnsyncedChangesStrategy ` strategy + | ) + + + Sets the default sync client reset strategy used by Synced Realms when they report a Client Reset. + + + + * - public :ref:`AppConfiguration.Builder ` - | :ref:`defaultSyncErrorHandler ` ( | :ref:`SyncSession.ErrorHandler ` errorHandler @@ -204,7 +226,7 @@ Method Summary * - public :ref:`AppConfiguration.Builder ` - | :ref:`requestTimeout ` ( | **long** time, - | `TimeUnit `__ unit + | `TimeUnit `__ unit | ) @@ -215,7 +237,7 @@ Method Summary * - public :ref:`AppConfiguration.Builder ` - | :ref:`syncRootDirectory ` ( - | `File `__ rootDir + | `File `__ rootDir | ) @@ -232,7 +254,7 @@ Inherited Methods -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` +- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` @@ -252,7 +274,7 @@ Constructor Detail :header-rows: 1 * - | public :ref:`Builder ` ( - | `String `__ appId + | `String `__ appId | ) @@ -356,8 +378,8 @@ addCustomRequestHeader :header-rows: 1 * - | public :ref:`AppConfiguration.Builder ` :ref:`addCustomRequestHeader ` ( - | `String `__ headerName, - | `String `__ headerValue + | `String `__ headerName, + | `String `__ headerValue | ) @@ -386,7 +408,7 @@ addCustomRequestHeader **Throws** - - `IllegalArgumentException `__ - if a non-empty ``headerName`` is provided or a null ``headerValue`` . + - `IllegalArgumentException `__ - if a non-empty ``headerName`` is provided or a null ``headerValue`` . @@ -440,7 +462,7 @@ addCustomRequestHeaders :header-rows: 1 * - | public :ref:`AppConfiguration.Builder ` :ref:`addCustomRequestHeaders ` ( - | `java.util.Map\ `__ headers + | `java.util.Map\ `__ headers | ) @@ -465,7 +487,7 @@ addCustomRequestHeaders **Throws** - - `IllegalArgumentException `__ - If any of the headers provided are illegal. + - `IllegalArgumentException `__ - If any of the headers provided are illegal. @@ -515,7 +537,7 @@ appName :header-rows: 1 * - | public :ref:`AppConfiguration.Builder ` :ref:`appName ` ( - | `String `__ appName + | `String `__ appName | ) @@ -582,7 +604,7 @@ appVersion :header-rows: 1 * - | public :ref:`AppConfiguration.Builder ` :ref:`appVersion ` ( - | `String `__ appVersion + | `String `__ appVersion | ) @@ -649,7 +671,7 @@ authorizationHeaderName :header-rows: 1 * - | public :ref:`AppConfiguration.Builder ` :ref:`authorizationHeaderName ` ( - | `String `__ headerName + | `String `__ headerName | ) @@ -678,7 +700,7 @@ authorizationHeaderName **Throws** - - `IllegalArgumentException `__ - if a null or empty header is provided. + - `IllegalArgumentException `__ - if a null or empty header is provided. @@ -687,21 +709,6 @@ authorizationHeaderName - - .. seealso:: - - - - - `Adding a custom proxy `__ - - - - - - - - - @@ -743,7 +750,7 @@ baseUrl :header-rows: 1 * - | public :ref:`AppConfiguration.Builder ` :ref:`baseUrl ` ( - | `String `__ baseUrl + | `String `__ baseUrl | ) @@ -990,6 +997,125 @@ defaultClientResetHandler +.. _defaultSyncClientResetStrategy: + +.. _defaultSyncClientResetStrategy__: + +.. _Builder_defaultSyncClientResetStrategy: + +.. _Builder_defaultSyncClientResetStrategy__: + +.. _AppConfiguration_Builder_defaultSyncClientResetStrategy: + +.. _AppConfiguration_Builder_defaultSyncClientResetStrategy__: + +.. _io_realm_mongodb_AppConfiguration_Builder_defaultSyncClientResetStrategy: + +.. _io_realm_mongodb_AppConfiguration_Builder_defaultSyncClientResetStrategy__: + + + +defaultSyncClientResetStrategy +------------------------------ + +.. _io_realm_mongodb_AppConfiguration_Builder_defaultSyncClientResetStrategy_io_realm_mongodb_sync_DiscardUnsyncedChangesStrategy_: + +.. _io_realm_mongodb_AppConfiguration_Builder_defaultSyncClientResetStrategy_DiscardUnsyncedChangesStrategy_: + +.. _defaultSyncClientResetStrategy_io_realm_mongodb_sync_DiscardUnsyncedChangesStrategy_: + +.. _defaultSyncClientResetStrategy_DiscardUnsyncedChangesStrategy_: + +.. _AppConfiguration_Builder_defaultSyncClientResetStrategy_io_realm_mongodb_sync_DiscardUnsyncedChangesStrategy_: + +.. _AppConfiguration_Builder_defaultSyncClientResetStrategy_DiscardUnsyncedChangesStrategy_: + +.. list-table:: + :header-rows: 1 + + * - | public :ref:`AppConfiguration.Builder ` :ref:`defaultSyncClientResetStrategy ` ( + | :ref:`DiscardUnsyncedChangesStrategy ` strategy + | ) + + + + + * - Sets the default sync client reset strategy used by Synced Realms when they report a Client Reset. session.This default can be overridden by calling :ref:`io.realm.mongodb.sync.SyncConfiguration.Builder.syncClientResetStrategy(ManuallyRecoverUnsyncedChangesStrategy) ` or :ref:`io.realm.mongodb.sync.SyncConfiguration.Builder.syncClientResetStrategy(DiscardUnsyncedChangesStrategy) ` when creating the :ref:`io.realm.mongodb.sync.SyncConfiguration ` . + + + + + + + + + **Parameters** + + - ``strategy`` - the default sync client reset strategy. + + + + + + + + + + + + + + +.. _io_realm_mongodb_AppConfiguration_Builder_defaultSyncClientResetStrategy_io_realm_mongodb_sync_ManuallyRecoverUnsyncedChangesStrategy_: + +.. _io_realm_mongodb_AppConfiguration_Builder_defaultSyncClientResetStrategy_ManuallyRecoverUnsyncedChangesStrategy_: + +.. _defaultSyncClientResetStrategy_io_realm_mongodb_sync_ManuallyRecoverUnsyncedChangesStrategy_: + +.. _defaultSyncClientResetStrategy_ManuallyRecoverUnsyncedChangesStrategy_: + +.. _AppConfiguration_Builder_defaultSyncClientResetStrategy_io_realm_mongodb_sync_ManuallyRecoverUnsyncedChangesStrategy_: + +.. _AppConfiguration_Builder_defaultSyncClientResetStrategy_ManuallyRecoverUnsyncedChangesStrategy_: + +.. list-table:: + :header-rows: 1 + + * - | public :ref:`AppConfiguration.Builder ` :ref:`defaultSyncClientResetStrategy ` ( + | :ref:`ManuallyRecoverUnsyncedChangesStrategy ` strategy + | ) + + + + + * - Sets the default sync client reset strategy used by Synced Realms when they report a Client Reset. session.This default can be overridden by calling :ref:`io.realm.mongodb.sync.SyncConfiguration.Builder.syncClientResetStrategy(ManuallyRecoverUnsyncedChangesStrategy) ` or :ref:`io.realm.mongodb.sync.SyncConfiguration.Builder.syncClientResetStrategy(DiscardUnsyncedChangesStrategy) ` when creating the :ref:`io.realm.mongodb.sync.SyncConfiguration ` . + + + + + + + + + **Parameters** + + - ``strategy`` - the default sync client reset strategy. + + + + + + + + + + + + + + + + .. _defaultSyncErrorHandler: .. _defaultSyncErrorHandler__: @@ -1133,7 +1259,7 @@ encryptionKey **Throws** - - `IllegalArgumentException `__ - if the key is not 64 bytes long. + - `IllegalArgumentException `__ - if the key is not 64 bytes long. @@ -1267,7 +1393,7 @@ requestTimeout * - | public :ref:`AppConfiguration.Builder ` :ref:`requestTimeout ` ( | **long** time, - | `TimeUnit `__ unit + | `TimeUnit `__ unit | ) @@ -1340,7 +1466,7 @@ syncRootDirectory :header-rows: 1 * - | public :ref:`AppConfiguration.Builder ` :ref:`syncRootDirectory ` ( - | `File `__ rootDir + | `File `__ rootDir | ) diff --git a/source/sdk/java/api/io/realm/mongodb/AppException.txt b/source/sdk/java/api/io/realm/mongodb/AppException.txt index 3bd67fc232..6ca811e5d8 100644 --- a/source/sdk/java/api/io/realm/mongodb/AppException.txt +++ b/source/sdk/java/api/io/realm/mongodb/AppException.txt @@ -18,10 +18,10 @@ io.realm.mongodb ================ - | `java.lang.Object `__ - | `java.lang.Throwable `__ - | `java.lang.Exception `__ - | `java.lang.RuntimeException `__ + | `java.lang.Object `__ + | `java.lang.Throwable `__ + | `java.lang.Exception `__ + | `java.lang.RuntimeException `__ | io.realm.mongodb.AppException @@ -54,7 +54,7 @@ Constructors * - | :ref:`AppException ` ( | :ref:`ErrorCode ` errorCode, - | `String `__ errorMessage + | `String `__ errorMessage | ) @@ -64,9 +64,9 @@ Constructors * - | :ref:`AppException ` ( - | `String `__ errorType, + | `String `__ errorType, | **int** errorCode, - | `String `__ errorMessage + | `String `__ errorMessage | ) @@ -77,7 +77,7 @@ Constructors * - | :ref:`AppException ` ( | :ref:`ErrorCode ` errorCode, - | `Throwable `__ exception + | `Throwable `__ exception | ) @@ -88,8 +88,8 @@ Constructors * - | :ref:`AppException ` ( | :ref:`ErrorCode ` errorCode, - | `String `__ title, - | `String `__ hint + | `String `__ title, + | `String `__ hint | ) @@ -100,8 +100,8 @@ Constructors * - | :ref:`AppException ` ( | :ref:`ErrorCode ` errorCode, - | `String `__ errorMessage, - | `Throwable `__ exception + | `String `__ errorMessage, + | `Throwable `__ exception | ) @@ -112,10 +112,10 @@ Constructors * - | :ref:`AppException ` ( | :ref:`ErrorCode ` errorCode, - | `String `__ nativeErrorType, + | `String `__ nativeErrorType, | **int** nativeErrorCode, - | `String `__ errorMessage, - | `Throwable `__ exception + | `String `__ errorMessage, + | `Throwable `__ exception | ) @@ -170,7 +170,7 @@ Method Summary - * - public `String `__ + * - public `String `__ - | :ref:`getErrorMessage ` () | @@ -180,7 +180,7 @@ Method Summary - * - public `String `__ + * - public `String `__ - | :ref:`getErrorType ` () | @@ -190,7 +190,7 @@ Method Summary - * - public `Throwable `__ + * - public `Throwable `__ - | :ref:`getException ` () | @@ -200,7 +200,7 @@ Method Summary - * - public `String `__ + * - public `String `__ - | :ref:`toString ` () | @@ -218,8 +218,8 @@ Inherited Methods -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` -- Methods inherited from class `java.lang.Throwable `__ : ``getMessage`` , ``getLocalizedMessage`` , ``getCause`` , ``initCause`` , ``toString`` , ``printStackTrace`` , ``printStackTrace`` , ``printStackTrace`` , ``fillInStackTrace`` , ``getStackTrace`` , ``setStackTrace`` , ``addSuppressed`` , ``getSuppressed`` +- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` +- Methods inherited from class `java.lang.Throwable `__ : ``getMessage`` , ``getLocalizedMessage`` , ``getCause`` , ``initCause`` , ``toString`` , ``printStackTrace`` , ``printStackTrace`` , ``printStackTrace`` , ``fillInStackTrace`` , ``getStackTrace`` , ``setStackTrace`` , ``addSuppressed`` , ``getSuppressed`` @@ -240,7 +240,7 @@ Constructor Detail * - | public :ref:`AppException ` ( | :ref:`ErrorCode ` errorCode, - | `String `__ errorMessage + | `String `__ errorMessage | ) @@ -282,9 +282,9 @@ Constructor Detail :header-rows: 1 * - | public :ref:`AppException ` ( - | `String `__ errorType, + | `String `__ errorType, | **int** errorCode, - | `String `__ errorMessage + | `String `__ errorMessage | ) @@ -331,7 +331,7 @@ Constructor Detail * - | public :ref:`AppException ` ( | :ref:`ErrorCode ` errorCode, - | `Throwable `__ exception + | `Throwable `__ exception | ) @@ -374,8 +374,8 @@ Constructor Detail * - | public :ref:`AppException ` ( | :ref:`ErrorCode ` errorCode, - | `String `__ title, - | `String `__ hint + | `String `__ title, + | `String `__ hint | ) @@ -422,8 +422,8 @@ Constructor Detail * - | public :ref:`AppException ` ( | :ref:`ErrorCode ` errorCode, - | `String `__ errorMessage, - | `Throwable `__ exception + | `String `__ errorMessage, + | `Throwable `__ exception | ) @@ -470,10 +470,10 @@ Constructor Detail * - | public :ref:`AppException ` ( | :ref:`ErrorCode ` errorCode, - | `String `__ nativeErrorType, + | `String `__ nativeErrorType, | **int** nativeErrorCode, - | `String `__ errorMessage, - | `Throwable `__ exception + | `String `__ errorMessage, + | `Throwable `__ exception | ) @@ -681,7 +681,7 @@ getErrorMessage .. list-table:: :header-rows: 1 - * - | public `String `__ :ref:`getErrorMessage ` () + * - | public `String `__ :ref:`getErrorMessage ` () | @@ -730,7 +730,7 @@ getErrorType .. list-table:: :header-rows: 1 - * - | public `String `__ :ref:`getErrorType ` () + * - | public `String `__ :ref:`getErrorType ` () | @@ -777,7 +777,7 @@ getException .. list-table:: :header-rows: 1 - * - | public `Throwable `__ :ref:`getException ` () + * - | public `Throwable `__ :ref:`getException ` () | @@ -826,7 +826,7 @@ toString .. list-table:: :header-rows: 1 - * - | public `String `__ :ref:`toString ` () + * - | public `String `__ :ref:`toString ` () | @@ -845,7 +845,7 @@ toString **Overrides** - ``toString`` in class `Throwable `__ + ``toString`` in class `Throwable `__ diff --git a/source/sdk/java/api/io/realm/mongodb/Credentials.txt b/source/sdk/java/api/io/realm/mongodb/Credentials.txt index bd67365575..c10df78fab 100644 --- a/source/sdk/java/api/io/realm/mongodb/Credentials.txt +++ b/source/sdk/java/api/io/realm/mongodb/Credentials.txt @@ -18,7 +18,7 @@ io.realm.mongodb ================ - | `java.lang.Object `__ + | `java.lang.Object `__ | io.realm.mongodb.Credentials @@ -59,7 +59,7 @@ Credentials are used the following way: - - `Authentication Providers `__ + - `Authentication Providers `__ @@ -107,7 +107,7 @@ Method Summary * - public static :ref:`Credentials ` - | :ref:`apiKey ` ( - | `String `__ key + | `String `__ key | ) @@ -118,7 +118,7 @@ Method Summary * - public static :ref:`Credentials ` - | :ref:`apple ` ( - | `String `__ idToken + | `String `__ idToken | ) @@ -127,7 +127,7 @@ Method Summary - * - public `String `__ + * - public `String `__ - | :ref:`asJson ` () | @@ -152,8 +152,8 @@ Method Summary * - public static :ref:`Credentials ` - | :ref:`emailPassword ` ( - | `String `__ email, - | `String `__ password + | `String `__ email, + | `String `__ password | ) @@ -164,7 +164,7 @@ Method Summary * - public static :ref:`Credentials ` - | :ref:`facebook ` ( - | `String `__ accessToken + | `String `__ accessToken | ) @@ -185,18 +185,34 @@ Method Summary * - public static :ref:`Credentials ` - | :ref:`google ` ( - | `String `__ authorizationCode + | `String `__ authorizationCode | ) - Creates credentials representing a login using a Google Authorization Code. + Creates credentials representing a login using a :ref:`GoogleAuthType.AUTH_CODE ` Google access token. + + + + + + + * - public static :ref:`Credentials ` + - | :ref:`google ` ( + | `String `__ token, + | :ref:`GoogleAuthType ` type + | ) + + + Creates credentials representing a login using a Google access token of a given :ref:`GoogleAuthType ` . + + * - public static :ref:`Credentials ` - | :ref:`jwt ` ( - | `String `__ jwtToken + | `String `__ jwtToken | ) @@ -213,7 +229,7 @@ Inherited Methods -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` +- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` @@ -307,7 +323,7 @@ apiKey :header-rows: 1 * - | public static :ref:`Credentials ` :ref:`apiKey ` ( - | `String `__ key + | `String `__ key | ) @@ -379,7 +395,7 @@ apple :header-rows: 1 * - | public static :ref:`Credentials ` :ref:`apple ` ( - | `String `__ idToken + | `String `__ idToken | ) @@ -438,7 +454,7 @@ asJson .. list-table:: :header-rows: 1 - * - | public `String `__ :ref:`asJson ` () + * - | public `String `__ :ref:`asJson ` () | @@ -602,8 +618,8 @@ emailPassword :header-rows: 1 * - | public static :ref:`Credentials ` :ref:`emailPassword ` ( - | `String `__ email, - | `String `__ password + | `String `__ email, + | `String `__ password | ) @@ -677,7 +693,7 @@ facebook :header-rows: 1 * - | public static :ref:`Credentials ` :ref:`facebook ` ( - | `String `__ accessToken + | `String `__ accessToken | ) @@ -796,13 +812,15 @@ google :header-rows: 1 * - | public static :ref:`Credentials ` :ref:`google ` ( - | `String `__ authorizationCode + | `String `__ authorizationCode | ) - * - Creates credentials representing a login using a Google Authorization Code.This provider must be enabled on MongoDB Realm to work. + * - Creates credentials representing a login using a :ref:`GoogleAuthType.AUTH_CODE ` Google access token. + + This provider must be enabled on MongoDB Realm to work. @@ -833,6 +851,102 @@ google +.. _io_realm_mongodb_Credentials_google_java_lang_String_io_realm_mongodb_auth_GoogleAuthType_: + +.. _io_realm_mongodb_Credentials_google_java_lang_String__io_realm_mongodb_auth_GoogleAuthType_: + +.. _io_realm_mongodb_Credentials_google_java_lang_String_GoogleAuthType_: + +.. _io_realm_mongodb_Credentials_google_java_lang_String__GoogleAuthType_: + +.. _io_realm_mongodb_Credentials_google_String_io_realm_mongodb_auth_GoogleAuthType_: + +.. _io_realm_mongodb_Credentials_google_String__io_realm_mongodb_auth_GoogleAuthType_: + +.. _io_realm_mongodb_Credentials_google_String_GoogleAuthType_: + +.. _io_realm_mongodb_Credentials_google_String__GoogleAuthType_: + +.. _google_java_lang_String_io_realm_mongodb_auth_GoogleAuthType_: + +.. _google_java_lang_String__io_realm_mongodb_auth_GoogleAuthType_: + +.. _google_java_lang_String_GoogleAuthType_: + +.. _google_java_lang_String__GoogleAuthType_: + +.. _google_String_io_realm_mongodb_auth_GoogleAuthType_: + +.. _google_String__io_realm_mongodb_auth_GoogleAuthType_: + +.. _google_String_GoogleAuthType_: + +.. _google_String__GoogleAuthType_: + +.. _Credentials_google_java_lang_String_io_realm_mongodb_auth_GoogleAuthType_: + +.. _Credentials_google_java_lang_String__io_realm_mongodb_auth_GoogleAuthType_: + +.. _Credentials_google_java_lang_String_GoogleAuthType_: + +.. _Credentials_google_java_lang_String__GoogleAuthType_: + +.. _Credentials_google_String_io_realm_mongodb_auth_GoogleAuthType_: + +.. _Credentials_google_String__io_realm_mongodb_auth_GoogleAuthType_: + +.. _Credentials_google_String_GoogleAuthType_: + +.. _Credentials_google_String__GoogleAuthType_: + +.. list-table:: + :header-rows: 1 + + * - | public static :ref:`Credentials ` :ref:`google ` ( + | `String `__ token, + | :ref:`GoogleAuthType ` type + | ) + + + + + * - Creates credentials representing a login using a Google access token of a given :ref:`GoogleAuthType ` . + + This provider must be enabled on MongoDB Realm to work. + + + + + + + **Parameters** + + - ``token`` - the access token returned when logging in to Google. + + + + - ``type`` - the access token type + + + + + + + + **Returns** + + a set of credentials that can be used to log into MongoDB Realm using :ref:`App.loginAsync(Credentials, App.Callback) ` . + + + + + + + + + + + .. _jwt: @@ -868,7 +982,7 @@ jwt :header-rows: 1 * - | public static :ref:`Credentials ` :ref:`jwt ` ( - | `String `__ jwtToken + | `String `__ jwtToken | ) diff --git a/source/sdk/java/api/io/realm/mongodb/Credentials/Provider.txt b/source/sdk/java/api/io/realm/mongodb/Credentials/Provider.txt index 6b1f5e0da5..4ab94e049e 100644 --- a/source/sdk/java/api/io/realm/mongodb/Credentials/Provider.txt +++ b/source/sdk/java/api/io/realm/mongodb/Credentials/Provider.txt @@ -18,8 +18,8 @@ io.realm.mongodb ================ - | `java.lang.Object `__ - | `java.lang.Enum `__ + | `java.lang.Object `__ + | `java.lang.Enum `__ | io.realm.mongodb.Credentials.Provider @@ -40,7 +40,7 @@ This enum contains the list of identity providers supported by MongoDB Realm. Al - - `Authentication Providers `__ + - `Authentication Providers `__ @@ -136,7 +136,7 @@ Method Summary * - public static :ref:`Credentials.Provider ` - | :ref:`fromId ` ( - | `String `__ id + | `String `__ id | ) @@ -145,7 +145,7 @@ Method Summary - * - public `String `__ + * - public `String `__ - | :ref:`getId ` () | @@ -157,7 +157,7 @@ Method Summary * - public static :ref:`Credentials.Provider ` - | :ref:`valueOf ` ( - | `String `__ name + | `String `__ name | ) @@ -184,8 +184,8 @@ Inherited Methods -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` -- Methods inherited from class `java.lang.Enum `__ : ``name`` , ``ordinal`` , ``toString`` , ``equals`` , ``hashCode`` , ``clone`` , ``compareTo`` , ``getDeclaringClass`` , ``valueOf`` , ``finalize`` +- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` +- Methods inherited from class `java.lang.Enum `__ : ``name`` , ``ordinal`` , ``toString`` , ``equals`` , ``hashCode`` , ``clone`` , ``compareTo`` , ``getDeclaringClass`` , ``valueOf`` , ``finalize`` @@ -370,7 +370,7 @@ fromId :header-rows: 1 * - | public static :ref:`Credentials.Provider ` :ref:`fromId ` ( - | `String `__ id + | `String `__ id | ) @@ -431,7 +431,7 @@ getId .. list-table:: :header-rows: 1 - * - | public `String `__ :ref:`getId ` () + * - | public `String `__ :ref:`getId ` () | @@ -490,7 +490,7 @@ valueOf :header-rows: 1 * - | public static :ref:`Credentials.Provider ` :ref:`valueOf ` ( - | `String `__ name + | `String `__ name | ) diff --git a/source/sdk/java/api/io/realm/mongodb/ErrorCode.txt b/source/sdk/java/api/io/realm/mongodb/ErrorCode.txt index 488459eaa1..4076d15441 100644 --- a/source/sdk/java/api/io/realm/mongodb/ErrorCode.txt +++ b/source/sdk/java/api/io/realm/mongodb/ErrorCode.txt @@ -18,8 +18,8 @@ io.realm.mongodb ================ - | `java.lang.Object `__ - | `java.lang.Enum `__ + | `java.lang.Object `__ + | `java.lang.Enum `__ | io.realm.mongodb.ErrorCode @@ -110,6 +110,13 @@ Enum Constant Summary + * - :ref:`AUTO_CLIENT_RESET_FAILURE ` + + + + + + * - :ref:`AWS_ERROR ` @@ -201,6 +208,13 @@ Enum Constant Summary + * - :ref:`BAD_QUERY ` + + + + + + * - :ref:`BAD_REQUEST ` @@ -733,6 +747,13 @@ Enum Constant Summary + * - :ref:`INITIAL_SYNC_NOT_COMPLETE ` + + + + + + * - :ref:`INSUFFICIENT_STORAGE ` @@ -747,6 +768,13 @@ Enum Constant Summary + * - :ref:`INVALID_EMAIL_PASSWORD ` + + + + + + * - :ref:`INVALID_PARAMETER ` @@ -943,6 +971,13 @@ Enum Constant Summary + * - :ref:`OBJECT_ALREADY_EXISTS ` + + + + + + * - :ref:`OTHER_ERROR ` @@ -1090,6 +1125,13 @@ Enum Constant Summary + * - :ref:`SERVER_PERMISSIONS_CHANGED ` + + + + + + * - :ref:`SERVICE_ALREADY_EXISTS ` @@ -1335,6 +1377,13 @@ Enum Constant Summary + * - :ref:`WRITE_NOT_ALLOWED ` + + + + + + * - :ref:`WRONG_PROTOCOL_VERSION ` @@ -1356,7 +1405,7 @@ Method Summary * - public static :ref:`ErrorCode ` - | :ref:`fromNativeError ` ( - | `String `__ type, + | `String `__ type, | **int** errorCode | ) @@ -1376,7 +1425,7 @@ Method Summary - * - public `String `__ + * - public `String `__ - | :ref:`getType ` () | @@ -1396,7 +1445,7 @@ Method Summary - * - public `String `__ + * - public `String `__ - | :ref:`toString ` () | @@ -1408,7 +1457,7 @@ Method Summary * - public static :ref:`ErrorCode ` - | :ref:`valueOf ` ( - | `String `__ name + | `String `__ name | ) @@ -1435,8 +1484,8 @@ Inherited Methods -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` -- Methods inherited from class `java.lang.Enum `__ : ``name`` , ``ordinal`` , ``toString`` , ``equals`` , ``hashCode`` , ``clone`` , ``compareTo`` , ``getDeclaringClass`` , ``valueOf`` , ``finalize`` +- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` +- Methods inherited from class `java.lang.Enum `__ : ``name`` , ``ordinal`` , ``toString`` , ``equals`` , ``hashCode`` , ``clone`` , ``compareTo`` , ``getDeclaringClass`` , ``valueOf`` , ``finalize`` @@ -1565,6 +1614,21 @@ public static final :ref:`ErrorCode ` +.. _io_realm_mongodb_ErrorCode_AUTO_CLIENT_RESET_FAILURE: + +.. _ErrorCode_AUTO_CLIENT_RESET_FAILURE: + + + +``AUTO_CLIENT_RESET_FAILURE`` +------------------------------ + +public static final :ref:`ErrorCode ` + + + + + .. _io_realm_mongodb_ErrorCode_AWS_ERROR: .. _ErrorCode_AWS_ERROR: @@ -1760,6 +1824,21 @@ public static final :ref:`ErrorCode ` +.. _io_realm_mongodb_ErrorCode_BAD_QUERY: + +.. _ErrorCode_BAD_QUERY: + + + +``BAD_QUERY`` +-------------- + +public static final :ref:`ErrorCode ` + + + + + .. _io_realm_mongodb_ErrorCode_BAD_REQUEST: .. _ErrorCode_BAD_REQUEST: @@ -2900,6 +2979,21 @@ public static final :ref:`ErrorCode ` +.. _io_realm_mongodb_ErrorCode_INITIAL_SYNC_NOT_COMPLETE: + +.. _ErrorCode_INITIAL_SYNC_NOT_COMPLETE: + + + +``INITIAL_SYNC_NOT_COMPLETE`` +------------------------------ + +public static final :ref:`ErrorCode ` + + + + + .. _io_realm_mongodb_ErrorCode_INSUFFICIENT_STORAGE: .. _ErrorCode_INSUFFICIENT_STORAGE: @@ -2930,6 +3024,21 @@ public static final :ref:`ErrorCode ` +.. _io_realm_mongodb_ErrorCode_INVALID_EMAIL_PASSWORD: + +.. _ErrorCode_INVALID_EMAIL_PASSWORD: + + + +``INVALID_EMAIL_PASSWORD`` +--------------------------- + +public static final :ref:`ErrorCode ` + + + + + .. _io_realm_mongodb_ErrorCode_INVALID_PARAMETER: .. _ErrorCode_INVALID_PARAMETER: @@ -3350,6 +3459,21 @@ public static final :ref:`ErrorCode ` +.. _io_realm_mongodb_ErrorCode_OBJECT_ALREADY_EXISTS: + +.. _ErrorCode_OBJECT_ALREADY_EXISTS: + + + +``OBJECT_ALREADY_EXISTS`` +-------------------------- + +public static final :ref:`ErrorCode ` + + + + + .. _io_realm_mongodb_ErrorCode_OTHER_ERROR: .. _ErrorCode_OTHER_ERROR: @@ -3665,6 +3789,21 @@ public static final :ref:`ErrorCode ` +.. _io_realm_mongodb_ErrorCode_SERVER_PERMISSIONS_CHANGED: + +.. _ErrorCode_SERVER_PERMISSIONS_CHANGED: + + + +``SERVER_PERMISSIONS_CHANGED`` +------------------------------- + +public static final :ref:`ErrorCode ` + + + + + .. _io_realm_mongodb_ErrorCode_SERVICE_ALREADY_EXISTS: .. _ErrorCode_SERVICE_ALREADY_EXISTS: @@ -4190,6 +4329,21 @@ public static final :ref:`ErrorCode ` +.. _io_realm_mongodb_ErrorCode_WRITE_NOT_ALLOWED: + +.. _ErrorCode_WRITE_NOT_ALLOWED: + + + +``WRITE_NOT_ALLOWED`` +---------------------- + +public static final :ref:`ErrorCode ` + + + + + .. _io_realm_mongodb_ErrorCode_WRONG_PROTOCOL_VERSION: .. _ErrorCode_WRONG_PROTOCOL_VERSION: @@ -4254,7 +4408,7 @@ fromNativeError :header-rows: 1 * - | public static :ref:`ErrorCode ` :ref:`fromNativeError ` ( - | `String `__ type, + | `String `__ type, | **int** errorCode | ) @@ -4371,7 +4525,7 @@ getType .. list-table:: :header-rows: 1 - * - | public `String `__ :ref:`getType ` () + * - | public `String `__ :ref:`getType ` () | @@ -4471,7 +4625,7 @@ toString .. list-table:: :header-rows: 1 - * - | public `String `__ :ref:`toString ` () + * - | public `String `__ :ref:`toString ` () | @@ -4490,7 +4644,7 @@ toString **Overrides** - ``toString`` in class `Enum `__ + ``toString`` in class `Enum `__ @@ -4530,7 +4684,7 @@ valueOf :header-rows: 1 * - | public static :ref:`ErrorCode ` :ref:`valueOf ` ( - | `String `__ name + | `String `__ name | ) diff --git a/source/sdk/java/api/io/realm/mongodb/ErrorCode/Category.txt b/source/sdk/java/api/io/realm/mongodb/ErrorCode/Category.txt index 4de87803ec..c5c6253c28 100644 --- a/source/sdk/java/api/io/realm/mongodb/ErrorCode/Category.txt +++ b/source/sdk/java/api/io/realm/mongodb/ErrorCode/Category.txt @@ -18,8 +18,8 @@ io.realm.mongodb ================ - | `java.lang.Object `__ - | `java.lang.Enum `__ + | `java.lang.Object `__ + | `java.lang.Enum `__ | io.realm.mongodb.ErrorCode.Category @@ -70,7 +70,7 @@ Method Summary * - public static :ref:`ErrorCode.Category ` - | :ref:`valueOf ` ( - | `String `__ name + | `String `__ name | ) @@ -97,8 +97,8 @@ Inherited Methods -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` -- Methods inherited from class `java.lang.Enum `__ : ``name`` , ``ordinal`` , ``toString`` , ``equals`` , ``hashCode`` , ``clone`` , ``compareTo`` , ``getDeclaringClass`` , ``valueOf`` , ``finalize`` +- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` +- Methods inherited from class `java.lang.Enum `__ : ``name`` , ``ordinal`` , ``toString`` , ``equals`` , ``hashCode`` , ``clone`` , ``compareTo`` , ``getDeclaringClass`` , ``valueOf`` , ``finalize`` @@ -178,7 +178,7 @@ valueOf :header-rows: 1 * - | public static :ref:`ErrorCode.Category ` :ref:`valueOf ` ( - | `String `__ name + | `String `__ name | ) diff --git a/source/sdk/java/api/io/realm/mongodb/ErrorCode/Type.txt b/source/sdk/java/api/io/realm/mongodb/ErrorCode/Type.txt index 8fd45ceb76..9dd9a197e5 100644 --- a/source/sdk/java/api/io/realm/mongodb/ErrorCode/Type.txt +++ b/source/sdk/java/api/io/realm/mongodb/ErrorCode/Type.txt @@ -18,7 +18,7 @@ io.realm.mongodb ================ - | `java.lang.Object `__ + | `java.lang.Object `__ | io.realm.mongodb.ErrorCode.Type @@ -62,7 +62,7 @@ Field Summary * - Modifier and Type - Field and Description - * - public static final `String `__ + * - public static final `String `__ - :ref:`AUTH ` @@ -70,7 +70,7 @@ Field Summary - * - public static final `String `__ + * - public static final `String `__ - :ref:`CONNECTION ` @@ -78,7 +78,7 @@ Field Summary - * - public static final `String `__ + * - public static final `String `__ - :ref:`DEPRECATED ` @@ -86,7 +86,7 @@ Field Summary - * - public static final `String `__ + * - public static final `String `__ - :ref:`HTTP ` @@ -94,7 +94,7 @@ Field Summary - * - public static final `String `__ + * - public static final `String `__ - :ref:`JAVA ` @@ -102,7 +102,7 @@ Field Summary - * - public static final `String `__ + * - public static final `String `__ - :ref:`JSON ` @@ -110,7 +110,7 @@ Field Summary - * - public static final `String `__ + * - public static final `String `__ - :ref:`MISC ` @@ -118,7 +118,7 @@ Field Summary - * - public static final `String `__ + * - public static final `String `__ - :ref:`PROTOCOL ` @@ -126,7 +126,7 @@ Field Summary - * - public static final `String `__ + * - public static final `String `__ - :ref:`SERVICE ` @@ -134,7 +134,7 @@ Field Summary - * - public static final `String `__ + * - public static final `String `__ - :ref:`SESSION ` @@ -142,7 +142,7 @@ Field Summary - * - public static final `String `__ + * - public static final `String `__ - :ref:`UNKNOWN ` @@ -158,7 +158,7 @@ Inherited Methods -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` +- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` diff --git a/source/sdk/java/api/io/realm/mongodb/RealmEventStreamAsyncTask.txt b/source/sdk/java/api/io/realm/mongodb/RealmEventStreamAsyncTask.txt index 33a1e1c59f..9c37fc2acb 100644 --- a/source/sdk/java/api/io/realm/mongodb/RealmEventStreamAsyncTask.txt +++ b/source/sdk/java/api/io/realm/mongodb/RealmEventStreamAsyncTask.txt @@ -138,7 +138,7 @@ get **Throws** - - `IllegalStateException `__ - if the stream is already open. + - `IllegalStateException `__ - if the stream is already open. diff --git a/source/sdk/java/api/io/realm/mongodb/RealmEventStreamTask.txt b/source/sdk/java/api/io/realm/mongodb/RealmEventStreamTask.txt index 6e89cfd356..250aa9a82a 100644 --- a/source/sdk/java/api/io/realm/mongodb/RealmEventStreamTask.txt +++ b/source/sdk/java/api/io/realm/mongodb/RealmEventStreamTask.txt @@ -115,7 +115,7 @@ getNext - - `IOException `__ - if something is wrong with the input stream + - `IOException `__ - if something is wrong with the input stream diff --git a/source/sdk/java/api/io/realm/mongodb/RealmResultTask.txt b/source/sdk/java/api/io/realm/mongodb/RealmResultTask.txt index 346b617047..ef6d6daf61 100644 --- a/source/sdk/java/api/io/realm/mongodb/RealmResultTask.txt +++ b/source/sdk/java/api/io/realm/mongodb/RealmResultTask.txt @@ -189,7 +189,7 @@ getAsync **Throws** - - `IllegalStateException `__ - if called from a thread without a `android.os.Looper `__ or from an `android.app.IntentService `__ thread. + - `IllegalStateException `__ - if called from a thread without a `android.os.Looper `__ or from an `android.app.IntentService `__ thread. diff --git a/source/sdk/java/api/io/realm/mongodb/User.txt b/source/sdk/java/api/io/realm/mongodb/User.txt index 96d1d4cd05..ffe5c47fd6 100644 --- a/source/sdk/java/api/io/realm/mongodb/User.txt +++ b/source/sdk/java/api/io/realm/mongodb/User.txt @@ -18,7 +18,7 @@ io.realm.mongodb ================ - | `java.lang.Object `__ + | `java.lang.Object `__ | io.realm.mongodb.User @@ -76,7 +76,7 @@ Method Summary * - public **boolean** - | :ref:`equals ` ( - | `Object `__ o + | `Object `__ o | ) @@ -85,7 +85,7 @@ Method Summary - * - public `String `__ + * - public `String `__ - | :ref:`getAccessToken ` () | @@ -127,7 +127,7 @@ Method Summary - * - public `String `__ + * - public `String `__ - | :ref:`getDeviceId ` () | @@ -158,7 +158,7 @@ Method Summary - * - public `String `__ + * - public `String `__ - | :ref:`getId ` () | @@ -168,7 +168,7 @@ Method Summary - * - public `List `__ + * - public `List `__ - | :ref:`getIdentities ` () | @@ -180,7 +180,7 @@ Method Summary * - public synchronized :ref:`MongoClient ` - | :ref:`getMongoClient ` ( - | `String `__ serviceName + | `String `__ serviceName | ) @@ -213,7 +213,7 @@ Method Summary * - public synchronized :ref:`Push ` - | :ref:`getPush ` ( - | `String `__ serviceName + | `String `__ serviceName | ) @@ -224,7 +224,7 @@ Method Summary - * - public `String `__ + * - public `String `__ - | :ref:`getRefreshToken ` () | @@ -331,6 +331,27 @@ Method Summary + * - public :ref:`User ` + - | :ref:`remove ` () + | + + + Calling this will remove the user and any Realms the user has from the device. + + + + + * - public :ref:`RealmAsyncTask ` + - | :ref:`removeAsync ` ( + | :ref:`io.realm.mongodb.App.Callback\ ` callback + | ) + + + Calling this will asynchronously remove the user and any Realms the user has from the device. + + + + @@ -339,7 +360,7 @@ Inherited Methods -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` +- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` @@ -380,7 +401,7 @@ equals :header-rows: 1 * - | public **boolean** :ref:`equals ` ( - | `Object `__ o + | `Object `__ o | ) @@ -399,7 +420,7 @@ equals **Overrides** - ``equals`` in class `Object `__ + ``equals`` in class `Object `__ @@ -426,7 +447,7 @@ getAccessToken .. list-table:: :header-rows: 1 - * - | public `String `__ :ref:`getAccessToken ` () + * - | public `String `__ :ref:`getAccessToken ` () | @@ -495,7 +516,7 @@ getApiKeys **Throws** - - `IllegalStateException `__ - if no user is currently logged in. + - `IllegalStateException `__ - if no user is currently logged in. @@ -630,7 +651,7 @@ getDeviceId .. list-table:: :header-rows: 1 - * - | public `String `__ :ref:`getDeviceId ` () + * - | public `String `__ :ref:`getDeviceId ` () | @@ -787,7 +808,7 @@ getId .. list-table:: :header-rows: 1 - * - | public `String `__ :ref:`getId ` () + * - | public `String `__ :ref:`getId ` () | @@ -834,7 +855,7 @@ getIdentities .. list-table:: :header-rows: 1 - * - | public `List `__ :ref:`getIdentities ` () + * - | public `List `__ :ref:`getIdentities ` () | @@ -908,7 +929,7 @@ getMongoClient :header-rows: 1 * - | public synchronized :ref:`MongoClient ` :ref:`getMongoClient ` ( - | `String `__ serviceName + | `String `__ serviceName | ) @@ -1067,7 +1088,7 @@ getPush :header-rows: 1 * - | public synchronized :ref:`Push ` :ref:`getPush ` ( - | `String `__ serviceName + | `String `__ serviceName | ) @@ -1119,7 +1140,7 @@ getRefreshToken .. list-table:: :header-rows: 1 - * - | public `String `__ :ref:`getRefreshToken ` () + * - | public `String `__ :ref:`getRefreshToken ` () | @@ -1236,7 +1257,7 @@ hashCode **Overrides** - ``hashCode`` in class `Object `__ + ``hashCode`` in class `Object `__ @@ -1375,7 +1396,7 @@ linkCredentials **Throws** - - `IllegalStateException `__ - if no user is currently logged in. + - `IllegalStateException `__ - if no user is currently logged in. @@ -1531,7 +1552,7 @@ linkCredentialsAsync **Throws** - - `IllegalStateException `__ - if called from a non-looper thread. + - `IllegalStateException `__ - if called from a non-looper thread. @@ -1570,11 +1591,17 @@ logOut - * - Log the user out of the Realm App. This will unregister them on the device, stop any synchronization to and from the users' Realms, and those Realms will be deleted next time the app restarts. Therefor logging out should not be done until all changes to Realms have been uploaded to the server.Once the Realm App has confirmed the logout any registered :ref:`AuthenticationListener ` will be notified and user credentials will be deleted from this device. + * - Log the user out of the Realm App. This will unregister them on the device and stop any synchronization to and from the users' Realms. Any Realms owned by the user will not be deleted from the device before :ref:`User.remove() ` is called. + + Once the Realm App has confirmed the logout any registered :ref:`AuthenticationListener ` will be notified and user credentials will be deleted from this device. + + + Logging out anonymous users will remove them immediately instead of marking them as :ref:`User.State.LOGGED_OUT ` . - Logging out anonymous users will remove them immediately instead of marking them as :ref:`User.State.LOGGED_OUT ` . All other users will be marked as :ref:`User.State.LOGGED_OUT ` and will still be returned by :ref:`App.allUsers() ` . They can be removed completely by calling **App.removeUser(User** ()}. + + All other users will be marked as :ref:`User.State.LOGGED_OUT ` and will still be returned by :ref:`App.allUsers() ` . They can be removed completely by calling :ref:`User.remove() ` . @@ -1649,11 +1676,17 @@ logOutAsync - * - Log the user out of the Realm App asynchronously. This will unregister them on the device, stop any synchronization to and from the users' Realms, and those Realms will be deleted next time the app restarts. Therefor logging out should not be done until all changes to Realms have been uploaded to the server.Once the Realm App has confirmed the logout any registered :ref:`AuthenticationListener ` will be notified and user credentials will be deleted from this device. + * - Log the user out of the Realm App asynchronously. This will unregister them on the device and stop any synchronization to and from the users' Realms. Any Realms owned by the user will not be deleted from the device before :ref:`User.remove() ` is called. + + Once the Realm App has confirmed the logout any registered :ref:`AuthenticationListener ` will be notified and user credentials will be deleted from this device. + + + Logging out anonymous users will remove them immediately instead of marking them as :ref:`User.State.LOGGED_OUT ` . - Logging out anonymous users will remove them immediately instead of marking them as :ref:`User.State.LOGGED_OUT ` . All other users will be marked as :ref:`User.State.LOGGED_OUT ` and will still be returned by :ref:`App.allUsers() ` . They can be removed completely by calling :ref:`App.removeUser(User) ` ()}. + + All other users will be marked as :ref:`User.State.LOGGED_OUT ` and will still be returned by :ref:`App.allUsers() ` . They can be removed completely by calling :ref:`User.remove() ` . @@ -1676,7 +1709,7 @@ logOutAsync **Throws** - - `IllegalStateException `__ - if called from a non-looper thread. + - `IllegalStateException `__ - if called from a non-looper thread. @@ -1764,7 +1797,7 @@ refreshCustomData **Throws** - - `IllegalStateException `__ - if not called on a looper thread. + - `IllegalStateException `__ - if not called on a looper thread. @@ -1813,4 +1846,138 @@ refreshCustomData +.. _remove: + +.. _remove__: + +.. _User_remove: + +.. _User_remove__: + +.. _io_realm_mongodb_User_remove: + +.. _io_realm_mongodb_User_remove__: + + + +remove +------ + +.. list-table:: + :header-rows: 1 + + * - | public :ref:`User ` :ref:`remove ` () + | + + + + + * - Calling this will remove the user and any Realms the user has from the device. No data is removed from the server. If the user is logged in when calling this method, the user is logged out before any data is deleted. + + + + + + + **Returns** + + the user that was removed. + + + + + **Throws** + + - :ref:`AppException ` - if an error occurred while trying to remove the user. + + + + + + + + + + + + +.. _removeAsync: + +.. _removeAsync__: + +.. _User_removeAsync: + +.. _User_removeAsync__: + +.. _io_realm_mongodb_User_removeAsync: + +.. _io_realm_mongodb_User_removeAsync__: + + + +removeAsync +----------- + +.. _io_realm_mongodb_User_removeAsync_io_realm_mongodb_App_Callback_: + +.. _io_realm_mongodb_User_removeAsync_Callback_: + +.. _io_realm_mongodb_User_removeAsync_App_Callback_: + +.. _removeAsync_io_realm_mongodb_App_Callback_: + +.. _removeAsync_Callback_: + +.. _removeAsync_App_Callback_: + +.. _User_removeAsync_io_realm_mongodb_App_Callback_: + +.. _User_removeAsync_Callback_: + +.. _User_removeAsync_App_Callback_: + +.. _io_realm_mongodb_User_removeAsync_App_Callback_User__: + +.. list-table:: + :header-rows: 1 + + * - | public :ref:`RealmAsyncTask ` :ref:`removeAsync ` ( + | :ref:`io.realm.mongodb.App.Callback\ ` callback + | ) + + + + + * - Calling this will asynchronously remove the user and any Realms the user has from the device. No data is removed from the server. If the user is logged in when calling this method, the user is logged out before any data is deleted. + + + + + **Parameters** + + - ``callback`` - callback when removing the user has completed or failed. The callback will always happen on the same thread as this method is called on. + + + + + + + + + + **Throws** + + - `IllegalStateException `__ - if called from a non-looper thread. + + + + + + + + + + + + diff --git a/source/sdk/java/api/io/realm/mongodb/User/State.txt b/source/sdk/java/api/io/realm/mongodb/User/State.txt index a2efface21..f7d7c96d89 100644 --- a/source/sdk/java/api/io/realm/mongodb/User/State.txt +++ b/source/sdk/java/api/io/realm/mongodb/User/State.txt @@ -18,8 +18,8 @@ io.realm.mongodb ================ - | `java.lang.Object `__ - | `java.lang.Enum `__ + | `java.lang.Object `__ + | `java.lang.Enum `__ | io.realm.mongodb.User.State @@ -77,7 +77,7 @@ Method Summary * - public static :ref:`User.State ` - | :ref:`valueOf ` ( - | `String `__ name + | `String `__ name | ) @@ -104,8 +104,8 @@ Inherited Methods -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` -- Methods inherited from class `java.lang.Enum `__ : ``name`` , ``ordinal`` , ``toString`` , ``equals`` , ``hashCode`` , ``clone`` , ``compareTo`` , ``getDeclaringClass`` , ``valueOf`` , ``finalize`` +- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` +- Methods inherited from class `java.lang.Enum `__ : ``name`` , ``ordinal`` , ``toString`` , ``equals`` , ``hashCode`` , ``clone`` , ``compareTo`` , ``getDeclaringClass`` , ``valueOf`` , ``finalize`` @@ -200,7 +200,7 @@ valueOf :header-rows: 1 * - | public static :ref:`User.State ` :ref:`valueOf ` ( - | `String `__ name + | `String `__ name | ) diff --git a/source/sdk/java/api/io/realm/mongodb/UserIdentity.txt b/source/sdk/java/api/io/realm/mongodb/UserIdentity.txt index 1ebcbfd090..2df10d3faf 100644 --- a/source/sdk/java/api/io/realm/mongodb/UserIdentity.txt +++ b/source/sdk/java/api/io/realm/mongodb/UserIdentity.txt @@ -18,7 +18,7 @@ io.realm.mongodb ================ - | `java.lang.Object `__ + | `java.lang.Object `__ | io.realm.mongodb.UserIdentity @@ -38,7 +38,7 @@ Method Summary * - public **boolean** - | :ref:`equals ` ( - | `Object `__ o + | `Object `__ o | ) @@ -47,7 +47,7 @@ Method Summary - * - public `String `__ + * - public `String `__ - | :ref:`getId ` () | @@ -77,7 +77,7 @@ Method Summary - * - public `String `__ + * - public `String `__ - | :ref:`toString ` () | @@ -95,7 +95,7 @@ Inherited Methods -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` +- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` @@ -136,7 +136,7 @@ equals :header-rows: 1 * - | public **boolean** :ref:`equals ` ( - | `Object `__ o + | `Object `__ o | ) @@ -155,7 +155,7 @@ equals **Overrides** - ``equals`` in class `Object `__ + ``equals`` in class `Object `__ @@ -182,7 +182,7 @@ getId .. list-table:: :header-rows: 1 - * - | public `String `__ :ref:`getId ` () + * - | public `String `__ :ref:`getId ` () | @@ -295,7 +295,7 @@ hashCode **Overrides** - ``hashCode`` in class `Object `__ + ``hashCode`` in class `Object `__ @@ -322,7 +322,7 @@ toString .. list-table:: :header-rows: 1 - * - | public `String `__ :ref:`toString ` () + * - | public `String `__ :ref:`toString ` () | @@ -341,7 +341,7 @@ toString **Overrides** - ``toString`` in class `Object `__ + ``toString`` in class `Object `__ diff --git a/source/sdk/java/api/io/realm/mongodb/UserProfile.txt b/source/sdk/java/api/io/realm/mongodb/UserProfile.txt index 5e57e9aca9..241e5ffd8c 100644 --- a/source/sdk/java/api/io/realm/mongodb/UserProfile.txt +++ b/source/sdk/java/api/io/realm/mongodb/UserProfile.txt @@ -18,7 +18,7 @@ io.realm.mongodb ================ - | `java.lang.Object `__ + | `java.lang.Object `__ | io.realm.mongodb.UserProfile @@ -36,7 +36,7 @@ Method Summary * - public **boolean** - | :ref:`equals ` ( - | `Object `__ o + | `Object `__ o | ) @@ -45,7 +45,7 @@ Method Summary - * - public `String `__ + * - public `String `__ - | :ref:`getBirthday ` () | @@ -55,7 +55,7 @@ Method Summary - * - public `String `__ + * - public `String `__ - | :ref:`getEmail ` () | @@ -65,7 +65,7 @@ Method Summary - * - public `String `__ + * - public `String `__ - | :ref:`getFirstName ` () | @@ -75,7 +75,7 @@ Method Summary - * - public `String `__ + * - public `String `__ - | :ref:`getGender ` () | @@ -85,7 +85,7 @@ Method Summary - * - public `String `__ + * - public `String `__ - | :ref:`getLastName ` () | @@ -95,7 +95,7 @@ Method Summary - * - public `Long `__ + * - public `Long `__ - | :ref:`getMaxAge ` () | @@ -105,7 +105,7 @@ Method Summary - * - public `Long `__ + * - public `Long `__ - | :ref:`getMinAge ` () | @@ -115,7 +115,7 @@ Method Summary - * - public `String `__ + * - public `String `__ - | :ref:`getName ` () | @@ -125,7 +125,7 @@ Method Summary - * - public `String `__ + * - public `String `__ - | :ref:`getPictureUrl ` () | @@ -157,7 +157,7 @@ Method Summary - * - public `String `__ + * - public `String `__ - | :ref:`toString ` () | @@ -175,7 +175,7 @@ Inherited Methods -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` +- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` @@ -216,7 +216,7 @@ equals :header-rows: 1 * - | public **boolean** :ref:`equals ` ( - | `Object `__ o + | `Object `__ o | ) @@ -235,7 +235,7 @@ equals **Overrides** - ``equals`` in class `Object `__ + ``equals`` in class `Object `__ @@ -262,7 +262,7 @@ getBirthday .. list-table:: :header-rows: 1 - * - | public `String `__ :ref:`getBirthday ` () + * - | public `String `__ :ref:`getBirthday ` () | @@ -309,7 +309,7 @@ getEmail .. list-table:: :header-rows: 1 - * - | public `String `__ :ref:`getEmail ` () + * - | public `String `__ :ref:`getEmail ` () | @@ -356,7 +356,7 @@ getFirstName .. list-table:: :header-rows: 1 - * - | public `String `__ :ref:`getFirstName ` () + * - | public `String `__ :ref:`getFirstName ` () | @@ -403,7 +403,7 @@ getGender .. list-table:: :header-rows: 1 - * - | public `String `__ :ref:`getGender ` () + * - | public `String `__ :ref:`getGender ` () | @@ -450,7 +450,7 @@ getLastName .. list-table:: :header-rows: 1 - * - | public `String `__ :ref:`getLastName ` () + * - | public `String `__ :ref:`getLastName ` () | @@ -497,7 +497,7 @@ getMaxAge .. list-table:: :header-rows: 1 - * - | public `Long `__ :ref:`getMaxAge ` () + * - | public `Long `__ :ref:`getMaxAge ` () | @@ -544,7 +544,7 @@ getMinAge .. list-table:: :header-rows: 1 - * - | public `Long `__ :ref:`getMinAge ` () + * - | public `Long `__ :ref:`getMinAge ` () | @@ -591,7 +591,7 @@ getName .. list-table:: :header-rows: 1 - * - | public `String `__ :ref:`getName ` () + * - | public `String `__ :ref:`getName ` () | @@ -638,7 +638,7 @@ getPictureUrl .. list-table:: :header-rows: 1 - * - | public `String `__ :ref:`getPictureUrl ` () + * - | public `String `__ :ref:`getPictureUrl ` () | @@ -755,7 +755,7 @@ hashCode **Overrides** - ``hashCode`` in class `Object `__ + ``hashCode`` in class `Object `__ @@ -782,7 +782,7 @@ toString .. list-table:: :header-rows: 1 - * - | public `String `__ :ref:`toString ` () + * - | public `String `__ :ref:`toString ` () | @@ -801,7 +801,7 @@ toString **Overrides** - ``toString`` in class `Object `__ + ``toString`` in class `Object `__ diff --git a/source/sdk/java/api/io/realm/mongodb/auth.txt b/source/sdk/java/api/io/realm/mongodb/auth.txt index 829b4de13f..ab67f7ad42 100644 --- a/source/sdk/java/api/io/realm/mongodb/auth.txt +++ b/source/sdk/java/api/io/realm/mongodb/auth.txt @@ -18,6 +18,7 @@ io.realm.mongodb.auth ApiKey ApiKeyAuth EmailPasswordAuth + GoogleAuthType @@ -26,6 +27,7 @@ io.realm.mongodb.auth - :ref:`io.realm.mongodb.auth.ApiKey ` - :ref:`io.realm.mongodb.auth.ApiKeyAuth ` - :ref:`io.realm.mongodb.auth.EmailPasswordAuth ` +- :ref:`io.realm.mongodb.auth.GoogleAuthType ` diff --git a/source/sdk/java/api/io/realm/mongodb/auth/ApiKey.txt b/source/sdk/java/api/io/realm/mongodb/auth/ApiKey.txt index 925b68866e..85ad0f5f8b 100644 --- a/source/sdk/java/api/io/realm/mongodb/auth/ApiKey.txt +++ b/source/sdk/java/api/io/realm/mongodb/auth/ApiKey.txt @@ -18,7 +18,7 @@ io.realm.mongodb.auth ===================== - | `java.lang.Object `__ + | `java.lang.Object `__ | io.realm.mongodb.auth.ApiKey @@ -46,7 +46,7 @@ Method Summary * - public **boolean** - | :ref:`equals ` ( - | `Object `__ o + | `Object `__ o | ) @@ -65,7 +65,7 @@ Method Summary - * - public `String `__ + * - public `String `__ - | :ref:`getName ` () | @@ -75,7 +75,7 @@ Method Summary - * - public `String `__ + * - public `String `__ - | :ref:`getValue ` () | @@ -105,7 +105,7 @@ Method Summary - * - public `String `__ + * - public `String `__ - | :ref:`toString ` () | @@ -123,7 +123,7 @@ Inherited Methods -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` +- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` @@ -164,7 +164,7 @@ equals :header-rows: 1 * - | public **boolean** :ref:`equals ` ( - | `Object `__ o + | `Object `__ o | ) @@ -183,7 +183,7 @@ equals **Overrides** - ``equals`` in class `Object `__ + ``equals`` in class `Object `__ @@ -257,7 +257,7 @@ getName .. list-table:: :header-rows: 1 - * - | public `String `__ :ref:`getName ` () + * - | public `String `__ :ref:`getName ` () | @@ -304,7 +304,7 @@ getValue .. list-table:: :header-rows: 1 - * - | public `String `__ :ref:`getValue ` () + * - | public `String `__ :ref:`getValue ` () | @@ -370,7 +370,7 @@ hashCode **Overrides** - ``hashCode`` in class `Object `__ + ``hashCode`` in class `Object `__ @@ -444,7 +444,7 @@ toString .. list-table:: :header-rows: 1 - * - | public `String `__ :ref:`toString ` () + * - | public `String `__ :ref:`toString ` () | @@ -463,7 +463,7 @@ toString **Overrides** - ``toString`` in class `Object `__ + ``toString`` in class `Object `__ diff --git a/source/sdk/java/api/io/realm/mongodb/auth/ApiKeyAuth.txt b/source/sdk/java/api/io/realm/mongodb/auth/ApiKeyAuth.txt index 128f7662ac..c78a96b5e3 100644 --- a/source/sdk/java/api/io/realm/mongodb/auth/ApiKeyAuth.txt +++ b/source/sdk/java/api/io/realm/mongodb/auth/ApiKeyAuth.txt @@ -18,7 +18,7 @@ io.realm.mongodb.auth ===================== - | `java.lang.Object `__ + | `java.lang.Object `__ | io.realm.mongodb.auth.ApiKeyAuth @@ -37,7 +37,7 @@ Method Summary * - protected abstract **void** - | :ref:`call ` ( | **int** functionType, - | `String `__ arg, + | `String `__ arg, | **OsJavaNetworkTransport.NetworkTransportJNIResultCallback** callback | ) @@ -49,7 +49,7 @@ Method Summary * - public :ref:`ApiKey ` - | :ref:`create ` ( - | `String `__ name + | `String `__ name | ) @@ -60,7 +60,7 @@ Method Summary * - public :ref:`RealmAsyncTask ` - | :ref:`createAsync ` ( - | `String `__ name, + | `String `__ name, | :ref:`io.realm.mongodb.App.Callback\ ` callback | ) @@ -141,7 +141,7 @@ Method Summary * - public **boolean** - | :ref:`equals ` ( - | `Object `__ o + | `Object `__ o | ) @@ -172,7 +172,7 @@ Method Summary - * - public `List `__ + * - public `List `__ - | :ref:`fetchAll ` () | @@ -228,7 +228,7 @@ Method Summary - * - public `String `__ + * - public `String `__ - | :ref:`toString ` () | @@ -246,7 +246,7 @@ Inherited Methods -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` +- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` @@ -271,74 +271,26 @@ Method Detail call ---- -.. _io_realm_mongodb_auth_ApiKeyAuth_call_int_java_lang_String_io_realm_internal_objectstore_OsJavaNetworkTransport_NetworkTransportJNIResultCallback_: - -.. _io_realm_mongodb_auth_ApiKeyAuth_call_int__java_lang_String__io_realm_internal_objectstore_OsJavaNetworkTransport_NetworkTransportJNIResultCallback_: - -.. _io_realm_mongodb_auth_ApiKeyAuth_call_int_java_lang_String_NetworkTransportJNIResultCallback_: - -.. _io_realm_mongodb_auth_ApiKeyAuth_call_int__java_lang_String__NetworkTransportJNIResultCallback_: - .. _io_realm_mongodb_auth_ApiKeyAuth_call_int_java_lang_String_OsJavaNetworkTransport_NetworkTransportJNIResultCallback_: .. _io_realm_mongodb_auth_ApiKeyAuth_call_int__java_lang_String__OsJavaNetworkTransport_NetworkTransportJNIResultCallback_: -.. _io_realm_mongodb_auth_ApiKeyAuth_call_int_String_io_realm_internal_objectstore_OsJavaNetworkTransport_NetworkTransportJNIResultCallback_: - -.. _io_realm_mongodb_auth_ApiKeyAuth_call_int__String__io_realm_internal_objectstore_OsJavaNetworkTransport_NetworkTransportJNIResultCallback_: - -.. _io_realm_mongodb_auth_ApiKeyAuth_call_int_String_NetworkTransportJNIResultCallback_: - -.. _io_realm_mongodb_auth_ApiKeyAuth_call_int__String__NetworkTransportJNIResultCallback_: - .. _io_realm_mongodb_auth_ApiKeyAuth_call_int_String_OsJavaNetworkTransport_NetworkTransportJNIResultCallback_: .. _io_realm_mongodb_auth_ApiKeyAuth_call_int__String__OsJavaNetworkTransport_NetworkTransportJNIResultCallback_: -.. _call_int_java_lang_String_io_realm_internal_objectstore_OsJavaNetworkTransport_NetworkTransportJNIResultCallback_: - -.. _call_int__java_lang_String__io_realm_internal_objectstore_OsJavaNetworkTransport_NetworkTransportJNIResultCallback_: - -.. _call_int_java_lang_String_NetworkTransportJNIResultCallback_: - -.. _call_int__java_lang_String__NetworkTransportJNIResultCallback_: - .. _call_int_java_lang_String_OsJavaNetworkTransport_NetworkTransportJNIResultCallback_: .. _call_int__java_lang_String__OsJavaNetworkTransport_NetworkTransportJNIResultCallback_: -.. _call_int_String_io_realm_internal_objectstore_OsJavaNetworkTransport_NetworkTransportJNIResultCallback_: - -.. _call_int__String__io_realm_internal_objectstore_OsJavaNetworkTransport_NetworkTransportJNIResultCallback_: - -.. _call_int_String_NetworkTransportJNIResultCallback_: - -.. _call_int__String__NetworkTransportJNIResultCallback_: - .. _call_int_String_OsJavaNetworkTransport_NetworkTransportJNIResultCallback_: .. _call_int__String__OsJavaNetworkTransport_NetworkTransportJNIResultCallback_: -.. _ApiKeyAuth_call_int_java_lang_String_io_realm_internal_objectstore_OsJavaNetworkTransport_NetworkTransportJNIResultCallback_: - -.. _ApiKeyAuth_call_int__java_lang_String__io_realm_internal_objectstore_OsJavaNetworkTransport_NetworkTransportJNIResultCallback_: - -.. _ApiKeyAuth_call_int_java_lang_String_NetworkTransportJNIResultCallback_: - -.. _ApiKeyAuth_call_int__java_lang_String__NetworkTransportJNIResultCallback_: - .. _ApiKeyAuth_call_int_java_lang_String_OsJavaNetworkTransport_NetworkTransportJNIResultCallback_: .. _ApiKeyAuth_call_int__java_lang_String__OsJavaNetworkTransport_NetworkTransportJNIResultCallback_: -.. _ApiKeyAuth_call_int_String_io_realm_internal_objectstore_OsJavaNetworkTransport_NetworkTransportJNIResultCallback_: - -.. _ApiKeyAuth_call_int__String__io_realm_internal_objectstore_OsJavaNetworkTransport_NetworkTransportJNIResultCallback_: - -.. _ApiKeyAuth_call_int_String_NetworkTransportJNIResultCallback_: - -.. _ApiKeyAuth_call_int__String__NetworkTransportJNIResultCallback_: - .. _ApiKeyAuth_call_int_String_OsJavaNetworkTransport_NetworkTransportJNIResultCallback_: .. _ApiKeyAuth_call_int__String__OsJavaNetworkTransport_NetworkTransportJNIResultCallback_: @@ -348,7 +300,7 @@ call * - | protected abstract **void** :ref:`call ` ( | **int** functionType, - | `String `__ arg, + | `String `__ arg, | **OsJavaNetworkTransport.NetworkTransportJNIResultCallback** callback | ) @@ -404,7 +356,7 @@ create :header-rows: 1 * - | public :ref:`ApiKey ` :ref:`create ` ( - | `String `__ name + | `String `__ name | ) @@ -548,7 +500,7 @@ createAsync :header-rows: 1 * - | public :ref:`RealmAsyncTask ` :ref:`createAsync ` ( - | `String `__ name, + | `String `__ name, | :ref:`io.realm.mongodb.App.Callback\ ` callback | ) @@ -584,7 +536,7 @@ createAsync **Throws** - - `IllegalStateException `__ - if called from a non-looper thread. + - `IllegalStateException `__ - if called from a non-looper thread. @@ -751,7 +703,7 @@ deleteAsync **Throws** - - `IllegalStateException `__ - if called from a non-looper thread. + - `IllegalStateException `__ - if called from a non-looper thread. @@ -918,7 +870,7 @@ disableAsync **Throws** - - `IllegalStateException `__ - if called from a non-looper thread. + - `IllegalStateException `__ - if called from a non-looper thread. @@ -1085,7 +1037,7 @@ enableAsync **Throws** - - `IllegalStateException `__ - if called from a non-looper thread. + - `IllegalStateException `__ - if called from a non-looper thread. @@ -1131,7 +1083,7 @@ equals :header-rows: 1 * - | public **boolean** :ref:`equals ` ( - | `Object `__ o + | `Object `__ o | ) @@ -1150,7 +1102,7 @@ equals **Overrides** - ``equals`` in class `Object `__ + ``equals`` in class `Object `__ @@ -1288,7 +1240,7 @@ fetchAll **Throws** - - `IllegalStateException `__ - if called from a non-looper thread. + - `IllegalStateException `__ - if called from a non-looper thread. @@ -1302,7 +1254,7 @@ fetchAll .. list-table:: :header-rows: 1 - * - | public `List `__ :ref:`fetchAll ` () + * - | public `List `__ :ref:`fetchAll ` () | @@ -1421,7 +1373,7 @@ fetchAsync **Throws** - - `IllegalStateException `__ - if called from a non-looper thread. + - `IllegalStateException `__ - if called from a non-looper thread. @@ -1575,7 +1527,7 @@ hashCode **Overrides** - ``hashCode`` in class `Object `__ + ``hashCode`` in class `Object `__ @@ -1602,7 +1554,7 @@ toString .. list-table:: :header-rows: 1 - * - | public `String `__ :ref:`toString ` () + * - | public `String `__ :ref:`toString ` () | @@ -1621,7 +1573,7 @@ toString **Overrides** - ``toString`` in class `Object `__ + ``toString`` in class `Object `__ diff --git a/source/sdk/java/api/io/realm/mongodb/auth/EmailPasswordAuth.txt b/source/sdk/java/api/io/realm/mongodb/auth/EmailPasswordAuth.txt index a16806981d..451c4c1e08 100644 --- a/source/sdk/java/api/io/realm/mongodb/auth/EmailPasswordAuth.txt +++ b/source/sdk/java/api/io/realm/mongodb/auth/EmailPasswordAuth.txt @@ -18,7 +18,7 @@ io.realm.mongodb.auth ===================== - | `java.lang.Object `__ + | `java.lang.Object `__ | io.realm.mongodb.auth.EmailPasswordAuth @@ -40,7 +40,7 @@ Method Summary - | :ref:`call ` ( | **int** functionType, | **OsJavaNetworkTransport.NetworkTransportJNIResultCallback** callback, - | `java.lang.String[] `__ args + | `java.lang.String[] `__ args | ) @@ -51,9 +51,9 @@ Method Summary * - public **void** - | :ref:`callResetPasswordFunction ` ( - | `String `__ email, - | `String `__ newPassword, - | `java.lang.Object[] `__ args + | `String `__ email, + | `String `__ newPassword, + | `java.lang.Object[] `__ args | ) @@ -66,9 +66,9 @@ Method Summary * - public :ref:`RealmAsyncTask ` - | :ref:`callResetPasswordFunctionAsync ` ( - | `String `__ email, - | `String `__ newPassword, - | `java.lang.Object[] `__ args, + | `String `__ email, + | `String `__ newPassword, + | `java.lang.Object[] `__ args, | :ref:`io.realm.mongodb.App.Callback\ ` callback | ) @@ -82,8 +82,8 @@ Method Summary * - public **void** - | :ref:`confirmUser ` ( - | `String `__ token, - | `String `__ tokenId + | `String `__ token, + | `String `__ tokenId | ) @@ -94,8 +94,8 @@ Method Summary * - public :ref:`RealmAsyncTask ` - | :ref:`confirmUserAsync ` ( - | `String `__ token, - | `String `__ tokenId, + | `String `__ token, + | `String `__ tokenId, | :ref:`io.realm.mongodb.App.Callback\ ` callback | ) @@ -107,8 +107,8 @@ Method Summary * - public **void** - | :ref:`registerUser ` ( - | `String `__ email, - | `String `__ password + | `String `__ email, + | `String `__ password | ) @@ -119,8 +119,8 @@ Method Summary * - public :ref:`RealmAsyncTask ` - | :ref:`registerUserAsync ` ( - | `String `__ email, - | `String `__ password, + | `String `__ email, + | `String `__ password, | :ref:`io.realm.mongodb.App.Callback\ ` callback | ) @@ -132,7 +132,7 @@ Method Summary * - public **void** - | :ref:`resendConfirmationEmail ` ( - | `String `__ email + | `String `__ email | ) @@ -143,7 +143,7 @@ Method Summary * - public :ref:`RealmAsyncTask ` - | :ref:`resendConfirmationEmailAsync ` ( - | `String `__ email, + | `String `__ email, | :ref:`io.realm.mongodb.App.Callback\ ` callback | ) @@ -155,9 +155,9 @@ Method Summary * - public **void** - | :ref:`resetPassword ` ( - | `String `__ token, - | `String `__ tokenId, - | `String `__ newPassword + | `String `__ token, + | `String `__ tokenId, + | `String `__ newPassword | ) @@ -168,9 +168,9 @@ Method Summary * - public :ref:`RealmAsyncTask ` - | :ref:`resetPasswordAsync ` ( - | `String `__ token, - | `String `__ tokenId, - | `String `__ newPassword, + | `String `__ token, + | `String `__ tokenId, + | `String `__ newPassword, | :ref:`io.realm.mongodb.App.Callback\ ` callback | ) @@ -182,7 +182,7 @@ Method Summary * - public **void** - | :ref:`retryCustomConfirmation ` ( - | `String `__ email + | `String `__ email | ) @@ -193,7 +193,7 @@ Method Summary * - public :ref:`RealmAsyncTask ` - | :ref:`retryCustomConfirmationAsync ` ( - | `String `__ email, + | `String `__ email, | :ref:`io.realm.mongodb.App.Callback\ ` callback | ) @@ -205,7 +205,7 @@ Method Summary * - public **void** - | :ref:`sendResetPasswordEmail ` ( - | `String `__ email + | `String `__ email | ) @@ -216,7 +216,7 @@ Method Summary * - public :ref:`RealmAsyncTask ` - | :ref:`sendResetPasswordEmailAsync ` ( - | `String `__ email, + | `String `__ email, | :ref:`io.realm.mongodb.App.Callback\ ` callback | ) @@ -234,7 +234,7 @@ Inherited Methods -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` +- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` @@ -259,30 +259,6 @@ Method Detail call ---- -.. _io_realm_mongodb_auth_EmailPasswordAuth_call_int_io_realm_internal_objectstore_OsJavaNetworkTransport_NetworkTransportJNIResultCallback_java_lang_String_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_call_int__io_realm_internal_objectstore_OsJavaNetworkTransport_NetworkTransportJNIResultCallback__java_lang_String_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_call_int_io_realm_internal_objectstore_OsJavaNetworkTransport_NetworkTransportJNIResultCallback_String_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_call_int__io_realm_internal_objectstore_OsJavaNetworkTransport_NetworkTransportJNIResultCallback__String_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_call_int_io_realm_internal_objectstore_OsJavaNetworkTransport_NetworkTransportJNIResultCallback_String____: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_call_int__io_realm_internal_objectstore_OsJavaNetworkTransport_NetworkTransportJNIResultCallback__String____: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_call_int_NetworkTransportJNIResultCallback_java_lang_String_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_call_int__NetworkTransportJNIResultCallback__java_lang_String_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_call_int_NetworkTransportJNIResultCallback_String_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_call_int__NetworkTransportJNIResultCallback__String_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_call_int_NetworkTransportJNIResultCallback_String____: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_call_int__NetworkTransportJNIResultCallback__String____: - .. _io_realm_mongodb_auth_EmailPasswordAuth_call_int_OsJavaNetworkTransport_NetworkTransportJNIResultCallback_java_lang_String_: .. _io_realm_mongodb_auth_EmailPasswordAuth_call_int__OsJavaNetworkTransport_NetworkTransportJNIResultCallback__java_lang_String_: @@ -295,30 +271,6 @@ call .. _io_realm_mongodb_auth_EmailPasswordAuth_call_int__OsJavaNetworkTransport_NetworkTransportJNIResultCallback__String____: -.. _call_int_io_realm_internal_objectstore_OsJavaNetworkTransport_NetworkTransportJNIResultCallback_java_lang_String_: - -.. _call_int__io_realm_internal_objectstore_OsJavaNetworkTransport_NetworkTransportJNIResultCallback__java_lang_String_: - -.. _call_int_io_realm_internal_objectstore_OsJavaNetworkTransport_NetworkTransportJNIResultCallback_String_: - -.. _call_int__io_realm_internal_objectstore_OsJavaNetworkTransport_NetworkTransportJNIResultCallback__String_: - -.. _call_int_io_realm_internal_objectstore_OsJavaNetworkTransport_NetworkTransportJNIResultCallback_String____: - -.. _call_int__io_realm_internal_objectstore_OsJavaNetworkTransport_NetworkTransportJNIResultCallback__String____: - -.. _call_int_NetworkTransportJNIResultCallback_java_lang_String_: - -.. _call_int__NetworkTransportJNIResultCallback__java_lang_String_: - -.. _call_int_NetworkTransportJNIResultCallback_String_: - -.. _call_int__NetworkTransportJNIResultCallback__String_: - -.. _call_int_NetworkTransportJNIResultCallback_String____: - -.. _call_int__NetworkTransportJNIResultCallback__String____: - .. _call_int_OsJavaNetworkTransport_NetworkTransportJNIResultCallback_java_lang_String_: .. _call_int__OsJavaNetworkTransport_NetworkTransportJNIResultCallback__java_lang_String_: @@ -331,30 +283,6 @@ call .. _call_int__OsJavaNetworkTransport_NetworkTransportJNIResultCallback__String____: -.. _EmailPasswordAuth_call_int_io_realm_internal_objectstore_OsJavaNetworkTransport_NetworkTransportJNIResultCallback_java_lang_String_: - -.. _EmailPasswordAuth_call_int__io_realm_internal_objectstore_OsJavaNetworkTransport_NetworkTransportJNIResultCallback__java_lang_String_: - -.. _EmailPasswordAuth_call_int_io_realm_internal_objectstore_OsJavaNetworkTransport_NetworkTransportJNIResultCallback_String_: - -.. _EmailPasswordAuth_call_int__io_realm_internal_objectstore_OsJavaNetworkTransport_NetworkTransportJNIResultCallback__String_: - -.. _EmailPasswordAuth_call_int_io_realm_internal_objectstore_OsJavaNetworkTransport_NetworkTransportJNIResultCallback_String____: - -.. _EmailPasswordAuth_call_int__io_realm_internal_objectstore_OsJavaNetworkTransport_NetworkTransportJNIResultCallback__String____: - -.. _EmailPasswordAuth_call_int_NetworkTransportJNIResultCallback_java_lang_String_: - -.. _EmailPasswordAuth_call_int__NetworkTransportJNIResultCallback__java_lang_String_: - -.. _EmailPasswordAuth_call_int_NetworkTransportJNIResultCallback_String_: - -.. _EmailPasswordAuth_call_int__NetworkTransportJNIResultCallback__String_: - -.. _EmailPasswordAuth_call_int_NetworkTransportJNIResultCallback_String____: - -.. _EmailPasswordAuth_call_int__NetworkTransportJNIResultCallback__String____: - .. _EmailPasswordAuth_call_int_OsJavaNetworkTransport_NetworkTransportJNIResultCallback_java_lang_String_: .. _EmailPasswordAuth_call_int__OsJavaNetworkTransport_NetworkTransportJNIResultCallback__java_lang_String_: @@ -373,7 +301,7 @@ call * - | protected abstract **void** :ref:`call ` ( | **int** functionType, | **OsJavaNetworkTransport.NetworkTransportJNIResultCallback** callback, - | `java.lang.String[] `__ args + | `java.lang.String[] `__ args | ) @@ -560,9 +488,9 @@ callResetPasswordFunction :header-rows: 1 * - | public **void** :ref:`callResetPasswordFunction ` ( - | `String `__ email, - | `String `__ newPassword, - | `java.lang.Object[] `__ args + | `String `__ email, + | `String `__ newPassword, + | `java.lang.Object[] `__ args | ) @@ -1067,9 +995,9 @@ callResetPasswordFunctionAsync :header-rows: 1 * - | public :ref:`RealmAsyncTask ` :ref:`callResetPasswordFunctionAsync ` ( - | `String `__ email, - | `String `__ newPassword, - | `java.lang.Object[] `__ args, + | `String `__ email, + | `String `__ newPassword, + | `java.lang.Object[] `__ args, | :ref:`io.realm.mongodb.App.Callback\ ` callback | ) @@ -1111,7 +1039,7 @@ callResetPasswordFunctionAsync **Throws** - - `IllegalStateException `__ - if called from a non-looper thread. + - `IllegalStateException `__ - if called from a non-looper thread. @@ -1193,8 +1121,8 @@ confirmUser :header-rows: 1 * - | public **void** :ref:`confirmUser ` ( - | `String `__ token, - | `String `__ tokenId + | `String `__ token, + | `String `__ tokenId | ) @@ -1403,8 +1331,8 @@ confirmUserAsync :header-rows: 1 * - | public :ref:`RealmAsyncTask ` :ref:`confirmUserAsync ` ( - | `String `__ token, - | `String `__ tokenId, + | `String `__ token, + | `String `__ tokenId, | :ref:`io.realm.mongodb.App.Callback\ ` callback | ) @@ -1438,7 +1366,7 @@ confirmUserAsync **Throws** - - `IllegalStateException `__ - if called from a non-looper thread. + - `IllegalStateException `__ - if called from a non-looper thread. @@ -1520,8 +1448,8 @@ registerUser :header-rows: 1 * - | public **void** :ref:`registerUser ` ( - | `String `__ email, - | `String `__ password + | `String `__ email, + | `String `__ password | ) @@ -1730,8 +1658,8 @@ registerUserAsync :header-rows: 1 * - | public :ref:`RealmAsyncTask ` :ref:`registerUserAsync ` ( - | `String `__ email, - | `String `__ password, + | `String `__ email, + | `String `__ password, | :ref:`io.realm.mongodb.App.Callback\ ` callback | ) @@ -1765,7 +1693,7 @@ registerUserAsync **Throws** - - `IllegalStateException `__ - if called from a non-looper thread. + - `IllegalStateException `__ - if called from a non-looper thread. @@ -1815,7 +1743,7 @@ resendConfirmationEmail :header-rows: 1 * - | public **void** :ref:`resendConfirmationEmail ` ( - | `String `__ email + | `String `__ email | ) @@ -1948,7 +1876,7 @@ resendConfirmationEmailAsync :header-rows: 1 * - | public :ref:`RealmAsyncTask ` :ref:`resendConfirmationEmailAsync ` ( - | `String `__ email, + | `String `__ email, | :ref:`io.realm.mongodb.App.Callback\ ` callback | ) @@ -1978,7 +1906,7 @@ resendConfirmationEmailAsync **Throws** - - `IllegalStateException `__ - if called from a non-looper thread. + - `IllegalStateException `__ - if called from a non-looper thread. @@ -2108,9 +2036,9 @@ resetPassword :header-rows: 1 * - | public **void** :ref:`resetPassword ` ( - | `String `__ token, - | `String `__ tokenId, - | `String `__ newPassword + | `String `__ token, + | `String `__ tokenId, + | `String `__ newPassword | ) @@ -2469,9 +2397,9 @@ resetPasswordAsync :header-rows: 1 * - | public :ref:`RealmAsyncTask ` :ref:`resetPasswordAsync ` ( - | `String `__ token, - | `String `__ tokenId, - | `String `__ newPassword, + | `String `__ token, + | `String `__ tokenId, + | `String `__ newPassword, | :ref:`io.realm.mongodb.App.Callback\ ` callback | ) @@ -2511,7 +2439,7 @@ resetPasswordAsync **Throws** - - `IllegalStateException `__ - if called from a non-looper thread. + - `IllegalStateException `__ - if called from a non-looper thread. @@ -2557,7 +2485,7 @@ retryCustomConfirmation :header-rows: 1 * - | public **void** :ref:`retryCustomConfirmation ` ( - | `String `__ email + | `String `__ email | ) @@ -2690,7 +2618,7 @@ retryCustomConfirmationAsync :header-rows: 1 * - | public :ref:`RealmAsyncTask ` :ref:`retryCustomConfirmationAsync ` ( - | `String `__ email, + | `String `__ email, | :ref:`io.realm.mongodb.App.Callback\ ` callback | ) @@ -2720,7 +2648,7 @@ retryCustomConfirmationAsync **Throws** - - `IllegalStateException `__ - if called from a non-looper thread. + - `IllegalStateException `__ - if called from a non-looper thread. @@ -2766,7 +2694,7 @@ sendResetPasswordEmail :header-rows: 1 * - | public **void** :ref:`sendResetPasswordEmail ` ( - | `String `__ email + | `String `__ email | ) @@ -2899,7 +2827,7 @@ sendResetPasswordEmailAsync :header-rows: 1 * - | public :ref:`RealmAsyncTask ` :ref:`sendResetPasswordEmailAsync ` ( - | `String `__ email, + | `String `__ email, | :ref:`io.realm.mongodb.App.Callback\ ` callback | ) diff --git a/source/sdk/java/api/io/realm/mongodb/auth/GoogleAuthType.txt b/source/sdk/java/api/io/realm/mongodb/auth/GoogleAuthType.txt new file mode 100644 index 0000000000..c2c6bc0d0d --- /dev/null +++ b/source/sdk/java/api/io/realm/mongodb/auth/GoogleAuthType.txt @@ -0,0 +1,248 @@ + +.. contents:: On this page + :local: + :backlinks: none + :depth: 2 + :class: singlecol + + + +Enum GoogleAuthType +^^^^^^^^^^^^^^^^^^^ + +.. _io_realm_mongodb_auth_GoogleAuthType: + + + +io.realm.mongodb.auth +===================== + + + | `java.lang.Object `__ + | `java.lang.Enum `__ + | io.realm.mongodb.auth.GoogleAuthType + + +This enum contains the list of Google authentication types supported by MongoDB Realm. + + +.. seealso:: + + + + - `Google Authentication `__ + + + + + + + + + + +Enum Constant Summary +===================== + +.. list-table:: + :header-rows: 1 + + * - Enum Constant and Description + + * - :ref:`AUTH_CODE ` + + + + + + + * - :ref:`ID_TOKEN ` + + + + + + + + + +Method Summary +============== + +.. list-table:: + :header-rows: 1 + + * - Modifier and Type + - Method and Description + + * - public static :ref:`GoogleAuthType ` + - | :ref:`valueOf ` ( + | `String `__ name + | ) + + + + + + + + * - public static :ref:`GoogleAuthType ` + - | :ref:`values ` () + | + + + + + + + + + + +Inherited Methods +================= + + + +- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` +- Methods inherited from class `java.lang.Enum `__ : ``name`` , ``ordinal`` , ``toString`` , ``equals`` , ``hashCode`` , ``clone`` , ``compareTo`` , ``getDeclaringClass`` , ``valueOf`` , ``finalize`` + + + + +Enum Constant Detail +==================== + + +.. _io_realm_mongodb_auth_GoogleAuthType_AUTH_CODE: + +.. _GoogleAuthType_AUTH_CODE: + + + +``AUTH_CODE`` +-------------- + +public static final :ref:`GoogleAuthType ` + + + + + +.. _io_realm_mongodb_auth_GoogleAuthType_ID_TOKEN: + +.. _GoogleAuthType_ID_TOKEN: + + + +``ID_TOKEN`` +------------- + +public static final :ref:`GoogleAuthType ` + + + + + + +Method Detail +============= + +.. _valueOf: + +.. _valueOf__: + +.. _GoogleAuthType_valueOf: + +.. _GoogleAuthType_valueOf__: + +.. _io_realm_mongodb_auth_GoogleAuthType_valueOf: + +.. _io_realm_mongodb_auth_GoogleAuthType_valueOf__: + + + +valueOf +------- + +.. _io_realm_mongodb_auth_GoogleAuthType_valueOf_java_lang_String_: + +.. _io_realm_mongodb_auth_GoogleAuthType_valueOf_String_: + +.. _valueOf_java_lang_String_: + +.. _valueOf_String_: + +.. _GoogleAuthType_valueOf_java_lang_String_: + +.. _GoogleAuthType_valueOf_String_: + +.. list-table:: + :header-rows: 1 + + * - | public static :ref:`GoogleAuthType ` :ref:`valueOf ` ( + | `String `__ name + | ) + + + + + * - + + + + + + + + + + + + + + + +.. _values: + +.. _values__: + +.. _GoogleAuthType_values: + +.. _GoogleAuthType_values__: + +.. _io_realm_mongodb_auth_GoogleAuthType_values: + +.. _io_realm_mongodb_auth_GoogleAuthType_values__: + + + +values +------ + +.. list-table:: + :header-rows: 1 + + * - | public static :ref:`GoogleAuthType ` :ref:`values ` () + | + + + + + * - + + + + + + + + + + + + + + + + diff --git a/source/sdk/java/api/io/realm/mongodb/functions/Functions.txt b/source/sdk/java/api/io/realm/mongodb/functions/Functions.txt index aee0572ad8..f5d25626a7 100644 --- a/source/sdk/java/api/io/realm/mongodb/functions/Functions.txt +++ b/source/sdk/java/api/io/realm/mongodb/functions/Functions.txt @@ -18,7 +18,7 @@ io.realm.mongodb.functions ========================== - | `java.lang.Object `__ + | `java.lang.Object `__ | io.realm.mongodb.functions.Functions @@ -76,8 +76,8 @@ Method Summary * - public **ResultT** - | :ref:`callFunction ` <**ResultT** >( - | `String `__ name, - | `java.util.List\ `__ args, + | `String `__ name, + | `java.util.List\ `__ args, | **** resultDecoder | ) @@ -89,9 +89,9 @@ Method Summary * - public **ResultT** - | :ref:`callFunction ` <**ResultT** >( - | `String `__ name, - | `java.util.List\ `__ args, - | `java.lang.Class\ `__ resultClass + | `String `__ name, + | `java.util.List\ `__ args, + | `java.lang.Class\ `__ resultClass | ) @@ -102,9 +102,9 @@ Method Summary * - public **ResultT** - | :ref:`callFunction ` <**ResultT** >( - | `String `__ name, - | `java.util.List\ `__ args, - | `java.lang.Class\ `__ resultClass, + | `String `__ name, + | `java.util.List\ `__ args, + | `java.lang.Class\ `__ resultClass, | **CodecRegistry** codecRegistry | ) @@ -116,8 +116,8 @@ Method Summary * - public :ref:`RealmAsyncTask ` - | :ref:`callFunctionAsync ` <**T** >( - | `String `__ name, - | `java.util.List\ `__ args, + | `String `__ name, + | `java.util.List\ `__ args, | **** resultDecoder, | :ref:`io.realm.mongodb.App.Callback\ ` callback | ) @@ -130,9 +130,9 @@ Method Summary * - public :ref:`RealmAsyncTask ` - | :ref:`callFunctionAsync ` <**T** >( - | `String `__ name, - | `java.util.List\ `__ args, - | `java.lang.Class\ `__ resultClass, + | `String `__ name, + | `java.util.List\ `__ args, + | `java.lang.Class\ `__ resultClass, | :ref:`io.realm.mongodb.App.Callback\ ` callback | ) @@ -144,9 +144,9 @@ Method Summary * - public :ref:`RealmAsyncTask ` - | :ref:`callFunctionAsync ` <**T** >( - | `String `__ name, - | `java.util.List\ `__ args, - | `java.lang.Class\ `__ resultClass, + | `String `__ name, + | `java.util.List\ `__ args, + | `java.lang.Class\ `__ resultClass, | **CodecRegistry** codecRegistry, | :ref:`io.realm.mongodb.App.Callback\ ` callback | ) @@ -193,8 +193,8 @@ Method Summary * - protected abstract **T** - | :ref:`invoke ` <**T** >( - | `String `__ name, - | `java.util.List\ `__ args, + | `String `__ name, + | `java.util.List\ `__ args, | **CodecRegistry** codecRegistry, | **** resultDecoder | ) @@ -213,7 +213,7 @@ Inherited Methods -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` +- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` @@ -292,8 +292,8 @@ callFunction :header-rows: 1 * - | public **ResultT** :ref:`callFunction ` <**ResultT** >( - | `String `__ name, - | `java.util.List\ `__ args, + | `String `__ name, + | `java.util.List\ `__ args, | **** resultDecoder | ) @@ -475,9 +475,9 @@ callFunction :header-rows: 1 * - | public **ResultT** :ref:`callFunction ` <**ResultT** >( - | `String `__ name, - | `java.util.List\ `__ args, - | `java.lang.Class\ `__ resultClass + | `String `__ name, + | `java.util.List\ `__ args, + | `java.lang.Class\ `__ resultClass | ) @@ -654,9 +654,9 @@ callFunction :header-rows: 1 * - | public **ResultT** :ref:`callFunction ` <**ResultT** >( - | `String `__ name, - | `java.util.List\ `__ args, - | `java.lang.Class\ `__ resultClass, + | `String `__ name, + | `java.util.List\ `__ args, + | `java.lang.Class\ `__ resultClass, | **CodecRegistry** codecRegistry | ) @@ -907,8 +907,8 @@ callFunctionAsync :header-rows: 1 * - | public :ref:`RealmAsyncTask ` :ref:`callFunctionAsync ` <**T** >( - | `String `__ name, - | `java.util.List\ `__ args, + | `String `__ name, + | `java.util.List\ `__ args, | **** resultDecoder, | :ref:`io.realm.mongodb.App.Callback\ ` callback | ) @@ -966,7 +966,7 @@ callFunctionAsync **Throws** - - `IllegalStateException `__ - if not called on a looper thread. + - `IllegalStateException `__ - if not called on a looper thread. @@ -1293,9 +1293,9 @@ callFunctionAsync :header-rows: 1 * - | public :ref:`RealmAsyncTask ` :ref:`callFunctionAsync ` <**T** >( - | `String `__ name, - | `java.util.List\ `__ args, - | `java.lang.Class\ `__ resultClass, + | `String `__ name, + | `java.util.List\ `__ args, + | `java.lang.Class\ `__ resultClass, | :ref:`io.realm.mongodb.App.Callback\ ` callback | ) @@ -1350,7 +1350,7 @@ callFunctionAsync **Throws** - - `IllegalStateException `__ - if not called on a looper thread. + - `IllegalStateException `__ - if not called on a looper thread. @@ -1677,9 +1677,9 @@ callFunctionAsync :header-rows: 1 * - | public :ref:`RealmAsyncTask ` :ref:`callFunctionAsync ` <**T** >( - | `String `__ name, - | `java.util.List\ `__ args, - | `java.lang.Class\ `__ resultClass, + | `String `__ name, + | `java.util.List\ `__ args, + | `java.lang.Class\ `__ resultClass, | **CodecRegistry** codecRegistry, | :ref:`io.realm.mongodb.App.Callback\ ` callback | ) @@ -1739,7 +1739,7 @@ callFunctionAsync **Throws** - - `IllegalStateException `__ - if not called on a looper thread. + - `IllegalStateException `__ - if not called on a looper thread. @@ -1994,8 +1994,8 @@ invoke :header-rows: 1 * - | protected abstract **T** :ref:`invoke ` <**T** >( - | `String `__ name, - | `java.util.List\ `__ args, + | `String `__ name, + | `java.util.List\ `__ args, | **CodecRegistry** codecRegistry, | **** resultDecoder | ) diff --git a/source/sdk/java/api/io/realm/mongodb/log/obfuscator/HttpLogObfuscator.txt b/source/sdk/java/api/io/realm/mongodb/log/obfuscator/HttpLogObfuscator.txt index 3bf83eddd4..e3ecf5f427 100644 --- a/source/sdk/java/api/io/realm/mongodb/log/obfuscator/HttpLogObfuscator.txt +++ b/source/sdk/java/api/io/realm/mongodb/log/obfuscator/HttpLogObfuscator.txt @@ -18,7 +18,7 @@ io.realm.mongodb.log.obfuscator =============================== - | `java.lang.Object `__ + | `java.lang.Object `__ | io.realm.mongodb.log.obfuscator.HttpLogObfuscator @@ -34,8 +34,8 @@ Constructors * - Constructor and Description * - | :ref:`HttpLogObfuscator ` ( - | `String `__ feature, - | `java.util.Map\ `__ patternObfuscatorMap + | `String `__ feature, + | `java.util.Map\ `__ patternObfuscatorMap | ) @@ -58,7 +58,7 @@ Method Summary * - public **boolean** - | :ref:`equals ` ( - | `Object `__ o + | `Object `__ o | ) @@ -77,10 +77,10 @@ Method Summary - * - public `String `__ + * - public `String `__ - | :ref:`obfuscate ` ( - | `java.util.List\ `__ urlSegments, - | `String `__ input + | `java.util.List\ `__ urlSegments, + | `String `__ input | ) @@ -97,7 +97,7 @@ Inherited Methods -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` +- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` @@ -117,8 +117,8 @@ Constructor Detail :header-rows: 1 * - | public :ref:`HttpLogObfuscator ` ( - | `String `__ feature, - | `java.util.Map\ `__ patternObfuscatorMap + | `String `__ feature, + | `java.util.Map\ `__ patternObfuscatorMap | ) @@ -137,7 +137,7 @@ Constructor Detail - - ``patternObfuscatorMap`` - `Map `__ of keys subject to being obfuscated and **RegexPatternObfuscator**s used to determine which obfuscator has to be used for the given feature. + - ``patternObfuscatorMap`` - `Map `__ of keys subject to being obfuscated and **RegexPatternObfuscator**s used to determine which obfuscator has to be used for the given feature. @@ -190,7 +190,7 @@ equals :header-rows: 1 * - | public **boolean** :ref:`equals ` ( - | `Object `__ o + | `Object `__ o | ) @@ -209,7 +209,7 @@ equals **Overrides** - ``equals`` in class `Object `__ + ``equals`` in class `Object `__ @@ -255,7 +255,7 @@ hashCode **Overrides** - ``hashCode`` in class `Object `__ + ``hashCode`` in class `Object `__ @@ -332,9 +332,9 @@ obfuscate .. list-table:: :header-rows: 1 - * - | public `String `__ :ref:`obfuscate ` ( - | `java.util.List\ `__ urlSegments, - | `String `__ input + * - | public `String `__ :ref:`obfuscate ` ( + | `java.util.List\ `__ urlSegments, + | `String `__ input | ) diff --git a/source/sdk/java/api/io/realm/mongodb/mongo/MongoClient.txt b/source/sdk/java/api/io/realm/mongodb/mongo/MongoClient.txt index ee8fcec601..0c47efa7c8 100644 --- a/source/sdk/java/api/io/realm/mongodb/mongo/MongoClient.txt +++ b/source/sdk/java/api/io/realm/mongodb/mongo/MongoClient.txt @@ -18,7 +18,7 @@ io.realm.mongodb.mongo ====================== - | `java.lang.Object `__ + | `java.lang.Object `__ | io.realm.mongodb.mongo.MongoClient @@ -36,7 +36,7 @@ Method Summary * - public :ref:`MongoDatabase ` - | :ref:`getDatabase ` ( - | `String `__ databaseName + | `String `__ databaseName | ) @@ -47,7 +47,7 @@ Method Summary - * - public `String `__ + * - public `String `__ - | :ref:`getServiceName ` () | @@ -65,7 +65,7 @@ Inherited Methods -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` +- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` @@ -106,7 +106,7 @@ getDatabase :header-rows: 1 * - | public :ref:`MongoDatabase ` :ref:`getDatabase ` ( - | `String `__ databaseName + | `String `__ databaseName | ) @@ -165,7 +165,7 @@ getServiceName .. list-table:: :header-rows: 1 - * - | public `String `__ :ref:`getServiceName ` () + * - | public `String `__ :ref:`getServiceName ` () | diff --git a/source/sdk/java/api/io/realm/mongodb/mongo/MongoCollection.txt b/source/sdk/java/api/io/realm/mongodb/mongo/MongoCollection.txt index 5cfce9451d..51845b074f 100644 --- a/source/sdk/java/api/io/realm/mongodb/mongo/MongoCollection.txt +++ b/source/sdk/java/api/io/realm/mongodb/mongo/MongoCollection.txt @@ -18,7 +18,7 @@ io.realm.mongodb.mongo ====================== - | `java.lang.Object `__ + | `java.lang.Object `__ | io.realm.mongodb.mongo.MongoCollection @@ -56,8 +56,8 @@ Method Summary * - public :ref:`AggregateIterable ` - | :ref:`aggregate ` <**ResultT** >( - | `java.util.List\ `__ pipeline, - | `java.lang.Class\ `__ resultClass + | `java.util.List\ `__ pipeline, + | `java.lang.Class\ `__ resultClass | ) @@ -68,7 +68,7 @@ Method Summary * - public :ref:`AggregateIterable ` - | :ref:`aggregate ` ( - | `java.util.List\ `__ pipeline + | `java.util.List\ `__ pipeline | ) @@ -135,7 +135,7 @@ Method Summary * - public :ref:`FindIterable ` - | :ref:`find ` <**ResultT** >( | **Bson** filter, - | `java.lang.Class\ `__ resultClass, + | `java.lang.Class\ `__ resultClass, | :ref:`FindOptions ` options | ) @@ -150,7 +150,7 @@ Method Summary * - public :ref:`FindIterable ` - | :ref:`find ` <**ResultT** >( | **Bson** filter, - | `java.lang.Class\ `__ resultClass + | `java.lang.Class\ `__ resultClass | ) @@ -186,7 +186,7 @@ Method Summary * - public :ref:`FindIterable ` - | :ref:`find ` <**ResultT** >( - | `java.lang.Class\ `__ resultClass, + | `java.lang.Class\ `__ resultClass, | :ref:`FindOptions ` options | ) @@ -200,7 +200,7 @@ Method Summary * - public :ref:`FindIterable ` - | :ref:`find ` <**ResultT** >( - | `java.lang.Class\ `__ resultClass + | `java.lang.Class\ `__ resultClass | ) @@ -236,7 +236,7 @@ Method Summary - | :ref:`findOne ` <**ResultT** >( | **Bson** filter, | :ref:`FindOptions ` options, - | `java.lang.Class\ `__ resultClass + | `java.lang.Class\ `__ resultClass | ) @@ -260,7 +260,7 @@ Method Summary * - public :ref:`RealmResultTask ` - | :ref:`findOne ` <**ResultT** >( | **Bson** filter, - | `java.lang.Class\ `__ resultClass + | `java.lang.Class\ `__ resultClass | ) @@ -282,7 +282,7 @@ Method Summary * - public :ref:`RealmResultTask ` - | :ref:`findOne ` <**ResultT** >( - | `java.lang.Class\ `__ resultClass + | `java.lang.Class\ `__ resultClass | ) @@ -305,7 +305,7 @@ Method Summary - | :ref:`findOneAndDelete ` <**ResultT** >( | **Bson** filter, | :ref:`FindOneAndModifyOptions ` options, - | `java.lang.Class\ `__ resultClass + | `java.lang.Class\ `__ resultClass | ) @@ -329,7 +329,7 @@ Method Summary * - public :ref:`RealmResultTask ` - | :ref:`findOneAndDelete ` <**ResultT** >( | **Bson** filter, - | `java.lang.Class\ `__ resultClass + | `java.lang.Class\ `__ resultClass | ) @@ -354,7 +354,7 @@ Method Summary | **Bson** filter, | **Bson** replacement, | :ref:`FindOneAndModifyOptions ` options, - | `java.lang.Class\ `__ resultClass + | `java.lang.Class\ `__ resultClass | ) @@ -380,7 +380,7 @@ Method Summary - | :ref:`findOneAndReplace ` <**ResultT** >( | **Bson** filter, | **Bson** replacement, - | `java.lang.Class\ `__ resultClass + | `java.lang.Class\ `__ resultClass | ) @@ -406,7 +406,7 @@ Method Summary | **Bson** filter, | **Bson** update, | :ref:`FindOneAndModifyOptions ` options, - | `java.lang.Class\ `__ resultClass + | `java.lang.Class\ `__ resultClass | ) @@ -432,7 +432,7 @@ Method Summary - | :ref:`findOneAndUpdate ` <**ResultT** >( | **Bson** filter, | **Bson** update, - | `java.lang.Class\ `__ resultClass + | `java.lang.Class\ `__ resultClass | ) @@ -463,7 +463,7 @@ Method Summary - * - public `Class `__ + * - public `Class `__ - | :ref:`getDocumentClass ` () | @@ -473,7 +473,7 @@ Method Summary - * - public `String `__ + * - public `String `__ - | :ref:`getName ` () | @@ -495,7 +495,7 @@ Method Summary * - public :ref:`RealmResultTask ` - | :ref:`insertMany ` ( - | `java.util.List\ `__ documents + | `java.util.List\ `__ documents | ) @@ -686,7 +686,7 @@ Method Summary * - public :ref:`MongoCollection ` - | :ref:`withDocumentClass ` <**NewDocumentT** >( - | `java.lang.Class\ `__ clazz + | `java.lang.Class\ `__ clazz | ) @@ -703,7 +703,7 @@ Inherited Methods -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` +- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` @@ -806,8 +806,8 @@ aggregate :header-rows: 1 * - | public :ref:`AggregateIterable ` :ref:`aggregate ` <**ResultT** >( - | `java.util.List\ `__ pipeline, - | `java.lang.Class\ `__ resultClass + | `java.util.List\ `__ pipeline, + | `java.lang.Class\ `__ resultClass | ) @@ -880,7 +880,7 @@ aggregate :header-rows: 1 * - | public :ref:`AggregateIterable ` :ref:`aggregate ` ( - | `java.util.List\ `__ pipeline + | `java.util.List\ `__ pipeline | ) @@ -1273,7 +1273,7 @@ find * - | public :ref:`FindIterable ` :ref:`find ` <**ResultT** >( | **Bson** filter, - | `java.lang.Class\ `__ resultClass, + | `java.lang.Class\ `__ resultClass, | :ref:`FindOptions ` options | ) @@ -1362,7 +1362,7 @@ find * - | public :ref:`FindIterable ` :ref:`find ` <**ResultT** >( | **Bson** filter, - | `java.lang.Class\ `__ resultClass + | `java.lang.Class\ `__ resultClass | ) @@ -1586,7 +1586,7 @@ find :header-rows: 1 * - | public :ref:`FindIterable ` :ref:`find ` <**ResultT** >( - | `java.lang.Class\ `__ resultClass, + | `java.lang.Class\ `__ resultClass, | :ref:`FindOptions ` options | ) @@ -1658,7 +1658,7 @@ find :header-rows: 1 * - | public :ref:`FindIterable ` :ref:`find ` <**ResultT** >( - | `java.lang.Class\ `__ resultClass + | `java.lang.Class\ `__ resultClass | ) @@ -1867,7 +1867,7 @@ findOne * - | public :ref:`RealmResultTask ` :ref:`findOne ` <**ResultT** >( | **Bson** filter, | :ref:`FindOptions ` options, - | `java.lang.Class\ `__ resultClass + | `java.lang.Class\ `__ resultClass | ) @@ -2017,7 +2017,7 @@ findOne * - | public :ref:`RealmResultTask ` :ref:`findOne ` <**ResultT** >( | **Bson** filter, - | `java.lang.Class\ `__ resultClass + | `java.lang.Class\ `__ resultClass | ) @@ -2123,7 +2123,7 @@ findOne :header-rows: 1 * - | public :ref:`RealmResultTask ` :ref:`findOne ` <**ResultT** >( - | `java.lang.Class\ `__ resultClass + | `java.lang.Class\ `__ resultClass | ) @@ -2267,7 +2267,7 @@ findOneAndDelete * - | public :ref:`RealmResultTask ` :ref:`findOneAndDelete ` <**ResultT** >( | **Bson** filter, | :ref:`FindOneAndModifyOptions ` options, - | `java.lang.Class\ `__ resultClass + | `java.lang.Class\ `__ resultClass | ) @@ -2417,7 +2417,7 @@ findOneAndDelete * - | public :ref:`RealmResultTask ` :ref:`findOneAndDelete ` <**ResultT** >( | **Bson** filter, - | `java.lang.Class\ `__ resultClass + | `java.lang.Class\ `__ resultClass | ) @@ -2581,7 +2581,7 @@ findOneAndReplace | **Bson** filter, | **Bson** replacement, | :ref:`FindOneAndModifyOptions ` options, - | `java.lang.Class\ `__ resultClass + | `java.lang.Class\ `__ resultClass | ) @@ -2741,7 +2741,7 @@ findOneAndReplace * - | public :ref:`RealmResultTask ` :ref:`findOneAndReplace ` <**ResultT** >( | **Bson** filter, | **Bson** replacement, - | `java.lang.Class\ `__ resultClass + | `java.lang.Class\ `__ resultClass | ) @@ -2920,7 +2920,7 @@ findOneAndUpdate | **Bson** filter, | **Bson** update, | :ref:`FindOneAndModifyOptions ` options, - | `java.lang.Class\ `__ resultClass + | `java.lang.Class\ `__ resultClass | ) @@ -3080,7 +3080,7 @@ findOneAndUpdate * - | public :ref:`RealmResultTask ` :ref:`findOneAndUpdate ` <**ResultT** >( | **Bson** filter, | **Bson** update, - | `java.lang.Class\ `__ resultClass + | `java.lang.Class\ `__ resultClass | ) @@ -3254,13 +3254,13 @@ getDocumentClass .. list-table:: :header-rows: 1 - * - | public `Class `__ :ref:`getDocumentClass ` () + * - | public `Class `__ :ref:`getDocumentClass ` () | - * - Gets the class of documents stored in this collection.If you used the simple :ref:`MongoDatabase.getCollection(String) ` to get this collection, this is **org.bson.Document**. + * - Gets the class of documents stored in this collection.If you used the simple :ref:`MongoDatabase.getCollection(String) ` to get this collection, this is `org.bson.Document `__ . @@ -3305,7 +3305,7 @@ getName .. list-table:: :header-rows: 1 - * - | public `String `__ :ref:`getName ` () + * - | public `String `__ :ref:`getName ` () | @@ -3418,7 +3418,7 @@ insertMany :header-rows: 1 * - | public :ref:`RealmResultTask ` :ref:`insertMany ` ( - | `java.util.List\ `__ documents + | `java.util.List\ `__ documents | ) @@ -4130,9 +4130,9 @@ watchWithFilter - * - Watches a collection. The provided BSON document will be used as a match expression filter on the change events coming from the stream.See `how to define a match filter `__ . + * - Watches a collection. The provided BSON document will be used as a match expression filter on the change events coming from the stream.See `how to define a match filter `__ . - Defining the match expression to filter ChangeEvents is similar to `how to define the match expression for triggers `__ + Defining the match expression to filter ChangeEvents is similar to `how to define the match expression for triggers `__ @@ -4179,9 +4179,9 @@ watchWithFilter * - Watches a collection. The provided document will be used as a match expression filter on the change events coming from the stream. This convenience overload supports the use of non-**BsonDocument** instances for the user. - See `how to define a match filter `__ . + See `how to define a match filter `__ . - Defining the match expression to filter ChangeEvents is similar to `how to define the match expression for triggers `__ + Defining the match expression to filter ChangeEvents is similar to `how to define the match expression for triggers `__ @@ -4245,9 +4245,9 @@ watchWithFilterAsync - * - Watches a collection asynchronously. The provided BSON document will be used as a match expression filter on the change events coming from the stream.See `how to define a match filter `__ . + * - Watches a collection asynchronously. The provided BSON document will be used as a match expression filter on the change events coming from the stream.See `how to define a match filter `__ . - Defining the match expression to filter ChangeEvents is similar to `how to define the match expression for triggers `__ + Defining the match expression to filter ChangeEvents is similar to `how to define the match expression for triggers `__ @@ -4294,9 +4294,9 @@ watchWithFilterAsync * - Watches a collection asynchronously. The provided document will be used as a match expression filter on the change events coming from the stream. This convenience overload supports the use of non-**BsonDocument** instances for the user. - See `how to define a match filter `__ . + See `how to define a match filter `__ . - Defining the match expression to filter ChangeEvents is similar to `how to define the match expression for triggers `__ + Defining the match expression to filter ChangeEvents is similar to `how to define the match expression for triggers `__ @@ -4426,7 +4426,7 @@ withDocumentClass :header-rows: 1 * - | public :ref:`MongoCollection ` :ref:`withDocumentClass ` <**NewDocumentT** >( - | `java.lang.Class\ `__ clazz + | `java.lang.Class\ `__ clazz | ) diff --git a/source/sdk/java/api/io/realm/mongodb/mongo/MongoDatabase.txt b/source/sdk/java/api/io/realm/mongodb/mongo/MongoDatabase.txt index 9102ec54cc..80d4b31894 100644 --- a/source/sdk/java/api/io/realm/mongodb/mongo/MongoDatabase.txt +++ b/source/sdk/java/api/io/realm/mongodb/mongo/MongoDatabase.txt @@ -18,7 +18,7 @@ io.realm.mongodb.mongo ====================== - | `java.lang.Object `__ + | `java.lang.Object `__ | io.realm.mongodb.mongo.MongoDatabase @@ -38,8 +38,8 @@ Method Summary * - public :ref:`MongoCollection ` - | :ref:`getCollection ` <**DocumentT** >( - | `String `__ collectionName, - | `java.lang.Class\ `__ documentClass + | `String `__ collectionName, + | `java.lang.Class\ `__ documentClass | ) @@ -50,7 +50,7 @@ Method Summary * - public :ref:`MongoCollection ` - | :ref:`getCollection ` ( - | `String `__ collectionName + | `String `__ collectionName | ) @@ -59,7 +59,7 @@ Method Summary - * - public `String `__ + * - public `String `__ - | :ref:`getName ` () | @@ -77,7 +77,7 @@ Inherited Methods -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` +- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` @@ -156,8 +156,8 @@ getCollection :header-rows: 1 * - | public :ref:`MongoCollection ` :ref:`getCollection ` <**DocumentT** >( - | `String `__ collectionName, - | `java.lang.Class\ `__ documentClass + | `String `__ collectionName, + | `java.lang.Class\ `__ documentClass | ) @@ -220,7 +220,7 @@ getCollection :header-rows: 1 * - | public :ref:`MongoCollection ` :ref:`getCollection ` ( - | `String `__ collectionName + | `String `__ collectionName | ) @@ -275,7 +275,7 @@ getName .. list-table:: :header-rows: 1 - * - | public `String `__ :ref:`getName ` () + * - | public `String `__ :ref:`getName ` () | diff --git a/source/sdk/java/api/io/realm/mongodb/mongo/MongoNamespace.txt b/source/sdk/java/api/io/realm/mongodb/mongo/MongoNamespace.txt index cab19db376..8a6f91ace1 100644 --- a/source/sdk/java/api/io/realm/mongodb/mongo/MongoNamespace.txt +++ b/source/sdk/java/api/io/realm/mongodb/mongo/MongoNamespace.txt @@ -18,7 +18,7 @@ io.realm.mongodb.mongo ====================== - | `java.lang.Object `__ + | `java.lang.Object `__ | io.realm.mongodb.mongo.MongoNamespace @@ -34,7 +34,7 @@ Constructors * - Constructor and Description * - | :ref:`MongoNamespace ` ( - | `String `__ fullName + | `String `__ fullName | ) @@ -44,8 +44,8 @@ Constructors * - | :ref:`MongoNamespace ` ( - | `String `__ databaseName, - | `String `__ collectionName + | `String `__ databaseName, + | `String `__ collectionName | ) @@ -66,7 +66,7 @@ Field Summary * - Modifier and Type - Field and Description - * - public static final `String `__ + * - public static final `String `__ - :ref:`COMMAND_COLLECTION_NAME ` @@ -88,7 +88,7 @@ Method Summary * - public static **void** - | :ref:`checkCollectionNameValidity ` ( - | `String `__ collectionName + | `String `__ collectionName | ) @@ -99,7 +99,7 @@ Method Summary * - public static **void** - | :ref:`checkDatabaseNameValidity ` ( - | `String `__ databaseName + | `String `__ databaseName | ) @@ -110,7 +110,7 @@ Method Summary * - public **boolean** - | :ref:`equals ` ( - | `Object `__ o + | `Object `__ o | ) @@ -119,7 +119,7 @@ Method Summary - * - public `String `__ + * - public `String `__ - | :ref:`getCollectionName ` () | @@ -129,7 +129,7 @@ Method Summary - * - public `String `__ + * - public `String `__ - | :ref:`getDatabaseName ` () | @@ -139,7 +139,7 @@ Method Summary - * - public `String `__ + * - public `String `__ - | :ref:`getFullName ` () | @@ -159,7 +159,7 @@ Method Summary - * - public `String `__ + * - public `String `__ - | :ref:`toString ` () | @@ -179,7 +179,7 @@ Inherited Methods -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` +- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` @@ -214,7 +214,7 @@ Constructor Detail :header-rows: 1 * - | public :ref:`MongoNamespace ` ( - | `String `__ fullName + | `String `__ fullName | ) @@ -272,8 +272,8 @@ Constructor Detail :header-rows: 1 * - | public :ref:`MongoNamespace ` ( - | `String `__ databaseName, - | `String `__ collectionName + | `String `__ databaseName, + | `String `__ collectionName | ) @@ -359,7 +359,7 @@ checkCollectionNameValidity :header-rows: 1 * - | public static **void** :ref:`checkCollectionNameValidity ` ( - | `String `__ collectionName + | `String `__ collectionName | ) @@ -384,7 +384,7 @@ checkCollectionNameValidity **Throws** - - `IllegalArgumentException `__ - if the collection name is invalid + - `IllegalArgumentException `__ - if the collection name is invalid @@ -430,7 +430,7 @@ checkDatabaseNameValidity :header-rows: 1 * - | public static **void** :ref:`checkDatabaseNameValidity ` ( - | `String `__ databaseName + | `String `__ databaseName | ) @@ -457,7 +457,7 @@ checkDatabaseNameValidity **Throws** - - `IllegalArgumentException `__ - if the database name is invalid + - `IllegalArgumentException `__ - if the database name is invalid @@ -503,7 +503,7 @@ equals :header-rows: 1 * - | public **boolean** :ref:`equals ` ( - | `Object `__ o + | `Object `__ o | ) @@ -522,7 +522,7 @@ equals **Overrides** - ``equals`` in class `Object `__ + ``equals`` in class `Object `__ @@ -549,7 +549,7 @@ getCollectionName .. list-table:: :header-rows: 1 - * - | public `String `__ :ref:`getCollectionName ` () + * - | public `String `__ :ref:`getCollectionName ` () | @@ -596,7 +596,7 @@ getDatabaseName .. list-table:: :header-rows: 1 - * - | public `String `__ :ref:`getDatabaseName ` () + * - | public `String `__ :ref:`getDatabaseName ` () | @@ -643,7 +643,7 @@ getFullName .. list-table:: :header-rows: 1 - * - | public `String `__ :ref:`getFullName ` () + * - | public `String `__ :ref:`getFullName ` () | @@ -709,7 +709,7 @@ hashCode **Overrides** - ``hashCode`` in class `Object `__ + ``hashCode`` in class `Object `__ @@ -736,7 +736,7 @@ toString .. list-table:: :header-rows: 1 - * - | public `String `__ :ref:`toString ` () + * - | public `String `__ :ref:`toString ` () | @@ -762,7 +762,7 @@ toString **Overrides** - ``toString`` in class `Object `__ + ``toString`` in class `Object `__ diff --git a/source/sdk/java/api/io/realm/mongodb/mongo/events/BaseChangeEvent.txt b/source/sdk/java/api/io/realm/mongodb/mongo/events/BaseChangeEvent.txt index 235ca6d399..7e7e12256f 100644 --- a/source/sdk/java/api/io/realm/mongodb/mongo/events/BaseChangeEvent.txt +++ b/source/sdk/java/api/io/realm/mongodb/mongo/events/BaseChangeEvent.txt @@ -18,7 +18,7 @@ io.realm.mongodb.mongo.events ============================= - | `java.lang.Object `__ + | `java.lang.Object `__ | io.realm.mongodb.mongo.events.BaseChangeEvent @@ -118,7 +118,7 @@ Inherited Methods -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` +- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` diff --git a/source/sdk/java/api/io/realm/mongodb/mongo/events/BaseChangeEvent/OperationType.txt b/source/sdk/java/api/io/realm/mongodb/mongo/events/BaseChangeEvent/OperationType.txt index ede097e740..96f73a06b4 100644 --- a/source/sdk/java/api/io/realm/mongodb/mongo/events/BaseChangeEvent/OperationType.txt +++ b/source/sdk/java/api/io/realm/mongodb/mongo/events/BaseChangeEvent/OperationType.txt @@ -18,8 +18,8 @@ io.realm.mongodb.mongo.events ============================= - | `java.lang.Object `__ - | `java.lang.Enum `__ + | `java.lang.Object `__ + | `java.lang.Enum `__ | io.realm.mongodb.mongo.events.BaseChangeEvent.OperationType @@ -91,7 +91,7 @@ Method Summary * - public static :ref:`BaseChangeEvent.OperationType ` - | :ref:`valueOf ` ( - | `String `__ name + | `String `__ name | ) @@ -118,8 +118,8 @@ Inherited Methods -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` -- Methods inherited from class `java.lang.Enum `__ : ``name`` , ``ordinal`` , ``toString`` , ``equals`` , ``hashCode`` , ``clone`` , ``compareTo`` , ``getDeclaringClass`` , ``valueOf`` , ``finalize`` +- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` +- Methods inherited from class `java.lang.Enum `__ : ``name`` , ``ordinal`` , ``toString`` , ``equals`` , ``hashCode`` , ``clone`` , ``compareTo`` , ``getDeclaringClass`` , ``valueOf`` , ``finalize`` @@ -244,7 +244,7 @@ valueOf :header-rows: 1 * - | public static :ref:`BaseChangeEvent.OperationType ` :ref:`valueOf ` ( - | `String `__ name + | `String `__ name | ) diff --git a/source/sdk/java/api/io/realm/mongodb/mongo/events/UpdateDescription.txt b/source/sdk/java/api/io/realm/mongodb/mongo/events/UpdateDescription.txt index 722c05b9ed..bcc90a86d9 100644 --- a/source/sdk/java/api/io/realm/mongodb/mongo/events/UpdateDescription.txt +++ b/source/sdk/java/api/io/realm/mongodb/mongo/events/UpdateDescription.txt @@ -18,7 +18,7 @@ io.realm.mongodb.mongo.events ============================= - | `java.lang.Object `__ + | `java.lang.Object `__ | io.realm.mongodb.mongo.events.UpdateDescription @@ -48,7 +48,7 @@ Method Summary * - public **boolean** - | :ref:`equals ` ( - | `Object `__ obj + | `Object `__ obj | ) @@ -68,12 +68,12 @@ Method Summary - * - public `Collection `__ + * - public `Collection `__ - | :ref:`getRemovedFields ` () | - Returns a `List `__ containing the field names that have been removed in the corresponding update. + Returns a `List `__ containing the field names that have been removed in the corresponding update. @@ -151,7 +151,7 @@ Inherited Methods -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` +- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` @@ -267,7 +267,7 @@ equals :header-rows: 1 * - | public **boolean** :ref:`equals ` ( - | `Object `__ obj + | `Object `__ obj | ) @@ -286,7 +286,7 @@ equals **Overrides** - ``equals`` in class `Object `__ + ``equals`` in class `Object `__ @@ -375,13 +375,13 @@ getRemovedFields .. list-table:: :header-rows: 1 - * - | public `Collection `__ :ref:`getRemovedFields ` () + * - | public `Collection `__ :ref:`getRemovedFields ` () | - * - Returns a `List `__ containing the field names that have been removed in the corresponding update. + * - Returns a `List `__ containing the field names that have been removed in the corresponding update. @@ -492,7 +492,7 @@ hashCode **Overrides** - ``hashCode`` in class `Object `__ + ``hashCode`` in class `Object `__ diff --git a/source/sdk/java/api/io/realm/mongodb/mongo/iterable/AggregateIterable.txt b/source/sdk/java/api/io/realm/mongodb/mongo/iterable/AggregateIterable.txt index 6c8544fa6e..cfdd90d6be 100644 --- a/source/sdk/java/api/io/realm/mongodb/mongo/iterable/AggregateIterable.txt +++ b/source/sdk/java/api/io/realm/mongodb/mongo/iterable/AggregateIterable.txt @@ -18,7 +18,7 @@ io.realm.mongodb.mongo.iterable =============================== - | `java.lang.Object `__ + | `java.lang.Object `__ | :ref:`io.realm.mongodb.mongo.iterable.MongoIterable ` | io.realm.mongodb.mongo.iterable.AggregateIterable @@ -37,11 +37,11 @@ Constructors * - Constructor and Description * - | :ref:`AggregateIterable ` ( - | `ThreadPoolExecutor `__ threadPoolExecutor, - | **io.realm.internal.objectstore.OsMongoCollection** osMongoCollection, + | `ThreadPoolExecutor `__ threadPoolExecutor, + | **** osMongoCollection, | **CodecRegistry** codecRegistry, - | `java.lang.Class\ `__ resultClass, - | `java.util.List\ `__ pipeline + | `java.lang.Class\ `__ resultClass, + | `java.util.List\ `__ pipeline | ) @@ -58,7 +58,7 @@ Inherited Methods -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` +- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` - Methods inherited from class :ref:`io.realm.mongodb.mongo.iterable.MongoIterable ` : ``iterator`` , ``first`` @@ -79,11 +79,11 @@ Constructor Detail :header-rows: 1 * - | public :ref:`AggregateIterable ` ( - | `ThreadPoolExecutor `__ threadPoolExecutor, - | **io.realm.internal.objectstore.OsMongoCollection** osMongoCollection, + | `ThreadPoolExecutor `__ threadPoolExecutor, + | **** osMongoCollection, | **CodecRegistry** codecRegistry, - | `java.lang.Class\ `__ resultClass, - | `java.util.List\ `__ pipeline + | `java.lang.Class\ `__ resultClass, + | `java.util.List\ `__ pipeline | ) diff --git a/source/sdk/java/api/io/realm/mongodb/mongo/iterable/FindIterable.txt b/source/sdk/java/api/io/realm/mongodb/mongo/iterable/FindIterable.txt index 5f9c4f1b78..12f64d5250 100644 --- a/source/sdk/java/api/io/realm/mongodb/mongo/iterable/FindIterable.txt +++ b/source/sdk/java/api/io/realm/mongodb/mongo/iterable/FindIterable.txt @@ -18,7 +18,7 @@ io.realm.mongodb.mongo.iterable =============================== - | `java.lang.Object `__ + | `java.lang.Object `__ | :ref:`io.realm.mongodb.mongo.iterable.MongoIterable ` | io.realm.mongodb.mongo.iterable.FindIterable @@ -37,10 +37,10 @@ Constructors * - Constructor and Description * - | :ref:`FindIterable ` ( - | `ThreadPoolExecutor `__ threadPoolExecutor, - | **io.realm.internal.objectstore.OsMongoCollection** osMongoCollection, + | `ThreadPoolExecutor `__ threadPoolExecutor, + | **** osMongoCollection, | **CodecRegistry** codecRegistry, - | `java.lang.Class\ `__ resultClass + | `java.lang.Class\ `__ resultClass | ) @@ -113,7 +113,7 @@ Inherited Methods -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` +- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` - Methods inherited from class :ref:`io.realm.mongodb.mongo.iterable.MongoIterable ` : ``iterator`` , ``first`` @@ -134,10 +134,10 @@ Constructor Detail :header-rows: 1 * - | public :ref:`FindIterable ` ( - | `ThreadPoolExecutor `__ threadPoolExecutor, - | **io.realm.internal.objectstore.OsMongoCollection** osMongoCollection, + | `ThreadPoolExecutor `__ threadPoolExecutor, + | **** osMongoCollection, | **CodecRegistry** codecRegistry, - | `java.lang.Class\ `__ resultClass + | `java.lang.Class\ `__ resultClass | ) diff --git a/source/sdk/java/api/io/realm/mongodb/mongo/iterable/MongoCursor.txt b/source/sdk/java/api/io/realm/mongodb/mongo/iterable/MongoCursor.txt index 6357c16316..08280c0b41 100644 --- a/source/sdk/java/api/io/realm/mongodb/mongo/iterable/MongoCursor.txt +++ b/source/sdk/java/api/io/realm/mongodb/mongo/iterable/MongoCursor.txt @@ -18,7 +18,7 @@ io.realm.mongodb.mongo.iterable =============================== - | `java.lang.Object `__ + | `java.lang.Object `__ | io.realm.mongodb.mongo.iterable.MongoCursor @@ -26,12 +26,12 @@ io.realm.mongodb.mongo.iterable -- `java.util.Iterator `__ -- `java.io.Closeable `__ -- `java.lang.AutoCloseable `__ +- `java.util.Iterator `__ +- `java.io.Closeable `__ +- `java.lang.AutoCloseable `__ -The Mongo Cursor class is fundamentally an `Iterator `__ containing an additional ``tryNext()`` method for convenience. +The Mongo Cursor class is fundamentally an `Iterator `__ containing an additional ``tryNext()`` method for convenience. An application should ensure that a cursor is closed in all circumstances, e.g. using a try-with-resources statement. @@ -97,7 +97,7 @@ Inherited Methods -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` +- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` diff --git a/source/sdk/java/api/io/realm/mongodb/mongo/iterable/MongoIterable.txt b/source/sdk/java/api/io/realm/mongodb/mongo/iterable/MongoIterable.txt index f6754e4288..19394569f3 100644 --- a/source/sdk/java/api/io/realm/mongodb/mongo/iterable/MongoIterable.txt +++ b/source/sdk/java/api/io/realm/mongodb/mongo/iterable/MongoIterable.txt @@ -18,13 +18,13 @@ io.realm.mongodb.mongo.iterable =============================== - | `java.lang.Object `__ + | `java.lang.Object `__ | io.realm.mongodb.mongo.iterable.MongoIterable The MongoIterable is the results from an operation, such as a ``find()`` or an ``aggregate()`` query. -This class somewhat mimics the behavior of an `Iterable `__ but given its results are obtained asynchronously, its values are wrapped inside a ``Task`` . +This class somewhat mimics the behavior of an `Iterable `__ but given its results are obtained asynchronously, its values are wrapped inside a ``Task`` . @@ -68,7 +68,7 @@ Inherited Methods -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` +- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` diff --git a/source/sdk/java/api/io/realm/mongodb/mongo/options/CountOptions.txt b/source/sdk/java/api/io/realm/mongodb/mongo/options/CountOptions.txt index cc99132d72..c633e4533b 100644 --- a/source/sdk/java/api/io/realm/mongodb/mongo/options/CountOptions.txt +++ b/source/sdk/java/api/io/realm/mongodb/mongo/options/CountOptions.txt @@ -18,7 +18,7 @@ io.realm.mongodb.mongo.options ============================== - | `java.lang.Object `__ + | `java.lang.Object `__ | io.realm.mongodb.mongo.options.CountOptions @@ -75,7 +75,7 @@ Method Summary - * - public `String `__ + * - public `String `__ - | :ref:`toString ` () | @@ -93,7 +93,7 @@ Inherited Methods -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` +- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` @@ -264,7 +264,7 @@ toString .. list-table:: :header-rows: 1 - * - | public `String `__ :ref:`toString ` () + * - | public `String `__ :ref:`toString ` () | @@ -283,7 +283,7 @@ toString **Overrides** - ``toString`` in class `Object `__ + ``toString`` in class `Object `__ diff --git a/source/sdk/java/api/io/realm/mongodb/mongo/options/FindOneAndModifyOptions.txt b/source/sdk/java/api/io/realm/mongodb/mongo/options/FindOneAndModifyOptions.txt index b984432ad5..5e04338f5f 100644 --- a/source/sdk/java/api/io/realm/mongodb/mongo/options/FindOneAndModifyOptions.txt +++ b/source/sdk/java/api/io/realm/mongodb/mongo/options/FindOneAndModifyOptions.txt @@ -18,7 +18,7 @@ io.realm.mongodb.mongo.options ============================== - | `java.lang.Object `__ + | `java.lang.Object `__ | io.realm.mongodb.mongo.options.FindOneAndModifyOptions @@ -127,7 +127,7 @@ Method Summary - * - public `String `__ + * - public `String `__ - | :ref:`toString ` () | @@ -156,7 +156,7 @@ Inherited Methods -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` +- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` @@ -592,7 +592,7 @@ toString .. list-table:: :header-rows: 1 - * - | public `String `__ :ref:`toString ` () + * - | public `String `__ :ref:`toString ` () | @@ -611,7 +611,7 @@ toString **Overrides** - ``toString`` in class `Object `__ + ``toString`` in class `Object `__ diff --git a/source/sdk/java/api/io/realm/mongodb/mongo/options/FindOptions.txt b/source/sdk/java/api/io/realm/mongodb/mongo/options/FindOptions.txt index e965ecc554..c26893825b 100644 --- a/source/sdk/java/api/io/realm/mongodb/mongo/options/FindOptions.txt +++ b/source/sdk/java/api/io/realm/mongodb/mongo/options/FindOptions.txt @@ -18,7 +18,7 @@ io.realm.mongodb.mongo.options ============================== - | `java.lang.Object `__ + | `java.lang.Object `__ | io.realm.mongodb.mongo.options.FindOptions @@ -117,7 +117,7 @@ Method Summary - * - public `String `__ + * - public `String `__ - | :ref:`toString ` () | @@ -135,7 +135,7 @@ Inherited Methods -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` +- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` @@ -524,7 +524,7 @@ toString .. list-table:: :header-rows: 1 - * - | public `String `__ :ref:`toString ` () + * - | public `String `__ :ref:`toString ` () | @@ -543,7 +543,7 @@ toString **Overrides** - ``toString`` in class `Object `__ + ``toString`` in class `Object `__ diff --git a/source/sdk/java/api/io/realm/mongodb/mongo/options/InsertManyResult.txt b/source/sdk/java/api/io/realm/mongodb/mongo/options/InsertManyResult.txt index c10a099a94..087be98e1e 100644 --- a/source/sdk/java/api/io/realm/mongodb/mongo/options/InsertManyResult.txt +++ b/source/sdk/java/api/io/realm/mongodb/mongo/options/InsertManyResult.txt @@ -18,7 +18,7 @@ io.realm.mongodb.mongo.options ============================== - | `java.lang.Object `__ + | `java.lang.Object `__ | io.realm.mongodb.mongo.options.InsertManyResult @@ -34,7 +34,7 @@ Constructors * - Constructor and Description * - | :ref:`InsertManyResult ` ( - | `java.util.Map\ `__ insertedIds + | `java.util.Map\ `__ insertedIds | ) @@ -55,7 +55,7 @@ Method Summary * - Modifier and Type - Method and Description - * - public `Map `__ + * - public `Map `__ - | :ref:`getInsertedIds ` () | @@ -73,7 +73,7 @@ Inherited Methods -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` +- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` @@ -93,7 +93,7 @@ Constructor Detail :header-rows: 1 * - | public :ref:`InsertManyResult ` ( - | `java.util.Map\ `__ insertedIds + | `java.util.Map\ `__ insertedIds | ) @@ -144,7 +144,7 @@ getInsertedIds .. list-table:: :header-rows: 1 - * - | public `Map `__ :ref:`getInsertedIds ` () + * - | public `Map `__ :ref:`getInsertedIds ` () | diff --git a/source/sdk/java/api/io/realm/mongodb/mongo/options/UpdateOptions.txt b/source/sdk/java/api/io/realm/mongodb/mongo/options/UpdateOptions.txt index f5ee0b2bff..08feb12d15 100644 --- a/source/sdk/java/api/io/realm/mongodb/mongo/options/UpdateOptions.txt +++ b/source/sdk/java/api/io/realm/mongodb/mongo/options/UpdateOptions.txt @@ -18,7 +18,7 @@ io.realm.mongodb.mongo.options ============================== - | `java.lang.Object `__ + | `java.lang.Object `__ | io.realm.mongodb.mongo.options.UpdateOptions @@ -64,7 +64,7 @@ Method Summary - * - public `String `__ + * - public `String `__ - | :ref:`toString ` () | @@ -93,7 +93,7 @@ Inherited Methods -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` +- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` @@ -202,7 +202,7 @@ toString .. list-table:: :header-rows: 1 - * - | public `String `__ :ref:`toString ` () + * - | public `String `__ :ref:`toString ` () | @@ -221,7 +221,7 @@ toString **Overrides** - ``toString`` in class `Object `__ + ``toString`` in class `Object `__ diff --git a/source/sdk/java/api/io/realm/mongodb/mongo/result/DeleteResult.txt b/source/sdk/java/api/io/realm/mongodb/mongo/result/DeleteResult.txt index e3c8d95bea..c321f29df4 100644 --- a/source/sdk/java/api/io/realm/mongodb/mongo/result/DeleteResult.txt +++ b/source/sdk/java/api/io/realm/mongodb/mongo/result/DeleteResult.txt @@ -18,7 +18,7 @@ io.realm.mongodb.mongo.result ============================= - | `java.lang.Object `__ + | `java.lang.Object `__ | io.realm.mongodb.mongo.result.DeleteResult @@ -73,7 +73,7 @@ Inherited Methods -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` +- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` diff --git a/source/sdk/java/api/io/realm/mongodb/mongo/result/InsertOneResult.txt b/source/sdk/java/api/io/realm/mongodb/mongo/result/InsertOneResult.txt index 535d90341e..fa385a8713 100644 --- a/source/sdk/java/api/io/realm/mongodb/mongo/result/InsertOneResult.txt +++ b/source/sdk/java/api/io/realm/mongodb/mongo/result/InsertOneResult.txt @@ -18,7 +18,7 @@ io.realm.mongodb.mongo.result ============================= - | `java.lang.Object `__ + | `java.lang.Object `__ | io.realm.mongodb.mongo.result.InsertOneResult @@ -73,7 +73,7 @@ Inherited Methods -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` +- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` diff --git a/source/sdk/java/api/io/realm/mongodb/mongo/result/UpdateResult.txt b/source/sdk/java/api/io/realm/mongodb/mongo/result/UpdateResult.txt index 15ef5ea548..7142e15de3 100644 --- a/source/sdk/java/api/io/realm/mongodb/mongo/result/UpdateResult.txt +++ b/source/sdk/java/api/io/realm/mongodb/mongo/result/UpdateResult.txt @@ -18,7 +18,7 @@ io.realm.mongodb.mongo.result ============================= - | `java.lang.Object `__ + | `java.lang.Object `__ | io.realm.mongodb.mongo.result.UpdateResult @@ -95,7 +95,7 @@ Inherited Methods -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` +- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` diff --git a/source/sdk/java/api/io/realm/mongodb/push/Push.txt b/source/sdk/java/api/io/realm/mongodb/push/Push.txt index 4f6c7fcbd3..ac7aefc7b8 100644 --- a/source/sdk/java/api/io/realm/mongodb/push/Push.txt +++ b/source/sdk/java/api/io/realm/mongodb/push/Push.txt @@ -18,7 +18,7 @@ io.realm.mongodb.push ===================== - | `java.lang.Object `__ + | `java.lang.Object `__ | io.realm.mongodb.push.Push @@ -78,7 +78,7 @@ Method Summary * - public **void** - | :ref:`registerDevice ` ( - | `String `__ registrationToken + | `String `__ registrationToken | ) @@ -89,7 +89,7 @@ Method Summary * - public :ref:`RealmAsyncTask ` - | :ref:`registerDeviceAsync ` ( - | `String `__ registrationToken, + | `String `__ registrationToken, | :ref:`io.realm.mongodb.App.Callback\ ` callback | ) @@ -107,7 +107,7 @@ Inherited Methods -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` +- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` @@ -296,7 +296,7 @@ registerDevice :header-rows: 1 * - | public **void** :ref:`registerDevice ` ( - | `String `__ registrationToken + | `String `__ registrationToken | ) @@ -421,7 +421,7 @@ registerDeviceAsync :header-rows: 1 * - | public :ref:`RealmAsyncTask ` :ref:`registerDeviceAsync ` ( - | `String `__ registrationToken, + | `String `__ registrationToken, | :ref:`io.realm.mongodb.App.Callback\ ` callback | ) diff --git a/source/sdk/java/api/io/realm/mongodb/sync.txt b/source/sdk/java/api/io/realm/mongodb/sync.txt index 7a687ff3ec..745f020509 100644 --- a/source/sdk/java/api/io/realm/mongodb/sync.txt +++ b/source/sdk/java/api/io/realm/mongodb/sync.txt @@ -17,13 +17,24 @@ io.realm.mongodb.sync ConnectionListener ConnectionState + DiscardUnsyncedChangesStrategy + ManuallyRecoverUnsyncedChangesStrategy + MutableSubscriptionSet Progress ProgressListener ProgressMode + Subscription + SubscriptionSet + SubscriptionSet.State + SubscriptionSet.StateChangeCallback + SubscriptionSet.UpdateAsyncCallback + SubscriptionSet.UpdateCallback Sync Sync.Debug + SyncClientResetStrategy SyncConfiguration SyncConfiguration.Builder + SyncConfiguration.InitialFlexibleSyncSubscriptions SyncSession SyncSession.ClientResetHandler SyncSession.ErrorHandler @@ -36,13 +47,24 @@ io.realm.mongodb.sync - :ref:`io.realm.mongodb.sync.ConnectionListener ` - :ref:`io.realm.mongodb.sync.ConnectionState ` +- :ref:`io.realm.mongodb.sync.DiscardUnsyncedChangesStrategy ` +- :ref:`io.realm.mongodb.sync.ManuallyRecoverUnsyncedChangesStrategy ` +- :ref:`io.realm.mongodb.sync.MutableSubscriptionSet ` - :ref:`io.realm.mongodb.sync.Progress ` - :ref:`io.realm.mongodb.sync.ProgressListener ` - :ref:`io.realm.mongodb.sync.ProgressMode ` +- :ref:`io.realm.mongodb.sync.Subscription ` +- :ref:`io.realm.mongodb.sync.SubscriptionSet ` +- :ref:`io.realm.mongodb.sync.SubscriptionSet.State ` +- :ref:`io.realm.mongodb.sync.SubscriptionSet.StateChangeCallback ` +- :ref:`io.realm.mongodb.sync.SubscriptionSet.UpdateAsyncCallback ` +- :ref:`io.realm.mongodb.sync.SubscriptionSet.UpdateCallback ` - :ref:`io.realm.mongodb.sync.Sync ` - :ref:`io.realm.mongodb.sync.Sync.Debug ` +- :ref:`io.realm.mongodb.sync.SyncClientResetStrategy ` - :ref:`io.realm.mongodb.sync.SyncConfiguration ` - :ref:`io.realm.mongodb.sync.SyncConfiguration.Builder ` +- :ref:`io.realm.mongodb.sync.SyncConfiguration.InitialFlexibleSyncSubscriptions ` - :ref:`io.realm.mongodb.sync.SyncSession ` - :ref:`io.realm.mongodb.sync.SyncSession.ClientResetHandler ` - :ref:`io.realm.mongodb.sync.SyncSession.ErrorHandler ` diff --git a/source/sdk/java/api/io/realm/mongodb/sync/ClientResetRequiredError.txt b/source/sdk/java/api/io/realm/mongodb/sync/ClientResetRequiredError.txt index 21cd2fc5fe..5c33a0403c 100644 --- a/source/sdk/java/api/io/realm/mongodb/sync/ClientResetRequiredError.txt +++ b/source/sdk/java/api/io/realm/mongodb/sync/ClientResetRequiredError.txt @@ -18,10 +18,10 @@ io.realm.mongodb.sync ===================== - | `java.lang.Object `__ - | `java.lang.Throwable `__ - | `java.lang.Exception `__ - | `java.lang.RuntimeException `__ + | `java.lang.Object `__ + | `java.lang.Throwable `__ + | `java.lang.Exception `__ + | `java.lang.RuntimeException `__ | :ref:`io.realm.mongodb.AppException ` | io.realm.mongodb.sync.ClientResetRequiredError @@ -62,7 +62,7 @@ Method Summary - * - public `File `__ + * - public `File `__ - | :ref:`getBackupFile ` () | @@ -77,12 +77,12 @@ Method Summary | - + The configuration that can be used to open the backup Realm offline. - * - public `File `__ + * - public `File `__ - | :ref:`getOriginalFile ` () | @@ -100,8 +100,8 @@ Inherited Methods -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` -- Methods inherited from class `java.lang.Throwable `__ : ``getMessage`` , ``getLocalizedMessage`` , ``getCause`` , ``initCause`` , ``toString`` , ``printStackTrace`` , ``printStackTrace`` , ``printStackTrace`` , ``fillInStackTrace`` , ``getStackTrace`` , ``setStackTrace`` , ``addSuppressed`` , ``getSuppressed`` +- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` +- Methods inherited from class `java.lang.Throwable `__ : ``getMessage`` , ``getLocalizedMessage`` , ``getCause`` , ``initCause`` , ``toString`` , ``printStackTrace`` , ``printStackTrace`` , ``printStackTrace`` , ``fillInStackTrace`` , ``getStackTrace`` , ``setStackTrace`` , ``addSuppressed`` , ``getSuppressed`` - Methods inherited from class :ref:`io.realm.mongodb.AppException ` : ``getErrorCode`` , ``getErrorType`` , ``getErrorIntValue`` , ``getErrorMessage`` , ``getException`` , ``getCategory`` , ``toString`` @@ -136,7 +136,7 @@ executeClientReset - * - Calling this method will execute the Client Reset manually instead of waiting until next app restart. This will only be possible if all instances of that Realm have been closed, otherwise a `IllegalStateException `__ will be thrown. + * - Calling this method will execute the Client Reset manually instead of waiting until next app restart. This will only be possible if all instances of that Realm have been closed, otherwise a `IllegalStateException `__ will be thrown. After this method returns, the backup file can be found in the location returned by :ref:`getBackupFile() ` . The file at :ref:`getOriginalFile() ` have been deleted, but will be recreated from scratch next time a Realm instance is opened. @@ -153,7 +153,7 @@ executeClientReset **Throws** - - `IllegalStateException `__ - if not all instances have been closed. + - `IllegalStateException `__ - if not all instances have been closed. @@ -186,7 +186,7 @@ getBackupFile .. list-table:: :header-rows: 1 - * - | public `File `__ :ref:`getBackupFile ` () + * - | public `File `__ :ref:`getBackupFile ` () | @@ -241,7 +241,9 @@ getBackupRealmConfiguration - * - + * - The configuration that can be used to open the backup Realm offline. This configuration can only be used in combination with a :ref:`DynamicRealm ` . + + @@ -282,7 +284,7 @@ getOriginalFile .. list-table:: :header-rows: 1 - * - | public `File `__ :ref:`getOriginalFile ` () + * - | public `File `__ :ref:`getOriginalFile ` () | diff --git a/source/sdk/java/api/io/realm/mongodb/sync/ConnectionState.txt b/source/sdk/java/api/io/realm/mongodb/sync/ConnectionState.txt index a3253bb5fe..4db226a9bf 100644 --- a/source/sdk/java/api/io/realm/mongodb/sync/ConnectionState.txt +++ b/source/sdk/java/api/io/realm/mongodb/sync/ConnectionState.txt @@ -18,8 +18,8 @@ io.realm.mongodb.sync ===================== - | `java.lang.Object `__ - | `java.lang.Enum `__ + | `java.lang.Object `__ + | `java.lang.Enum `__ | io.realm.mongodb.sync.ConnectionState @@ -71,7 +71,7 @@ Method Summary * - public static :ref:`ConnectionState ` - | :ref:`valueOf ` ( - | `String `__ name + | `String `__ name | ) @@ -98,8 +98,8 @@ Inherited Methods -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` -- Methods inherited from class `java.lang.Enum `__ : ``name`` , ``ordinal`` , ``toString`` , ``equals`` , ``hashCode`` , ``clone`` , ``compareTo`` , ``getDeclaringClass`` , ``valueOf`` , ``finalize`` +- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` +- Methods inherited from class `java.lang.Enum `__ : ``name`` , ``ordinal`` , ``toString`` , ``equals`` , ``hashCode`` , ``clone`` , ``compareTo`` , ``getDeclaringClass`` , ``valueOf`` , ``finalize`` @@ -196,7 +196,7 @@ valueOf :header-rows: 1 * - | public static :ref:`ConnectionState ` :ref:`valueOf ` ( - | `String `__ name + | `String `__ name | ) diff --git a/source/sdk/java/api/io/realm/mongodb/sync/DiscardUnsyncedChangesStrategy.txt b/source/sdk/java/api/io/realm/mongodb/sync/DiscardUnsyncedChangesStrategy.txt new file mode 100644 index 0000000000..3d90fb96d5 --- /dev/null +++ b/source/sdk/java/api/io/realm/mongodb/sync/DiscardUnsyncedChangesStrategy.txt @@ -0,0 +1,380 @@ + +.. contents:: On this page + :local: + :backlinks: none + :depth: 2 + :class: singlecol + + + +Interface DiscardUnsyncedChangesStrategy +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. _io_realm_mongodb_sync_DiscardUnsyncedChangesStrategy: + + + +io.realm.mongodb.sync +===================== + +**Implemented interfaces:** + + + +- :ref:`io.realm.mongodb.sync.SyncClientResetStrategy ` + + +Strategy that automatically resolves a Client Reset by discarding any unsynced data, but otherwise keep the Realm open. Any changes will be reported through the normal collection and object notifications.A synced Realm may need to be reset because the MongoDB Realm Server encountered an error and had to be restored from a backup or because it has been too long since the client connected to the server so the server has rotated the logs. + +The Client Reset thus occurs because the server does not have the full information required to bring the Client fully up to date. + +The discard unsynced changes reset process is as follows: when a client reset is triggered the :ref:`onBeforeReset(Realm) ` callback is invoked, providing an instance of the Realm before the reset and another after the reset, both read-only. Once the reset has concluded the callback :ref:`onAfterReset(Realm, Realm) ` would be invoked with an instance of the final Realm. + + + +In the event that discarding the unsynced data is not enough to resolve the reset the :ref:`onError(SyncSession, ClientResetRequiredError) ` would be invoked, it allows to manually resolve the reset as it would be done in :ref:`ManuallyRecoverUnsyncedChangesStrategy.onClientReset(SyncSession, ClientResetRequiredError) ` . + + + + + + +Method Summary +============== + +.. list-table:: + :header-rows: 1 + + * - Modifier and Type + - Method and Description + + * - public **void** + - | :ref:`onAfterReset ` ( + | :ref:`Realm ` before, + | :ref:`Realm ` after + | ) + + + Callback invoked once the Client Reset happens. + + + + + * - public **void** + - | :ref:`onBeforeReset ` ( + | :ref:`Realm ` realm + | ) + + + Callback that indicates a Client Reset is about to happen. + + + + + * - public **void** + - | :ref:`onError ` ( + | :ref:`SyncSession ` session, + | :ref:`ClientResetRequiredError ` error + | ) + + + Callback that indicates the seamless Client reset couldn't complete. + + + + + + + +Inherited Methods +================= + + + +Method Detail +============= + +.. _onAfterReset: + +.. _onAfterReset__: + +.. _DiscardUnsyncedChangesStrategy_onAfterReset: + +.. _DiscardUnsyncedChangesStrategy_onAfterReset__: + +.. _io_realm_mongodb_sync_DiscardUnsyncedChangesStrategy_onAfterReset: + +.. _io_realm_mongodb_sync_DiscardUnsyncedChangesStrategy_onAfterReset__: + + + +onAfterReset +------------ + +.. _io_realm_mongodb_sync_DiscardUnsyncedChangesStrategy_onAfterReset_io_realm_Realm_io_realm_Realm_: + +.. _io_realm_mongodb_sync_DiscardUnsyncedChangesStrategy_onAfterReset_io_realm_Realm__io_realm_Realm_: + +.. _io_realm_mongodb_sync_DiscardUnsyncedChangesStrategy_onAfterReset_io_realm_Realm_Realm_: + +.. _io_realm_mongodb_sync_DiscardUnsyncedChangesStrategy_onAfterReset_io_realm_Realm__Realm_: + +.. _io_realm_mongodb_sync_DiscardUnsyncedChangesStrategy_onAfterReset_Realm_io_realm_Realm_: + +.. _io_realm_mongodb_sync_DiscardUnsyncedChangesStrategy_onAfterReset_Realm__io_realm_Realm_: + +.. _io_realm_mongodb_sync_DiscardUnsyncedChangesStrategy_onAfterReset_Realm_Realm_: + +.. _io_realm_mongodb_sync_DiscardUnsyncedChangesStrategy_onAfterReset_Realm__Realm_: + +.. _onAfterReset_io_realm_Realm_io_realm_Realm_: + +.. _onAfterReset_io_realm_Realm__io_realm_Realm_: + +.. _onAfterReset_io_realm_Realm_Realm_: + +.. _onAfterReset_io_realm_Realm__Realm_: + +.. _onAfterReset_Realm_io_realm_Realm_: + +.. _onAfterReset_Realm__io_realm_Realm_: + +.. _onAfterReset_Realm_Realm_: + +.. _onAfterReset_Realm__Realm_: + +.. _DiscardUnsyncedChangesStrategy_onAfterReset_io_realm_Realm_io_realm_Realm_: + +.. _DiscardUnsyncedChangesStrategy_onAfterReset_io_realm_Realm__io_realm_Realm_: + +.. _DiscardUnsyncedChangesStrategy_onAfterReset_io_realm_Realm_Realm_: + +.. _DiscardUnsyncedChangesStrategy_onAfterReset_io_realm_Realm__Realm_: + +.. _DiscardUnsyncedChangesStrategy_onAfterReset_Realm_io_realm_Realm_: + +.. _DiscardUnsyncedChangesStrategy_onAfterReset_Realm__io_realm_Realm_: + +.. _DiscardUnsyncedChangesStrategy_onAfterReset_Realm_Realm_: + +.. _DiscardUnsyncedChangesStrategy_onAfterReset_Realm__Realm_: + +.. list-table:: + :header-rows: 1 + + * - | public **void** :ref:`onAfterReset ` ( + | :ref:`Realm ` before, + | :ref:`Realm ` after + | ) + + + + + * - Callback invoked once the Client Reset happens. It provides of two Realm instances, a frozen one displaying the state before the reset and a regular Realm with the current state, that can be used to recover objects from the reset. + + + + + **Parameters** + + - ``before`` - :ref:`Realm ` frozen Realm in the before after the reset. + + + + + + - ``after`` - :ref:`Realm ` Realm after the reset. + + + + + + + + + + + + + + + + + + +.. _onBeforeReset: + +.. _onBeforeReset__: + +.. _DiscardUnsyncedChangesStrategy_onBeforeReset: + +.. _DiscardUnsyncedChangesStrategy_onBeforeReset__: + +.. _io_realm_mongodb_sync_DiscardUnsyncedChangesStrategy_onBeforeReset: + +.. _io_realm_mongodb_sync_DiscardUnsyncedChangesStrategy_onBeforeReset__: + + + +onBeforeReset +------------- + +.. _io_realm_mongodb_sync_DiscardUnsyncedChangesStrategy_onBeforeReset_io_realm_Realm_: + +.. _io_realm_mongodb_sync_DiscardUnsyncedChangesStrategy_onBeforeReset_Realm_: + +.. _onBeforeReset_io_realm_Realm_: + +.. _onBeforeReset_Realm_: + +.. _DiscardUnsyncedChangesStrategy_onBeforeReset_io_realm_Realm_: + +.. _DiscardUnsyncedChangesStrategy_onBeforeReset_Realm_: + +.. list-table:: + :header-rows: 1 + + * - | public **void** :ref:`onBeforeReset ` ( + | :ref:`Realm ` realm + | ) + + + + + * - Callback that indicates a Client Reset is about to happen. It provides with a frozen instance of the Realm that is will be reset. + + + + + **Parameters** + + - ``realm`` - frozen :ref:`Realm ` in its state before the reset. + + + + + + + + + + + + + + + + + + +.. _onError: + +.. _onError__: + +.. _DiscardUnsyncedChangesStrategy_onError: + +.. _DiscardUnsyncedChangesStrategy_onError__: + +.. _io_realm_mongodb_sync_DiscardUnsyncedChangesStrategy_onError: + +.. _io_realm_mongodb_sync_DiscardUnsyncedChangesStrategy_onError__: + + + +onError +------- + +.. _io_realm_mongodb_sync_DiscardUnsyncedChangesStrategy_onError_io_realm_mongodb_sync_SyncSession_io_realm_mongodb_sync_ClientResetRequiredError_: + +.. _io_realm_mongodb_sync_DiscardUnsyncedChangesStrategy_onError_io_realm_mongodb_sync_SyncSession__io_realm_mongodb_sync_ClientResetRequiredError_: + +.. _io_realm_mongodb_sync_DiscardUnsyncedChangesStrategy_onError_io_realm_mongodb_sync_SyncSession_ClientResetRequiredError_: + +.. _io_realm_mongodb_sync_DiscardUnsyncedChangesStrategy_onError_io_realm_mongodb_sync_SyncSession__ClientResetRequiredError_: + +.. _io_realm_mongodb_sync_DiscardUnsyncedChangesStrategy_onError_SyncSession_io_realm_mongodb_sync_ClientResetRequiredError_: + +.. _io_realm_mongodb_sync_DiscardUnsyncedChangesStrategy_onError_SyncSession__io_realm_mongodb_sync_ClientResetRequiredError_: + +.. _io_realm_mongodb_sync_DiscardUnsyncedChangesStrategy_onError_SyncSession_ClientResetRequiredError_: + +.. _io_realm_mongodb_sync_DiscardUnsyncedChangesStrategy_onError_SyncSession__ClientResetRequiredError_: + +.. _onError_io_realm_mongodb_sync_SyncSession_io_realm_mongodb_sync_ClientResetRequiredError_: + +.. _onError_io_realm_mongodb_sync_SyncSession__io_realm_mongodb_sync_ClientResetRequiredError_: + +.. _onError_io_realm_mongodb_sync_SyncSession_ClientResetRequiredError_: + +.. _onError_io_realm_mongodb_sync_SyncSession__ClientResetRequiredError_: + +.. _onError_SyncSession_io_realm_mongodb_sync_ClientResetRequiredError_: + +.. _onError_SyncSession__io_realm_mongodb_sync_ClientResetRequiredError_: + +.. _onError_SyncSession_ClientResetRequiredError_: + +.. _onError_SyncSession__ClientResetRequiredError_: + +.. _DiscardUnsyncedChangesStrategy_onError_io_realm_mongodb_sync_SyncSession_io_realm_mongodb_sync_ClientResetRequiredError_: + +.. _DiscardUnsyncedChangesStrategy_onError_io_realm_mongodb_sync_SyncSession__io_realm_mongodb_sync_ClientResetRequiredError_: + +.. _DiscardUnsyncedChangesStrategy_onError_io_realm_mongodb_sync_SyncSession_ClientResetRequiredError_: + +.. _DiscardUnsyncedChangesStrategy_onError_io_realm_mongodb_sync_SyncSession__ClientResetRequiredError_: + +.. _DiscardUnsyncedChangesStrategy_onError_SyncSession_io_realm_mongodb_sync_ClientResetRequiredError_: + +.. _DiscardUnsyncedChangesStrategy_onError_SyncSession__io_realm_mongodb_sync_ClientResetRequiredError_: + +.. _DiscardUnsyncedChangesStrategy_onError_SyncSession_ClientResetRequiredError_: + +.. _DiscardUnsyncedChangesStrategy_onError_SyncSession__ClientResetRequiredError_: + +.. list-table:: + :header-rows: 1 + + * - | public **void** :ref:`onError ` ( + | :ref:`SyncSession ` session, + | :ref:`ClientResetRequiredError ` error + | ) + + + + + * - Callback that indicates the seamless Client reset couldn't complete. It should be handled as :ref:`ManuallyRecoverUnsyncedChangesStrategy.onClientReset(SyncSession, ClientResetRequiredError) ` . + + + + + + + **Parameters** + + - ``session`` - :ref:`SyncSession ` this error happened on. + + + + + + - ``error`` - :ref:`ClientResetRequiredError ` the specific Client Reset error. + + + + + + + + + + + + + + + + + + + diff --git a/source/sdk/java/api/io/realm/mongodb/sync/ManuallyRecoverUnsyncedChangesStrategy.txt b/source/sdk/java/api/io/realm/mongodb/sync/ManuallyRecoverUnsyncedChangesStrategy.txt new file mode 100644 index 0000000000..b3d007ca50 --- /dev/null +++ b/source/sdk/java/api/io/realm/mongodb/sync/ManuallyRecoverUnsyncedChangesStrategy.txt @@ -0,0 +1,194 @@ + +.. contents:: On this page + :local: + :backlinks: none + :depth: 2 + :class: singlecol + + + +Interface ManuallyRecoverUnsyncedChangesStrategy +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. _io_realm_mongodb_sync_ManuallyRecoverUnsyncedChangesStrategy: + + + +io.realm.mongodb.sync +===================== + +**Implemented interfaces:** + + + +- :ref:`io.realm.mongodb.sync.SyncClientResetStrategy ` + + +Strategy to manually resolve a Client Reset, determined by the error code :ref:`ErrorCode.CLIENT_RESET ` . + +A synced Realm may need to be reset because the MongoDB Realm Server encountered an error and had to be restored from a backup or because it has been too long since the client connected to the server so the server has rotated the logs. + +The Client Reset thus occurs because the server does not have the full information required to bring the Client fully up to date. + +The manual reset process is as follows: the local copy of the Realm is copied into a recovery directory for safekeeping, and then deleted from the original location. The next time the Realm for that URL is opened, the Realm will automatically be re-downloaded from MongoDB Realm, and can be used as normal. + +Data written to the Realm after the local copy of the Realm diverged from the backup remote copy will be present in the local recovery copy of the Realm file. The re-downloaded Realm will initially contain only the data present at the time the Realm was backed up on the server. + +The client reset process can be initiated in one of two ways: + + + +1. Run :ref:`ClientResetRequiredError.executeClientReset() ` manually. All Realm instances must be closed before this method is called. + + + + +#. If Client Reset isn't executed manually, it will automatically be carried out the next time all Realm instances have been closed and re-opened. This will most likely be when the app is restarted. + + + + +**WARNING:** Any writes to the Realm file between this callback and Client Reset has been executed, will not be synchronized to MongoDB Realm. Those changes will only be present in the backed up file. It is therefore recommended to close all open Realm instances as soon as possible. + + +Method Summary +============== + +.. list-table:: + :header-rows: 1 + + * - Modifier and Type + - Method and Description + + * - public **void** + - | :ref:`onClientReset ` ( + | :ref:`SyncSession ` session, + | :ref:`ClientResetRequiredError ` error + | ) + + + Callback that indicates a Client Reset has happened. + + + + + + + +Inherited Methods +================= + + + +Method Detail +============= + +.. _onClientReset: + +.. _onClientReset__: + +.. _ManuallyRecoverUnsyncedChangesStrategy_onClientReset: + +.. _ManuallyRecoverUnsyncedChangesStrategy_onClientReset__: + +.. _io_realm_mongodb_sync_ManuallyRecoverUnsyncedChangesStrategy_onClientReset: + +.. _io_realm_mongodb_sync_ManuallyRecoverUnsyncedChangesStrategy_onClientReset__: + + + +onClientReset +------------- + +.. _io_realm_mongodb_sync_ManuallyRecoverUnsyncedChangesStrategy_onClientReset_io_realm_mongodb_sync_SyncSession_io_realm_mongodb_sync_ClientResetRequiredError_: + +.. _io_realm_mongodb_sync_ManuallyRecoverUnsyncedChangesStrategy_onClientReset_io_realm_mongodb_sync_SyncSession__io_realm_mongodb_sync_ClientResetRequiredError_: + +.. _io_realm_mongodb_sync_ManuallyRecoverUnsyncedChangesStrategy_onClientReset_io_realm_mongodb_sync_SyncSession_ClientResetRequiredError_: + +.. _io_realm_mongodb_sync_ManuallyRecoverUnsyncedChangesStrategy_onClientReset_io_realm_mongodb_sync_SyncSession__ClientResetRequiredError_: + +.. _io_realm_mongodb_sync_ManuallyRecoverUnsyncedChangesStrategy_onClientReset_SyncSession_io_realm_mongodb_sync_ClientResetRequiredError_: + +.. _io_realm_mongodb_sync_ManuallyRecoverUnsyncedChangesStrategy_onClientReset_SyncSession__io_realm_mongodb_sync_ClientResetRequiredError_: + +.. _io_realm_mongodb_sync_ManuallyRecoverUnsyncedChangesStrategy_onClientReset_SyncSession_ClientResetRequiredError_: + +.. _io_realm_mongodb_sync_ManuallyRecoverUnsyncedChangesStrategy_onClientReset_SyncSession__ClientResetRequiredError_: + +.. _onClientReset_io_realm_mongodb_sync_SyncSession_io_realm_mongodb_sync_ClientResetRequiredError_: + +.. _onClientReset_io_realm_mongodb_sync_SyncSession__io_realm_mongodb_sync_ClientResetRequiredError_: + +.. _onClientReset_io_realm_mongodb_sync_SyncSession_ClientResetRequiredError_: + +.. _onClientReset_io_realm_mongodb_sync_SyncSession__ClientResetRequiredError_: + +.. _onClientReset_SyncSession_io_realm_mongodb_sync_ClientResetRequiredError_: + +.. _onClientReset_SyncSession__io_realm_mongodb_sync_ClientResetRequiredError_: + +.. _onClientReset_SyncSession_ClientResetRequiredError_: + +.. _onClientReset_SyncSession__ClientResetRequiredError_: + +.. _ManuallyRecoverUnsyncedChangesStrategy_onClientReset_io_realm_mongodb_sync_SyncSession_io_realm_mongodb_sync_ClientResetRequiredError_: + +.. _ManuallyRecoverUnsyncedChangesStrategy_onClientReset_io_realm_mongodb_sync_SyncSession__io_realm_mongodb_sync_ClientResetRequiredError_: + +.. _ManuallyRecoverUnsyncedChangesStrategy_onClientReset_io_realm_mongodb_sync_SyncSession_ClientResetRequiredError_: + +.. _ManuallyRecoverUnsyncedChangesStrategy_onClientReset_io_realm_mongodb_sync_SyncSession__ClientResetRequiredError_: + +.. _ManuallyRecoverUnsyncedChangesStrategy_onClientReset_SyncSession_io_realm_mongodb_sync_ClientResetRequiredError_: + +.. _ManuallyRecoverUnsyncedChangesStrategy_onClientReset_SyncSession__io_realm_mongodb_sync_ClientResetRequiredError_: + +.. _ManuallyRecoverUnsyncedChangesStrategy_onClientReset_SyncSession_ClientResetRequiredError_: + +.. _ManuallyRecoverUnsyncedChangesStrategy_onClientReset_SyncSession__ClientResetRequiredError_: + +.. list-table:: + :header-rows: 1 + + * - | public **void** :ref:`onClientReset ` ( + | :ref:`SyncSession ` session, + | :ref:`ClientResetRequiredError ` error + | ) + + + + + * - Callback that indicates a Client Reset has happened. This should be handled as quickly as possible as any further changes to the Realm will not be synchronized with the server and must be moved manually from the backup Realm to the new one. + + + + + **Parameters** + + - ``session`` - :ref:`SyncSession ` this error happened on. + + + + + + - ``error`` - :ref:`ClientResetRequiredError ` the specific Client Reset error. + + + + + + + + + + + + + + + + + + + diff --git a/source/sdk/java/api/io/realm/mongodb/sync/MutableSubscriptionSet.txt b/source/sdk/java/api/io/realm/mongodb/sync/MutableSubscriptionSet.txt new file mode 100644 index 0000000000..f2fae54572 --- /dev/null +++ b/source/sdk/java/api/io/realm/mongodb/sync/MutableSubscriptionSet.txt @@ -0,0 +1,577 @@ + +.. contents:: On this page + :local: + :backlinks: none + :depth: 2 + :class: singlecol + + + +Interface MutableSubscriptionSet +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. _io_realm_mongodb_sync_MutableSubscriptionSet: + + + +io.realm.mongodb.sync +===================== + +**Implemented interfaces:** + + + +- :ref:`io.realm.mongodb.sync.SubscriptionSet ` +- `java.lang.Iterable `__ + + +A mutable subscription set is available when calling :ref:`SubscriptionSet.update(UpdateCallback) ` This is the only way to modify a :ref:`SubscriptionSet ` . :ref:`Subscription ` s can be either + +*managed* or *unmanaged*. Unmanaged subscriptions are those created by using :ref:`Subscription.create(RealmQuery) ` or :ref:`Subscription.create(String, RealmQuery) ` , while managed subscriptions are the ones being returned from the subscription set. + + + + +.. seealso:: + + + + - :ref:`SubscriptionSet for more information about subscription sets and flexible sync. ` + + + + + + + + + +Method Summary +============== + +.. list-table:: + :header-rows: 1 + + * - Modifier and Type + - Method and Description + + * - public :ref:`Subscription ` + - | :ref:`add ` ( + | :ref:`Subscription ` subscription + | ) + + + Adds a new unmanaged subscription to the subscription set. + + + + + * - public :ref:`Subscription ` + - | :ref:`addOrUpdate ` ( + | :ref:`Subscription ` subscription + | ) + + + Add a new subscription or update an existing named subscription. + + + + + * - public **boolean** + - | :ref:`remove ` ( + | `String `__ name + | ) + + + Remove a named subscription. + + + + + * - public **boolean** + - | :ref:`remove ` ( + | :ref:`Subscription ` subscription + | ) + + + Remove a managed subscription. + + + + + * - public **boolean** + - | :ref:`removeAll ` () + | + + + Remove all current managed subscriptions. + + + + + * - public **boolean** + - | :ref:`removeAll ` <**T** >( + | `java.lang.Class\ `__ clazz + | ) + + + Remove all subscriptions with queries on a given given model class. + + + + + * - public **boolean** + - | :ref:`removeAll ` ( + | `String `__ objectType + | ) + + + Remove all subscriptions on a given :ref:`Subscription.getObjectType() ` . + + + + + + + + + +Inherited Methods +================= + + + +Method Detail +============= + +.. _add: + +.. _add__: + +.. _MutableSubscriptionSet_add: + +.. _MutableSubscriptionSet_add__: + +.. _io_realm_mongodb_sync_MutableSubscriptionSet_add: + +.. _io_realm_mongodb_sync_MutableSubscriptionSet_add__: + + + +add +---- + +.. _io_realm_mongodb_sync_MutableSubscriptionSet_add_io_realm_mongodb_sync_Subscription_: + +.. _io_realm_mongodb_sync_MutableSubscriptionSet_add_Subscription_: + +.. _add_io_realm_mongodb_sync_Subscription_: + +.. _add_Subscription_: + +.. _MutableSubscriptionSet_add_io_realm_mongodb_sync_Subscription_: + +.. _MutableSubscriptionSet_add_Subscription_: + +.. list-table:: + :header-rows: 1 + + * - | public :ref:`Subscription ` :ref:`add ` ( + | :ref:`Subscription ` subscription + | ) + + + + + * - Adds a new unmanaged subscription to the subscription set. + + + + + **Parameters** + + - ``subscription`` - unmanaged subscription to add. + + + + + + + + **Returns** + + the newly added managed subscription. + + + + + **Throws** + + - `IllegalArgumentException `__ - if a subscription matching the provided one already exists. + + + + + + + + + + + + +.. _addOrUpdate: + +.. _addOrUpdate__: + +.. _MutableSubscriptionSet_addOrUpdate: + +.. _MutableSubscriptionSet_addOrUpdate__: + +.. _io_realm_mongodb_sync_MutableSubscriptionSet_addOrUpdate: + +.. _io_realm_mongodb_sync_MutableSubscriptionSet_addOrUpdate__: + + + +addOrUpdate +----------- + +.. _io_realm_mongodb_sync_MutableSubscriptionSet_addOrUpdate_io_realm_mongodb_sync_Subscription_: + +.. _io_realm_mongodb_sync_MutableSubscriptionSet_addOrUpdate_Subscription_: + +.. _addOrUpdate_io_realm_mongodb_sync_Subscription_: + +.. _addOrUpdate_Subscription_: + +.. _MutableSubscriptionSet_addOrUpdate_io_realm_mongodb_sync_Subscription_: + +.. _MutableSubscriptionSet_addOrUpdate_Subscription_: + +.. list-table:: + :header-rows: 1 + + * - | public :ref:`Subscription ` :ref:`addOrUpdate ` ( + | :ref:`Subscription ` subscription + | ) + + + + + * - Add a new subscription or update an existing named subscription. It isn't possible to update an anonymous subscription. These must removed and re-inserted. + + + + + **Parameters** + + - ``subscription`` - anonymous or named subscription created via ``Subscription.create(...)`` , used to update a matching one within a specific set. It creates a new one in case there is no match.. + + + + + + + + + + **Returns** + + the updated or inserted managed subscription. + + + + + + + + + + + +.. _remove: + +.. _remove__: + +.. _MutableSubscriptionSet_remove: + +.. _MutableSubscriptionSet_remove__: + +.. _io_realm_mongodb_sync_MutableSubscriptionSet_remove: + +.. _io_realm_mongodb_sync_MutableSubscriptionSet_remove__: + + + +remove +------ + +.. _io_realm_mongodb_sync_MutableSubscriptionSet_remove_java_lang_String_: + +.. _io_realm_mongodb_sync_MutableSubscriptionSet_remove_String_: + +.. _remove_java_lang_String_: + +.. _remove_String_: + +.. _MutableSubscriptionSet_remove_java_lang_String_: + +.. _MutableSubscriptionSet_remove_String_: + +.. list-table:: + :header-rows: 1 + + * - | public **boolean** :ref:`remove ` ( + | `String `__ name + | ) + + + + + * - Remove a named subscription. + + + + + **Parameters** + + - ``name`` - name of managed subscription to remove. + + + + + + + + **Returns** + + ``true`` if the subscription was removed, ``false`` if not. + + + + + + + + + + + +.. _io_realm_mongodb_sync_MutableSubscriptionSet_remove_io_realm_mongodb_sync_Subscription_: + +.. _io_realm_mongodb_sync_MutableSubscriptionSet_remove_Subscription_: + +.. _remove_io_realm_mongodb_sync_Subscription_: + +.. _remove_Subscription_: + +.. _MutableSubscriptionSet_remove_io_realm_mongodb_sync_Subscription_: + +.. _MutableSubscriptionSet_remove_Subscription_: + +.. list-table:: + :header-rows: 1 + + * - | public **boolean** :ref:`remove ` ( + | :ref:`Subscription ` subscription + | ) + + + + + * - Remove a managed subscription. + + + + + **Parameters** + + - ``subscription`` - managed subscription to remove + + + + + + + + **Returns** + + ``true`` if the subscription was removed, ``false`` if not. + + + + + + + **Throws** + + - `IllegalArgumentException `__ - if the subscription provided is unmanaged. Only managed subscriptions can be used as input. + + + + + + + + + + + + +.. _removeAll: + +.. _removeAll__: + +.. _MutableSubscriptionSet_removeAll: + +.. _MutableSubscriptionSet_removeAll__: + +.. _io_realm_mongodb_sync_MutableSubscriptionSet_removeAll: + +.. _io_realm_mongodb_sync_MutableSubscriptionSet_removeAll__: + + + +removeAll +--------- + +.. list-table:: + :header-rows: 1 + + * - | public **boolean** :ref:`removeAll ` () + | + + + + + * - Remove all current managed subscriptions. + + + + + + + **Returns** + + ``true`` if 1 or more subscriptions were removed, ``false`` if no subscriptions were removed. + + + + + + + + + + + +.. _io_realm_mongodb_sync_MutableSubscriptionSet_removeAll_java_lang_Class_: + +.. _io_realm_mongodb_sync_MutableSubscriptionSet_removeAll_Class_: + +.. _removeAll_java_lang_Class_: + +.. _removeAll_Class_: + +.. _MutableSubscriptionSet_removeAll_java_lang_Class_: + +.. _MutableSubscriptionSet_removeAll_Class_: + +.. _io_realm_mongodb_sync_MutableSubscriptionSet_removeAll_Class_T__: + +.. list-table:: + :header-rows: 1 + + * - | public **boolean** :ref:`removeAll ` <**T** >( + | `java.lang.Class\ `__ clazz + | ) + + + + + * - Remove all subscriptions with queries on a given given model class. + + + + + **Parameters** + + - ``clazz`` - subscriptions on this type will be removed. + + + + + + + + **Returns** + + ``true`` if 1 or more subscriptions were removed, ``false`` if no subscriptions were removed. + + + + + + + + + + + +.. _io_realm_mongodb_sync_MutableSubscriptionSet_removeAll_java_lang_String_: + +.. _io_realm_mongodb_sync_MutableSubscriptionSet_removeAll_String_: + +.. _removeAll_java_lang_String_: + +.. _removeAll_String_: + +.. _MutableSubscriptionSet_removeAll_java_lang_String_: + +.. _MutableSubscriptionSet_removeAll_String_: + +.. list-table:: + :header-rows: 1 + + * - | public **boolean** :ref:`removeAll ` ( + | `String `__ objectType + | ) + + + + + * - Remove all subscriptions on a given :ref:`Subscription.getObjectType() ` . + + + + + + + **Parameters** + + - ``objectType`` - subscriptions on this object type will be removed. + + + + + + + + **Returns** + + ``true`` if 1 or more subscriptions were removed, ``false`` if no subscriptions were removed. + + + + + + + + + + + + + + diff --git a/source/sdk/java/api/io/realm/mongodb/sync/Progress.txt b/source/sdk/java/api/io/realm/mongodb/sync/Progress.txt index d818d634b8..bb16bf5f3e 100644 --- a/source/sdk/java/api/io/realm/mongodb/sync/Progress.txt +++ b/source/sdk/java/api/io/realm/mongodb/sync/Progress.txt @@ -18,7 +18,7 @@ io.realm.mongodb.sync ===================== - | `java.lang.Object `__ + | `java.lang.Object `__ | io.realm.mongodb.sync.Progress @@ -62,7 +62,7 @@ Method Summary * - public **boolean** - | :ref:`equals ` ( - | `Object `__ o + | `Object `__ o | ) @@ -125,7 +125,7 @@ Method Summary - * - public `String `__ + * - public `String `__ - | :ref:`toString ` () | @@ -143,7 +143,7 @@ Inherited Methods -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` +- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` @@ -184,7 +184,7 @@ equals :header-rows: 1 * - | public **boolean** :ref:`equals ` ( - | `Object `__ o + | `Object `__ o | ) @@ -203,7 +203,7 @@ equals **Overrides** - ``equals`` in class `Object `__ + ``equals`` in class `Object `__ @@ -406,7 +406,7 @@ hashCode **Overrides** - ``hashCode`` in class `Object `__ + ``hashCode`` in class `Object `__ @@ -492,7 +492,7 @@ toString .. list-table:: :header-rows: 1 - * - | public `String `__ :ref:`toString ` () + * - | public `String `__ :ref:`toString ` () | @@ -511,7 +511,7 @@ toString **Overrides** - ``toString`` in class `Object `__ + ``toString`` in class `Object `__ diff --git a/source/sdk/java/api/io/realm/mongodb/sync/ProgressMode.txt b/source/sdk/java/api/io/realm/mongodb/sync/ProgressMode.txt index c9914b1345..71a5c9ef99 100644 --- a/source/sdk/java/api/io/realm/mongodb/sync/ProgressMode.txt +++ b/source/sdk/java/api/io/realm/mongodb/sync/ProgressMode.txt @@ -18,8 +18,8 @@ io.realm.mongodb.sync ===================== - | `java.lang.Object `__ - | `java.lang.Enum `__ + | `java.lang.Object `__ + | `java.lang.Enum `__ | io.realm.mongodb.sync.ProgressMode @@ -66,7 +66,7 @@ Method Summary * - public static :ref:`ProgressMode ` - | :ref:`valueOf ` ( - | `String `__ name + | `String `__ name | ) @@ -93,8 +93,8 @@ Inherited Methods -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` -- Methods inherited from class `java.lang.Enum `__ : ``name`` , ``ordinal`` , ``toString`` , ``equals`` , ``hashCode`` , ``clone`` , ``compareTo`` , ``getDeclaringClass`` , ``valueOf`` , ``finalize`` +- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` +- Methods inherited from class `java.lang.Enum `__ : ``name`` , ``ordinal`` , ``toString`` , ``equals`` , ``hashCode`` , ``clone`` , ``compareTo`` , ``getDeclaringClass`` , ``valueOf`` , ``finalize`` @@ -184,7 +184,7 @@ valueOf :header-rows: 1 * - | public static :ref:`ProgressMode ` :ref:`valueOf ` ( - | `String `__ name + | `String `__ name | ) diff --git a/source/sdk/java/api/io/realm/mongodb/sync/Subscription.txt b/source/sdk/java/api/io/realm/mongodb/sync/Subscription.txt new file mode 100644 index 0000000000..ceeefa0e4d --- /dev/null +++ b/source/sdk/java/api/io/realm/mongodb/sync/Subscription.txt @@ -0,0 +1,526 @@ + +.. contents:: On this page + :local: + :backlinks: none + :depth: 2 + :class: singlecol + + + +Interface Subscription +^^^^^^^^^^^^^^^^^^^^^^ + +.. _io_realm_mongodb_sync_Subscription: + + + +io.realm.mongodb.sync +===================== + +A subscription defines a specific server query and its metadata. The result of this query is continuously being synchronized with the device as long as the subscription is part of a :ref:`SubscriptionSet ` with a state of :ref:`SubscriptionSet.State.COMPLETE ` . Subscriptions are immutable once created, but they can be updated by using a :ref:`MutableSubscriptionSet.addOrUpdate(Subscription) ` . + + + + +Method Summary +============== + +.. list-table:: + :header-rows: 1 + + * - Modifier and Type + - Method and Description + + * - public static :ref:`Subscription ` + - | :ref:`create ` ( + | :ref:`io.realm.RealmQuery ` query + | ) + + + Create an unmanaged anonymous subscription for a flexible sync enabled Realm. + + + + + * - public static :ref:`Subscription ` + - | :ref:`create ` ( + | `String `__ name, + | :ref:`io.realm.RealmQuery ` query + | ) + + + Create an unmanaged named subscription for a flexible sync enabled Realm. + + + + + * - public `Date `__ + - | :ref:`getCreatedAt ` () + | + + + Returns the timestamp for when this subscription was persisted. + + + + + * - public `String `__ + - | :ref:`getName ` () + | + + + Returns the name of subscription or ``null`` if no name was defined. + + + + + + + * - public `String `__ + - | :ref:`getObjectType ` () + | + + + Returns the type that is being queried. + + + + + * - public `String `__ + - | :ref:`getQuery ` () + | + + + Returns the subscription query that is running on objects of type :ref:`getObjectType() ` . + + + + + + + * - public `Date `__ + - | :ref:`getUpdatedAt ` () + | + + + Returns the timestamp for when a persisted subscription was updated. + + + + + + + +Method Detail +============= + +.. _create: + +.. _create__: + +.. _Subscription_create: + +.. _Subscription_create__: + +.. _io_realm_mongodb_sync_Subscription_create: + +.. _io_realm_mongodb_sync_Subscription_create__: + + + +create +------ + +.. _io_realm_mongodb_sync_Subscription_create_io_realm_RealmQuery_: + +.. _io_realm_mongodb_sync_Subscription_create_RealmQuery_: + +.. _create_io_realm_RealmQuery_: + +.. _create_RealmQuery_: + +.. _Subscription_create_io_realm_RealmQuery_: + +.. _Subscription_create_RealmQuery_: + +.. list-table:: + :header-rows: 1 + + * - | public static :ref:`Subscription ` :ref:`create ` ( + | :ref:`io.realm.RealmQuery ` query + | ) + + + + + * - Create an unmanaged anonymous subscription for a flexible sync enabled Realm. The subscription will not take effect until it has been stored using either :ref:`MutableSubscriptionSet.add(Subscription) ` or :ref:`MutableSubscriptionSet.addOrUpdate(Subscription) ` . + + + + + + + **Parameters** + + - ``query`` - the query that is subscribed to. Note, subscription queries have restrictions compared to normal queries. + + + + + + + + **Returns** + + the unmanaged subscription. + + + + + + + + + +.. _io_realm_mongodb_sync_Subscription_create_java_lang_String_io_realm_RealmQuery_: + +.. _io_realm_mongodb_sync_Subscription_create_java_lang_String__io_realm_RealmQuery_: + +.. _io_realm_mongodb_sync_Subscription_create_java_lang_String_RealmQuery_: + +.. _io_realm_mongodb_sync_Subscription_create_java_lang_String__RealmQuery_: + +.. _io_realm_mongodb_sync_Subscription_create_String_io_realm_RealmQuery_: + +.. _io_realm_mongodb_sync_Subscription_create_String__io_realm_RealmQuery_: + +.. _io_realm_mongodb_sync_Subscription_create_String_RealmQuery_: + +.. _io_realm_mongodb_sync_Subscription_create_String__RealmQuery_: + +.. _create_java_lang_String_io_realm_RealmQuery_: + +.. _create_java_lang_String__io_realm_RealmQuery_: + +.. _create_java_lang_String_RealmQuery_: + +.. _create_java_lang_String__RealmQuery_: + +.. _create_String_io_realm_RealmQuery_: + +.. _create_String__io_realm_RealmQuery_: + +.. _create_String_RealmQuery_: + +.. _create_String__RealmQuery_: + +.. _Subscription_create_java_lang_String_io_realm_RealmQuery_: + +.. _Subscription_create_java_lang_String__io_realm_RealmQuery_: + +.. _Subscription_create_java_lang_String_RealmQuery_: + +.. _Subscription_create_java_lang_String__RealmQuery_: + +.. _Subscription_create_String_io_realm_RealmQuery_: + +.. _Subscription_create_String__io_realm_RealmQuery_: + +.. _Subscription_create_String_RealmQuery_: + +.. _Subscription_create_String__RealmQuery_: + +.. list-table:: + :header-rows: 1 + + * - | public static :ref:`Subscription ` :ref:`create ` ( + | `String `__ name, + | :ref:`io.realm.RealmQuery ` query + | ) + + + + + * - Create an unmanaged named subscription for a flexible sync enabled Realm. The subscription will not take effect until it has been stored using either :ref:`MutableSubscriptionSet.add(Subscription) ` or :ref:`MutableSubscriptionSet.addOrUpdate(Subscription) ` . + + + + + + + **Parameters** + + - ``name`` - the name of the subscription + + + + - ``query`` - the query that is subscribed to. Note, subscription queries have restrictions compared to normal queries. + + + + + + + + **Returns** + + the unmanaged subscription. + + + + + + + + + + + +.. _getCreatedAt: + +.. _getCreatedAt__: + +.. _Subscription_getCreatedAt: + +.. _Subscription_getCreatedAt__: + +.. _io_realm_mongodb_sync_Subscription_getCreatedAt: + +.. _io_realm_mongodb_sync_Subscription_getCreatedAt__: + + + +getCreatedAt +------------ + +.. list-table:: + :header-rows: 1 + + * - | public `Date `__ :ref:`getCreatedAt ` () + | + + + + + * - Returns the timestamp for when this subscription was persisted. This will return ``null`` until the Subscription has been added using either :ref:`MutableSubscriptionSet.add(Subscription) ` or :ref:`MutableSubscriptionSet.addOrUpdate(Subscription) ` . + + + + + + + + + **Returns** + + the time this subscription was persisted, or ``null`` if the subscription hasn't been persisted yet. + + + + + + + + + + + + + +.. _getName: + +.. _getName__: + +.. _Subscription_getName: + +.. _Subscription_getName__: + +.. _io_realm_mongodb_sync_Subscription_getName: + +.. _io_realm_mongodb_sync_Subscription_getName__: + + + +getName +------- + +.. list-table:: + :header-rows: 1 + + * - | public `String `__ :ref:`getName ` () + | + + + + + * - Returns the name of subscription or ``null`` if no name was defined. + + + + + + + + + **Returns** + + the name of the subscription. + + + + + + + + + + + +.. _getObjectType: + +.. _getObjectType__: + +.. _Subscription_getObjectType: + +.. _Subscription_getObjectType__: + +.. _io_realm_mongodb_sync_Subscription_getObjectType: + +.. _io_realm_mongodb_sync_Subscription_getObjectType__: + + + +getObjectType +------------- + +.. list-table:: + :header-rows: 1 + + * - | public `String `__ :ref:`getObjectType ` () + | + + + + + * - Returns the type that is being queried. + + + + + + + **Returns** + + the type that is being queried. + + + + + + + + + + + +.. _getQuery: + +.. _getQuery__: + +.. _Subscription_getQuery: + +.. _Subscription_getQuery__: + +.. _io_realm_mongodb_sync_Subscription_getQuery: + +.. _io_realm_mongodb_sync_Subscription_getQuery__: + + + +getQuery +-------- + +.. list-table:: + :header-rows: 1 + + * - | public `String `__ :ref:`getQuery ` () + | + + + + + * - Returns the subscription query that is running on objects of type :ref:`getObjectType() ` . + + + + + + + + + **Returns** + + the query covered by this subscription. + + + + + + + + + + + +.. _getUpdatedAt: + +.. _getUpdatedAt__: + +.. _Subscription_getUpdatedAt: + +.. _Subscription_getUpdatedAt__: + +.. _io_realm_mongodb_sync_Subscription_getUpdatedAt: + +.. _io_realm_mongodb_sync_Subscription_getUpdatedAt__: + + + +getUpdatedAt +------------ + +.. list-table:: + :header-rows: 1 + + * - | public `Date `__ :ref:`getUpdatedAt ` () + | + + + + + * - Returns the timestamp for when a persisted subscription was updated. This will return ``null`` until the Subscription has been added using either :ref:`MutableSubscriptionSet.add(Subscription) ` or :ref:`MutableSubscriptionSet.addOrUpdate(Subscription) ` . + + + + + + + + + **Returns** + + the time this subscription was updated, or ``null`` if the subscription hasn't been persisted yet. + + + + + + + + + + + + + + diff --git a/source/sdk/java/api/io/realm/mongodb/sync/SubscriptionSet.txt b/source/sdk/java/api/io/realm/mongodb/sync/SubscriptionSet.txt new file mode 100644 index 0000000000..eb33655fc5 --- /dev/null +++ b/source/sdk/java/api/io/realm/mongodb/sync/SubscriptionSet.txt @@ -0,0 +1,1070 @@ + +.. contents:: On this page + :local: + :backlinks: none + :depth: 2 + :class: singlecol + + + +Interface SubscriptionSet +^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. _io_realm_mongodb_sync_SubscriptionSet: + + + +io.realm.mongodb.sync +===================== + +**Implemented interfaces:** + + + +- `java.lang.Iterable `__ + + +A subscription set is an immutable view of all current :ref:`Subscription ` s for a given Realm that has been configured for flexible sync. + +Flexible Sync is a way of defining which data gets synchronized to and from the device using :ref:`RealmQuery ` s. The query and its metadata are represented by a :ref:`Subscription ` . + + + +A subscription set thus defines all the data that is available to the device and being synchronized with the server. If the subscription set encounters an error, e.g. by containing an invalid query, the entire subscription set will enter an :ref:`SubscriptionSet.State.ERROR ` state, and no synchronization will happen until the error has been fixed. + + + +If a subscription is removed, so is the corresponding data, but it is only removed from the device. It isn't deleted on the server. + +It is possible to modify a subscription set while offline, but modification isn't accepted by the server before :ref:`getState() ` returns :ref:`SubscriptionSet.State.COMPLETE ` . + + + +It is possible to force the subscription set to be synchronized with the server by using :ref:`waitForSynchronization() ` and its variants. + + + + + + +Nested Class Summary +==================== + +.. list-table:: + :header-rows: 1 + + * - Modifier and Type + - Class and Description + + * - ``public static final`` + - :ref:`SubscriptionSet.State ` + + + * - ``public static interface`` + - :ref:`SubscriptionSet.UpdateCallback ` + + + * - ``public static interface`` + - :ref:`SubscriptionSet.UpdateAsyncCallback ` + + + * - ``public static interface`` + - :ref:`SubscriptionSet.StateChangeCallback ` + + + + + +Method Summary +============== + +.. list-table:: + :header-rows: 1 + + * - Modifier and Type + - Method and Description + + * - public :ref:`Subscription ` + - | :ref:`find ` ( + | `String `__ name + | ) + + + Find the subscription with a given name. + + + + + * - public :ref:`Subscription ` + - | :ref:`find ` ( + | :ref:`io.realm.RealmQuery ` query + | ) + + + Find the first subscription that contains the given query. + + + + + * - public `String `__ + - | :ref:`getErrorMessage ` () + | + + + If :ref:`getState() ` returns :ref:`State.ERROR ` , this method will return the reason. + + + + + + + * - public :ref:`SubscriptionSet.State ` + - | :ref:`getState ` () + | + + + Returns the current state of the SubscriptionSet. + + + + + * - public **int** + - | :ref:`size ` () + | + + + Returns how many subscriptions are currently in this subscription set. + + + + + * - public :ref:`SubscriptionSet ` + - | :ref:`update ` ( + | :ref:`SubscriptionSet.UpdateCallback ` action + | ) + + + Modify the subscription set. + + + + + * - public :ref:`RealmAsyncTask ` + - | :ref:`updateAsync ` ( + | :ref:`SubscriptionSet.UpdateAsyncCallback ` callback + | ) + + + Asynchronously modify the subscription set. + + + + + * - public **boolean** + - | :ref:`waitForSynchronization ` ( + | `Long `__ timeOut, + | `TimeUnit `__ unit + | ) + + + Wait for the subscription set to synchronize with the server. + + + + + * - public **boolean** + - | :ref:`waitForSynchronization ` () + | + + + Wait for the subscription set to synchronize with the server. + + + + + * - public :ref:`RealmAsyncTask ` + - | :ref:`waitForSynchronizationAsync ` ( + | `Long `__ timeOut, + | `TimeUnit `__ unit, + | :ref:`SubscriptionSet.StateChangeCallback ` callback + | ) + + + Asynchronously wait for the subscription set to synchronize with the server. + + + + + * - public :ref:`RealmAsyncTask ` + - | :ref:`waitForSynchronizationAsync ` ( + | :ref:`SubscriptionSet.StateChangeCallback ` callback + | ) + + + Asynchronously wait for the subscription set to synchronize with the server. + + + + + + + +Inherited Methods +================= + + + +Method Detail +============= + +.. _find: + +.. _find__: + +.. _SubscriptionSet_find: + +.. _SubscriptionSet_find__: + +.. _io_realm_mongodb_sync_SubscriptionSet_find: + +.. _io_realm_mongodb_sync_SubscriptionSet_find__: + + + +find +---- + +.. _io_realm_mongodb_sync_SubscriptionSet_find_java_lang_String_: + +.. _io_realm_mongodb_sync_SubscriptionSet_find_String_: + +.. _find_java_lang_String_: + +.. _find_String_: + +.. _SubscriptionSet_find_java_lang_String_: + +.. _SubscriptionSet_find_String_: + +.. list-table:: + :header-rows: 1 + + * - | public :ref:`Subscription ` :ref:`find ` ( + | `String `__ name + | ) + + + + + * - Find the subscription with a given name. + + + + + **Parameters** + + - ``name`` - name of subscription to search for. + + + + + + + + **Returns** + + the matching subscription or ``null`` if no subscription with that name was found. + + + + + + + + + + + +.. _io_realm_mongodb_sync_SubscriptionSet_find_io_realm_RealmQuery_: + +.. _io_realm_mongodb_sync_SubscriptionSet_find_RealmQuery_: + +.. _find_io_realm_RealmQuery_: + +.. _find_RealmQuery_: + +.. _SubscriptionSet_find_io_realm_RealmQuery_: + +.. _SubscriptionSet_find_RealmQuery_: + +.. list-table:: + :header-rows: 1 + + * - | public :ref:`Subscription ` :ref:`find ` ( + | :ref:`io.realm.RealmQuery ` query + | ) + + + + + * - Find the first subscription that contains the given query. It is possible for multiple named subscriptions to contain the same query. + + + + + **Parameters** + + - ``query`` - query to search for. + + + + + + + + **Returns** + + the first subscription containing the query or ``null`` if no match was found. + + + + + + + + + + + + + +.. _getErrorMessage: + +.. _getErrorMessage__: + +.. _SubscriptionSet_getErrorMessage: + +.. _SubscriptionSet_getErrorMessage__: + +.. _io_realm_mongodb_sync_SubscriptionSet_getErrorMessage: + +.. _io_realm_mongodb_sync_SubscriptionSet_getErrorMessage__: + + + +getErrorMessage +--------------- + +.. list-table:: + :header-rows: 1 + + * - | public `String `__ :ref:`getErrorMessage ` () + | + + + + + * - If :ref:`getState() ` returns :ref:`State.ERROR ` , this method will return the reason. Errors can be fixed by modifying the subscription accordingly and then calling :ref:`waitForSynchronization() ` . + + + + + + + + + **Returns** + + the underlying error if the subscription set is in the :ref:`State.ERROR ` state. For all other states ``null`` will be returned. + + + + + + + + + + + + + +.. _getState: + +.. _getState__: + +.. _SubscriptionSet_getState: + +.. _SubscriptionSet_getState__: + +.. _io_realm_mongodb_sync_SubscriptionSet_getState: + +.. _io_realm_mongodb_sync_SubscriptionSet_getState__: + + + +getState +-------- + +.. list-table:: + :header-rows: 1 + + * - | public :ref:`SubscriptionSet.State ` :ref:`getState ` () + | + + + + + * - Returns the current state of the SubscriptionSet. See :ref:`SubscriptionSet.State ` for more details about each state. + + + + + + + + + **Returns** + + current state of the SubscriptionSet. + + + + + + + + + + + +.. _size: + +.. _size__: + +.. _SubscriptionSet_size: + +.. _SubscriptionSet_size__: + +.. _io_realm_mongodb_sync_SubscriptionSet_size: + +.. _io_realm_mongodb_sync_SubscriptionSet_size__: + + + +size +---- + +.. list-table:: + :header-rows: 1 + + * - | public **int** :ref:`size ` () + | + + + + + * - Returns how many subscriptions are currently in this subscription set. + + + + + + + **Returns** + + the number of of subscriptions in the subscription set. + + + + + + + + + + + +.. _update: + +.. _update__: + +.. _SubscriptionSet_update: + +.. _SubscriptionSet_update__: + +.. _io_realm_mongodb_sync_SubscriptionSet_update: + +.. _io_realm_mongodb_sync_SubscriptionSet_update__: + + + +update +------ + +.. _io_realm_mongodb_sync_SubscriptionSet_update_io_realm_mongodb_sync_SubscriptionSet_UpdateCallback_: + +.. _io_realm_mongodb_sync_SubscriptionSet_update_UpdateCallback_: + +.. _io_realm_mongodb_sync_SubscriptionSet_update_SubscriptionSet_UpdateCallback_: + +.. _update_io_realm_mongodb_sync_SubscriptionSet_UpdateCallback_: + +.. _update_UpdateCallback_: + +.. _update_SubscriptionSet_UpdateCallback_: + +.. _SubscriptionSet_update_io_realm_mongodb_sync_SubscriptionSet_UpdateCallback_: + +.. _SubscriptionSet_update_UpdateCallback_: + +.. _SubscriptionSet_update_SubscriptionSet_UpdateCallback_: + +.. list-table:: + :header-rows: 1 + + * - | public :ref:`SubscriptionSet ` :ref:`update ` ( + | :ref:`SubscriptionSet.UpdateCallback ` action + | ) + + + + + * - Modify the subscription set. If an exception is thrown during the update, no changes will be applied. If the update succeeds, this subscription set is updated with the modified state. + + + + + **Parameters** + + - ``action`` - the block that modifies the subscription set. It will run on the caller thread. + + + + + + + + **Returns** + + this subscription set, that now has been updated. + + + + + **Throws** + + - `Exception `__ - any exception thrown during the update, will propagate back. + + + + + + + + + + + + +.. _updateAsync: + +.. _updateAsync__: + +.. _SubscriptionSet_updateAsync: + +.. _SubscriptionSet_updateAsync__: + +.. _io_realm_mongodb_sync_SubscriptionSet_updateAsync: + +.. _io_realm_mongodb_sync_SubscriptionSet_updateAsync__: + + + +updateAsync +----------- + +.. _io_realm_mongodb_sync_SubscriptionSet_updateAsync_io_realm_mongodb_sync_SubscriptionSet_UpdateAsyncCallback_: + +.. _io_realm_mongodb_sync_SubscriptionSet_updateAsync_UpdateAsyncCallback_: + +.. _io_realm_mongodb_sync_SubscriptionSet_updateAsync_SubscriptionSet_UpdateAsyncCallback_: + +.. _updateAsync_io_realm_mongodb_sync_SubscriptionSet_UpdateAsyncCallback_: + +.. _updateAsync_UpdateAsyncCallback_: + +.. _updateAsync_SubscriptionSet_UpdateAsyncCallback_: + +.. _SubscriptionSet_updateAsync_io_realm_mongodb_sync_SubscriptionSet_UpdateAsyncCallback_: + +.. _SubscriptionSet_updateAsync_UpdateAsyncCallback_: + +.. _SubscriptionSet_updateAsync_SubscriptionSet_UpdateAsyncCallback_: + +.. list-table:: + :header-rows: 1 + + * - | public :ref:`RealmAsyncTask ` :ref:`updateAsync ` ( + | :ref:`SubscriptionSet.UpdateAsyncCallback ` callback + | ) + + + + + * - Asynchronously modify the subscription set. If an exception is thrown during the update, no changes will be applied. \* + + + + + **Parameters** + + - ``callback`` - callback that controls the asynct ask. Succces or failure will be reported here. + + + + + + + + **Returns** + + task controlling the async execution. + + + + + + + + + + + +.. _waitForSynchronization: + +.. _waitForSynchronization__: + +.. _SubscriptionSet_waitForSynchronization: + +.. _SubscriptionSet_waitForSynchronization__: + +.. _io_realm_mongodb_sync_SubscriptionSet_waitForSynchronization: + +.. _io_realm_mongodb_sync_SubscriptionSet_waitForSynchronization__: + + + +waitForSynchronization +---------------------- + +.. _io_realm_mongodb_sync_SubscriptionSet_waitForSynchronization_java_lang_Long_java_util_concurrent_TimeUnit_: + +.. _io_realm_mongodb_sync_SubscriptionSet_waitForSynchronization_java_lang_Long__java_util_concurrent_TimeUnit_: + +.. _io_realm_mongodb_sync_SubscriptionSet_waitForSynchronization_java_lang_Long_TimeUnit_: + +.. _io_realm_mongodb_sync_SubscriptionSet_waitForSynchronization_java_lang_Long__TimeUnit_: + +.. _io_realm_mongodb_sync_SubscriptionSet_waitForSynchronization_Long_java_util_concurrent_TimeUnit_: + +.. _io_realm_mongodb_sync_SubscriptionSet_waitForSynchronization_Long__java_util_concurrent_TimeUnit_: + +.. _io_realm_mongodb_sync_SubscriptionSet_waitForSynchronization_Long_TimeUnit_: + +.. _io_realm_mongodb_sync_SubscriptionSet_waitForSynchronization_Long__TimeUnit_: + +.. _waitForSynchronization_java_lang_Long_java_util_concurrent_TimeUnit_: + +.. _waitForSynchronization_java_lang_Long__java_util_concurrent_TimeUnit_: + +.. _waitForSynchronization_java_lang_Long_TimeUnit_: + +.. _waitForSynchronization_java_lang_Long__TimeUnit_: + +.. _waitForSynchronization_Long_java_util_concurrent_TimeUnit_: + +.. _waitForSynchronization_Long__java_util_concurrent_TimeUnit_: + +.. _waitForSynchronization_Long_TimeUnit_: + +.. _waitForSynchronization_Long__TimeUnit_: + +.. _SubscriptionSet_waitForSynchronization_java_lang_Long_java_util_concurrent_TimeUnit_: + +.. _SubscriptionSet_waitForSynchronization_java_lang_Long__java_util_concurrent_TimeUnit_: + +.. _SubscriptionSet_waitForSynchronization_java_lang_Long_TimeUnit_: + +.. _SubscriptionSet_waitForSynchronization_java_lang_Long__TimeUnit_: + +.. _SubscriptionSet_waitForSynchronization_Long_java_util_concurrent_TimeUnit_: + +.. _SubscriptionSet_waitForSynchronization_Long__java_util_concurrent_TimeUnit_: + +.. _SubscriptionSet_waitForSynchronization_Long_TimeUnit_: + +.. _SubscriptionSet_waitForSynchronization_Long__TimeUnit_: + +.. list-table:: + :header-rows: 1 + + * - | public **boolean** :ref:`waitForSynchronization ` ( + | `Long `__ timeOut, + | `TimeUnit `__ unit + | ) + + + + + * - Wait for the subscription set to synchronize with the server. It will return when the server either accepts the set of queries and has downloaded data for them, or if an error has occurred. Note, that you will either need to manually call **Realm.refresh()** or wait for change listeners to trigger to see the downloaded data. If an error occurred, the underlying reason can be found through :ref:`getErrorMessage() ` . + + + + + + + **Parameters** + + - ``timeOut`` - how long to wait for the synchronization to either succeed or fail. + + + + - ``unit`` - unit of time used for the timeout. + + + + + + + + **Returns** + + ``true`` if all current subscriptions were accepted by the server and data has been downloaded, or ``false`` if an error occurred. + + + + + + + **Throws** + + - `RuntimeException `__ - if the timeout is exceeded. + + + + + + + + + + +.. list-table:: + :header-rows: 1 + + * - | public **boolean** :ref:`waitForSynchronization ` () + | + + + + + * - Wait for the subscription set to synchronize with the server. It will return when the server either accepts the set of queries and has downloaded data for them, or if an error has occurred. Note, that you will either need to manually call **Realm.refresh()** or wait for change listeners to trigger to see the downloaded data. If an error occurred, the underlying reason can be found through :ref:`getErrorMessage() ` . + + + + + + + + + **Returns** + + ``true`` if all current subscriptions were accepted by the server and data has been downloaded, or ``false`` if an error occurred. + + + + + + + + + + + + + +.. _waitForSynchronizationAsync: + +.. _waitForSynchronizationAsync__: + +.. _SubscriptionSet_waitForSynchronizationAsync: + +.. _SubscriptionSet_waitForSynchronizationAsync__: + +.. _io_realm_mongodb_sync_SubscriptionSet_waitForSynchronizationAsync: + +.. _io_realm_mongodb_sync_SubscriptionSet_waitForSynchronizationAsync__: + + + +waitForSynchronizationAsync +--------------------------- + +.. _io_realm_mongodb_sync_SubscriptionSet_waitForSynchronizationAsync_java_lang_Long_java_util_concurrent_TimeUnit_io_realm_mongodb_sync_SubscriptionSet_StateChangeCallback_: + +.. _io_realm_mongodb_sync_SubscriptionSet_waitForSynchronizationAsync_java_lang_Long__java_util_concurrent_TimeUnit__io_realm_mongodb_sync_SubscriptionSet_StateChangeCallback_: + +.. _io_realm_mongodb_sync_SubscriptionSet_waitForSynchronizationAsync_java_lang_Long_java_util_concurrent_TimeUnit_StateChangeCallback_: + +.. _io_realm_mongodb_sync_SubscriptionSet_waitForSynchronizationAsync_java_lang_Long__java_util_concurrent_TimeUnit__StateChangeCallback_: + +.. _io_realm_mongodb_sync_SubscriptionSet_waitForSynchronizationAsync_java_lang_Long_java_util_concurrent_TimeUnit_SubscriptionSet_StateChangeCallback_: + +.. _io_realm_mongodb_sync_SubscriptionSet_waitForSynchronizationAsync_java_lang_Long__java_util_concurrent_TimeUnit__SubscriptionSet_StateChangeCallback_: + +.. _io_realm_mongodb_sync_SubscriptionSet_waitForSynchronizationAsync_java_lang_Long_TimeUnit_io_realm_mongodb_sync_SubscriptionSet_StateChangeCallback_: + +.. _io_realm_mongodb_sync_SubscriptionSet_waitForSynchronizationAsync_java_lang_Long__TimeUnit__io_realm_mongodb_sync_SubscriptionSet_StateChangeCallback_: + +.. _io_realm_mongodb_sync_SubscriptionSet_waitForSynchronizationAsync_java_lang_Long_TimeUnit_StateChangeCallback_: + +.. _io_realm_mongodb_sync_SubscriptionSet_waitForSynchronizationAsync_java_lang_Long__TimeUnit__StateChangeCallback_: + +.. _io_realm_mongodb_sync_SubscriptionSet_waitForSynchronizationAsync_java_lang_Long_TimeUnit_SubscriptionSet_StateChangeCallback_: + +.. _io_realm_mongodb_sync_SubscriptionSet_waitForSynchronizationAsync_java_lang_Long__TimeUnit__SubscriptionSet_StateChangeCallback_: + +.. _io_realm_mongodb_sync_SubscriptionSet_waitForSynchronizationAsync_Long_java_util_concurrent_TimeUnit_io_realm_mongodb_sync_SubscriptionSet_StateChangeCallback_: + +.. _io_realm_mongodb_sync_SubscriptionSet_waitForSynchronizationAsync_Long__java_util_concurrent_TimeUnit__io_realm_mongodb_sync_SubscriptionSet_StateChangeCallback_: + +.. _io_realm_mongodb_sync_SubscriptionSet_waitForSynchronizationAsync_Long_java_util_concurrent_TimeUnit_StateChangeCallback_: + +.. _io_realm_mongodb_sync_SubscriptionSet_waitForSynchronizationAsync_Long__java_util_concurrent_TimeUnit__StateChangeCallback_: + +.. _io_realm_mongodb_sync_SubscriptionSet_waitForSynchronizationAsync_Long_java_util_concurrent_TimeUnit_SubscriptionSet_StateChangeCallback_: + +.. _io_realm_mongodb_sync_SubscriptionSet_waitForSynchronizationAsync_Long__java_util_concurrent_TimeUnit__SubscriptionSet_StateChangeCallback_: + +.. _io_realm_mongodb_sync_SubscriptionSet_waitForSynchronizationAsync_Long_TimeUnit_io_realm_mongodb_sync_SubscriptionSet_StateChangeCallback_: + +.. _io_realm_mongodb_sync_SubscriptionSet_waitForSynchronizationAsync_Long__TimeUnit__io_realm_mongodb_sync_SubscriptionSet_StateChangeCallback_: + +.. _io_realm_mongodb_sync_SubscriptionSet_waitForSynchronizationAsync_Long_TimeUnit_StateChangeCallback_: + +.. _io_realm_mongodb_sync_SubscriptionSet_waitForSynchronizationAsync_Long__TimeUnit__StateChangeCallback_: + +.. _io_realm_mongodb_sync_SubscriptionSet_waitForSynchronizationAsync_Long_TimeUnit_SubscriptionSet_StateChangeCallback_: + +.. _io_realm_mongodb_sync_SubscriptionSet_waitForSynchronizationAsync_Long__TimeUnit__SubscriptionSet_StateChangeCallback_: + +.. _waitForSynchronizationAsync_java_lang_Long_java_util_concurrent_TimeUnit_io_realm_mongodb_sync_SubscriptionSet_StateChangeCallback_: + +.. _waitForSynchronizationAsync_java_lang_Long__java_util_concurrent_TimeUnit__io_realm_mongodb_sync_SubscriptionSet_StateChangeCallback_: + +.. _waitForSynchronizationAsync_java_lang_Long_java_util_concurrent_TimeUnit_StateChangeCallback_: + +.. _waitForSynchronizationAsync_java_lang_Long__java_util_concurrent_TimeUnit__StateChangeCallback_: + +.. _waitForSynchronizationAsync_java_lang_Long_java_util_concurrent_TimeUnit_SubscriptionSet_StateChangeCallback_: + +.. _waitForSynchronizationAsync_java_lang_Long__java_util_concurrent_TimeUnit__SubscriptionSet_StateChangeCallback_: + +.. _waitForSynchronizationAsync_java_lang_Long_TimeUnit_io_realm_mongodb_sync_SubscriptionSet_StateChangeCallback_: + +.. _waitForSynchronizationAsync_java_lang_Long__TimeUnit__io_realm_mongodb_sync_SubscriptionSet_StateChangeCallback_: + +.. _waitForSynchronizationAsync_java_lang_Long_TimeUnit_StateChangeCallback_: + +.. _waitForSynchronizationAsync_java_lang_Long__TimeUnit__StateChangeCallback_: + +.. _waitForSynchronizationAsync_java_lang_Long_TimeUnit_SubscriptionSet_StateChangeCallback_: + +.. _waitForSynchronizationAsync_java_lang_Long__TimeUnit__SubscriptionSet_StateChangeCallback_: + +.. _waitForSynchronizationAsync_Long_java_util_concurrent_TimeUnit_io_realm_mongodb_sync_SubscriptionSet_StateChangeCallback_: + +.. _waitForSynchronizationAsync_Long__java_util_concurrent_TimeUnit__io_realm_mongodb_sync_SubscriptionSet_StateChangeCallback_: + +.. _waitForSynchronizationAsync_Long_java_util_concurrent_TimeUnit_StateChangeCallback_: + +.. _waitForSynchronizationAsync_Long__java_util_concurrent_TimeUnit__StateChangeCallback_: + +.. _waitForSynchronizationAsync_Long_java_util_concurrent_TimeUnit_SubscriptionSet_StateChangeCallback_: + +.. _waitForSynchronizationAsync_Long__java_util_concurrent_TimeUnit__SubscriptionSet_StateChangeCallback_: + +.. _waitForSynchronizationAsync_Long_TimeUnit_io_realm_mongodb_sync_SubscriptionSet_StateChangeCallback_: + +.. _waitForSynchronizationAsync_Long__TimeUnit__io_realm_mongodb_sync_SubscriptionSet_StateChangeCallback_: + +.. _waitForSynchronizationAsync_Long_TimeUnit_StateChangeCallback_: + +.. _waitForSynchronizationAsync_Long__TimeUnit__StateChangeCallback_: + +.. _waitForSynchronizationAsync_Long_TimeUnit_SubscriptionSet_StateChangeCallback_: + +.. _waitForSynchronizationAsync_Long__TimeUnit__SubscriptionSet_StateChangeCallback_: + +.. _SubscriptionSet_waitForSynchronizationAsync_java_lang_Long_java_util_concurrent_TimeUnit_io_realm_mongodb_sync_SubscriptionSet_StateChangeCallback_: + +.. _SubscriptionSet_waitForSynchronizationAsync_java_lang_Long__java_util_concurrent_TimeUnit__io_realm_mongodb_sync_SubscriptionSet_StateChangeCallback_: + +.. _SubscriptionSet_waitForSynchronizationAsync_java_lang_Long_java_util_concurrent_TimeUnit_StateChangeCallback_: + +.. _SubscriptionSet_waitForSynchronizationAsync_java_lang_Long__java_util_concurrent_TimeUnit__StateChangeCallback_: + +.. _SubscriptionSet_waitForSynchronizationAsync_java_lang_Long_java_util_concurrent_TimeUnit_SubscriptionSet_StateChangeCallback_: + +.. _SubscriptionSet_waitForSynchronizationAsync_java_lang_Long__java_util_concurrent_TimeUnit__SubscriptionSet_StateChangeCallback_: + +.. _SubscriptionSet_waitForSynchronizationAsync_java_lang_Long_TimeUnit_io_realm_mongodb_sync_SubscriptionSet_StateChangeCallback_: + +.. _SubscriptionSet_waitForSynchronizationAsync_java_lang_Long__TimeUnit__io_realm_mongodb_sync_SubscriptionSet_StateChangeCallback_: + +.. _SubscriptionSet_waitForSynchronizationAsync_java_lang_Long_TimeUnit_StateChangeCallback_: + +.. _SubscriptionSet_waitForSynchronizationAsync_java_lang_Long__TimeUnit__StateChangeCallback_: + +.. _SubscriptionSet_waitForSynchronizationAsync_java_lang_Long_TimeUnit_SubscriptionSet_StateChangeCallback_: + +.. _SubscriptionSet_waitForSynchronizationAsync_java_lang_Long__TimeUnit__SubscriptionSet_StateChangeCallback_: + +.. _SubscriptionSet_waitForSynchronizationAsync_Long_java_util_concurrent_TimeUnit_io_realm_mongodb_sync_SubscriptionSet_StateChangeCallback_: + +.. _SubscriptionSet_waitForSynchronizationAsync_Long__java_util_concurrent_TimeUnit__io_realm_mongodb_sync_SubscriptionSet_StateChangeCallback_: + +.. _SubscriptionSet_waitForSynchronizationAsync_Long_java_util_concurrent_TimeUnit_StateChangeCallback_: + +.. _SubscriptionSet_waitForSynchronizationAsync_Long__java_util_concurrent_TimeUnit__StateChangeCallback_: + +.. _SubscriptionSet_waitForSynchronizationAsync_Long_java_util_concurrent_TimeUnit_SubscriptionSet_StateChangeCallback_: + +.. _SubscriptionSet_waitForSynchronizationAsync_Long__java_util_concurrent_TimeUnit__SubscriptionSet_StateChangeCallback_: + +.. _SubscriptionSet_waitForSynchronizationAsync_Long_TimeUnit_io_realm_mongodb_sync_SubscriptionSet_StateChangeCallback_: + +.. _SubscriptionSet_waitForSynchronizationAsync_Long__TimeUnit__io_realm_mongodb_sync_SubscriptionSet_StateChangeCallback_: + +.. _SubscriptionSet_waitForSynchronizationAsync_Long_TimeUnit_StateChangeCallback_: + +.. _SubscriptionSet_waitForSynchronizationAsync_Long__TimeUnit__StateChangeCallback_: + +.. _SubscriptionSet_waitForSynchronizationAsync_Long_TimeUnit_SubscriptionSet_StateChangeCallback_: + +.. _SubscriptionSet_waitForSynchronizationAsync_Long__TimeUnit__SubscriptionSet_StateChangeCallback_: + +.. list-table:: + :header-rows: 1 + + * - | public :ref:`RealmAsyncTask ` :ref:`waitForSynchronizationAsync ` ( + | `Long `__ timeOut, + | `TimeUnit `__ unit, + | :ref:`SubscriptionSet.StateChangeCallback ` callback + | ) + + + + + * - Asynchronously wait for the subscription set to synchronize with the server. The callback is invoked when the server either accepts the set of queries and has downloaded data for them, or if an error has occurred. Note, that you will either need to manually call **Realm.refresh()** or wait for change listeners to trigger to see the downloaded data. If an error occurred, the underlying reason can be found through :ref:`getErrorMessage() ` . + + + + + + + **Parameters** + + - ``timeOut`` - how long to wait for the synchronization to either succeed or fail. + + + + - ``unit`` - unit of time used for the timeout. + + + + - ``callback`` - callback to trigger when the synchronization either succeed or fail. Results will be reported on the UI thread. + + + + + + + + **Returns** + + ``true`` if all current subscriptions were accepted by the server and data has been downloaded, or ``false`` if an error occurred. + + + + + + + + + + + +.. _io_realm_mongodb_sync_SubscriptionSet_waitForSynchronizationAsync_io_realm_mongodb_sync_SubscriptionSet_StateChangeCallback_: + +.. _io_realm_mongodb_sync_SubscriptionSet_waitForSynchronizationAsync_StateChangeCallback_: + +.. _io_realm_mongodb_sync_SubscriptionSet_waitForSynchronizationAsync_SubscriptionSet_StateChangeCallback_: + +.. _waitForSynchronizationAsync_io_realm_mongodb_sync_SubscriptionSet_StateChangeCallback_: + +.. _waitForSynchronizationAsync_StateChangeCallback_: + +.. _waitForSynchronizationAsync_SubscriptionSet_StateChangeCallback_: + +.. _SubscriptionSet_waitForSynchronizationAsync_io_realm_mongodb_sync_SubscriptionSet_StateChangeCallback_: + +.. _SubscriptionSet_waitForSynchronizationAsync_StateChangeCallback_: + +.. _SubscriptionSet_waitForSynchronizationAsync_SubscriptionSet_StateChangeCallback_: + +.. list-table:: + :header-rows: 1 + + * - | public :ref:`RealmAsyncTask ` :ref:`waitForSynchronizationAsync ` ( + | :ref:`SubscriptionSet.StateChangeCallback ` callback + | ) + + + + + * - Asynchronously wait for the subscription set to synchronize with the server. It will invoke the callback when the server either accepts the set of queries and has downloaded data for them, or if an error has occurred. Note, that you will either need to manually call **Realm.refresh()** or wait for change listeners to trigger to see the downloaded data. If an error occurred, the underlying reason can be found through :ref:`getErrorMessage() ` . + + + + + + + **Parameters** + + - ``callback`` - callback to trigger when the synchronization either succeed or fail. Results will be reported on the UI thread. + + + + + + + + **Returns** + + ``true`` if all current subscriptions were accepted by the server and data has been downloaded, or ``false`` if an error occurred. + + + + + + + + + + + + + + diff --git a/source/sdk/java/api/io/realm/mongodb/sync/SubscriptionSet/State.txt b/source/sdk/java/api/io/realm/mongodb/sync/SubscriptionSet/State.txt new file mode 100644 index 0000000000..89ebbf2e3a --- /dev/null +++ b/source/sdk/java/api/io/realm/mongodb/sync/SubscriptionSet/State.txt @@ -0,0 +1,409 @@ + +.. contents:: On this page + :local: + :backlinks: none + :depth: 2 + :class: singlecol + + + +Enum SubscriptionSet.State +^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. _io_realm_mongodb_sync_SubscriptionSet_State: + + + +io.realm.mongodb.sync +===================== + + + | `java.lang.Object `__ + | `java.lang.Enum `__ + | io.realm.mongodb.sync.SubscriptionSet.State + + + + +**Enclosing class:** + +:ref:`SubscriptionSet ` + + + +The possible states a subscription set can be in. + + +Enum Constant Summary +===================== + +.. list-table:: + :header-rows: 1 + + * - Enum Constant and Description + + * - :ref:`BOOTSTRAPPING ` + + A subscription set was accepted by the server and initial data is being sent to the device. + + + + + * - :ref:`COMPLETE ` + + A subscription set is actively synchronizing data between the server and the device. + + + + + * - :ref:`ERROR ` + + An error occurred in the subscription set or one of the subscriptions. + + + + + * - :ref:`PENDING ` + + A subscription set has been modified locally, but is still waiting to be sent to the server. + + + + + * - :ref:`SUPERSEDED ` + + Another subscription set was stored before this one, the changes made to this set are ignorde by the server. + + + + + * - :ref:`UNCOMMITTED ` + + The initial state of subscriptions when opening a new Realm or when entering a **update(UpdateCallback)**. + + + + + + + + + +Method Summary +============== + +.. list-table:: + :header-rows: 1 + + * - Modifier and Type + - Method and Description + + * - public static :ref:`SubscriptionSet.State ` + - | :ref:`fromNativeValue ` ( + | **long** value + | ) + + + + + + + + * - public static :ref:`SubscriptionSet.State ` + - | :ref:`valueOf ` ( + | `String `__ name + | ) + + + + + + + + * - public static :ref:`SubscriptionSet.State ` + - | :ref:`values ` () + | + + + + + + + + + + +Inherited Methods +================= + + + +- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` +- Methods inherited from class `java.lang.Enum `__ : ``name`` , ``ordinal`` , ``toString`` , ``equals`` , ``hashCode`` , ``clone`` , ``compareTo`` , ``getDeclaringClass`` , ``valueOf`` , ``finalize`` + + + + +Enum Constant Detail +==================== + + +.. _io_realm_mongodb_sync_SubscriptionSet_State_BOOTSTRAPPING: + +.. _SubscriptionSet_State_BOOTSTRAPPING: + + + +``BOOTSTRAPPING`` +------------------ + +public static final :ref:`SubscriptionSet.State ` + +A subscription set was accepted by the server and initial data is being sent to the device. + + + +.. _io_realm_mongodb_sync_SubscriptionSet_State_COMPLETE: + +.. _SubscriptionSet_State_COMPLETE: + + + +``COMPLETE`` +------------- + +public static final :ref:`SubscriptionSet.State ` + +A subscription set is actively synchronizing data between the server and the device. + + + +.. _io_realm_mongodb_sync_SubscriptionSet_State_ERROR: + +.. _SubscriptionSet_State_ERROR: + + + +``ERROR`` +---------- + +public static final :ref:`SubscriptionSet.State ` + +An error occurred in the subscription set or one of the subscriptions. The cause is found in **getErrorMessage()**. + + + + + +.. _io_realm_mongodb_sync_SubscriptionSet_State_PENDING: + +.. _SubscriptionSet_State_PENDING: + + + +``PENDING`` +------------ + +public static final :ref:`SubscriptionSet.State ` + +A subscription set has been modified locally, but is still waiting to be sent to the server. + + + +.. _io_realm_mongodb_sync_SubscriptionSet_State_SUPERSEDED: + +.. _SubscriptionSet_State_SUPERSEDED: + + + +``SUPERSEDED`` +--------------- + +public static final :ref:`SubscriptionSet.State ` + +Another subscription set was stored before this one, the changes made to this set are ignorde by the server. Get the latest subscription set by calling **Realm.getSubscriptions()**. + + + + + +.. _io_realm_mongodb_sync_SubscriptionSet_State_UNCOMMITTED: + +.. _SubscriptionSet_State_UNCOMMITTED: + + + +``UNCOMMITTED`` +---------------- + +public static final :ref:`SubscriptionSet.State ` + +The initial state of subscriptions when opening a new Realm or when entering a **update(UpdateCallback)**. + + + + + + +Method Detail +============= + +.. _fromNativeValue: + +.. _fromNativeValue__: + +.. _State_fromNativeValue: + +.. _State_fromNativeValue__: + +.. _SubscriptionSet_State_fromNativeValue: + +.. _SubscriptionSet_State_fromNativeValue__: + +.. _io_realm_mongodb_sync_SubscriptionSet_State_fromNativeValue: + +.. _io_realm_mongodb_sync_SubscriptionSet_State_fromNativeValue__: + + + +fromNativeValue +--------------- + +.. _io_realm_mongodb_sync_SubscriptionSet_State_fromNativeValue_long_: + +.. _fromNativeValue_long_: + +.. _SubscriptionSet_State_fromNativeValue_long_: + +.. list-table:: + :header-rows: 1 + + * - | public static :ref:`SubscriptionSet.State ` :ref:`fromNativeValue ` ( + | **long** value + | ) + + + + + * - + + + + + + + + + + + + + + + +.. _valueOf: + +.. _valueOf__: + +.. _State_valueOf: + +.. _State_valueOf__: + +.. _SubscriptionSet_State_valueOf: + +.. _SubscriptionSet_State_valueOf__: + +.. _io_realm_mongodb_sync_SubscriptionSet_State_valueOf: + +.. _io_realm_mongodb_sync_SubscriptionSet_State_valueOf__: + + + +valueOf +------- + +.. _io_realm_mongodb_sync_SubscriptionSet_State_valueOf_java_lang_String_: + +.. _io_realm_mongodb_sync_SubscriptionSet_State_valueOf_String_: + +.. _valueOf_java_lang_String_: + +.. _valueOf_String_: + +.. _SubscriptionSet_State_valueOf_java_lang_String_: + +.. _SubscriptionSet_State_valueOf_String_: + +.. list-table:: + :header-rows: 1 + + * - | public static :ref:`SubscriptionSet.State ` :ref:`valueOf ` ( + | `String `__ name + | ) + + + + + * - + + + + + + + + + + + + + + + +.. _values: + +.. _values__: + +.. _State_values: + +.. _State_values__: + +.. _SubscriptionSet_State_values: + +.. _SubscriptionSet_State_values__: + +.. _io_realm_mongodb_sync_SubscriptionSet_State_values: + +.. _io_realm_mongodb_sync_SubscriptionSet_State_values__: + + + +values +------ + +.. list-table:: + :header-rows: 1 + + * - | public static :ref:`SubscriptionSet.State ` :ref:`values ` () + | + + + + + * - + + + + + + + + + + + + + + + + diff --git a/source/sdk/java/api/io/realm/mongodb/sync/SubscriptionSet/StateChangeCallback.txt b/source/sdk/java/api/io/realm/mongodb/sync/SubscriptionSet/StateChangeCallback.txt new file mode 100644 index 0000000000..147ebbb9cf --- /dev/null +++ b/source/sdk/java/api/io/realm/mongodb/sync/SubscriptionSet/StateChangeCallback.txt @@ -0,0 +1,188 @@ + +.. contents:: On this page + :local: + :backlinks: none + :depth: 2 + :class: singlecol + + + +Interface SubscriptionSet.StateChangeCallback +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. _io_realm_mongodb_sync_SubscriptionSet_StateChangeCallback: + + + +io.realm.mongodb.sync +===================== + + + +**Enclosing class:** + +:ref:`SubscriptionSet ` + + + +Callback used when asynchronously waiting for the server to process the subscription set. When the server either succeed or fail to apply the subscription set, the result is returned in ``onStateChange`` . This include errors from the server. If a local exception is thrown, it is reported through on ``onError()`` . + + + + +Method Summary +============== + +.. list-table:: + :header-rows: 1 + + * - Modifier and Type + - Method and Description + + * - public **void** + - | :ref:`onError ` ( + | `Throwable `__ e + | ) + + + + + + + + * - public **void** + - | :ref:`onStateChange ` ( + | :ref:`SubscriptionSet ` subscriptions + | ) + + + + + + + + + + +Method Detail +============= + +.. _onError: + +.. _onError__: + +.. _StateChangeCallback_onError: + +.. _StateChangeCallback_onError__: + +.. _SubscriptionSet_StateChangeCallback_onError: + +.. _SubscriptionSet_StateChangeCallback_onError__: + +.. _io_realm_mongodb_sync_SubscriptionSet_StateChangeCallback_onError: + +.. _io_realm_mongodb_sync_SubscriptionSet_StateChangeCallback_onError__: + + + +onError +------- + +.. _io_realm_mongodb_sync_SubscriptionSet_StateChangeCallback_onError_java_lang_Throwable_: + +.. _io_realm_mongodb_sync_SubscriptionSet_StateChangeCallback_onError_Throwable_: + +.. _onError_java_lang_Throwable_: + +.. _onError_Throwable_: + +.. _SubscriptionSet_StateChangeCallback_onError_java_lang_Throwable_: + +.. _SubscriptionSet_StateChangeCallback_onError_Throwable_: + +.. list-table:: + :header-rows: 1 + + * - | public **void** :ref:`onError ` ( + | `Throwable `__ e + | ) + + + + + * - + + + + + + + + + + + + + + + +.. _onStateChange: + +.. _onStateChange__: + +.. _StateChangeCallback_onStateChange: + +.. _StateChangeCallback_onStateChange__: + +.. _SubscriptionSet_StateChangeCallback_onStateChange: + +.. _SubscriptionSet_StateChangeCallback_onStateChange__: + +.. _io_realm_mongodb_sync_SubscriptionSet_StateChangeCallback_onStateChange: + +.. _io_realm_mongodb_sync_SubscriptionSet_StateChangeCallback_onStateChange__: + + + +onStateChange +------------- + +.. _io_realm_mongodb_sync_SubscriptionSet_StateChangeCallback_onStateChange_io_realm_mongodb_sync_SubscriptionSet_: + +.. _io_realm_mongodb_sync_SubscriptionSet_StateChangeCallback_onStateChange_SubscriptionSet_: + +.. _onStateChange_io_realm_mongodb_sync_SubscriptionSet_: + +.. _onStateChange_SubscriptionSet_: + +.. _SubscriptionSet_StateChangeCallback_onStateChange_io_realm_mongodb_sync_SubscriptionSet_: + +.. _SubscriptionSet_StateChangeCallback_onStateChange_SubscriptionSet_: + +.. list-table:: + :header-rows: 1 + + * - | public **void** :ref:`onStateChange ` ( + | :ref:`SubscriptionSet ` subscriptions + | ) + + + + + * - + + + + + + + + + + + + + + + + diff --git a/source/sdk/java/api/io/realm/mongodb/sync/SubscriptionSet/UpdateAsyncCallback.txt b/source/sdk/java/api/io/realm/mongodb/sync/SubscriptionSet/UpdateAsyncCallback.txt new file mode 100644 index 0000000000..3891f02a93 --- /dev/null +++ b/source/sdk/java/api/io/realm/mongodb/sync/SubscriptionSet/UpdateAsyncCallback.txt @@ -0,0 +1,200 @@ + +.. contents:: On this page + :local: + :backlinks: none + :depth: 2 + :class: singlecol + + + +Interface SubscriptionSet.UpdateAsyncCallback +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. _io_realm_mongodb_sync_SubscriptionSet_UpdateAsyncCallback: + + + +io.realm.mongodb.sync +===================== + +**Implemented interfaces:** + + + +- :ref:`io.realm.mongodb.sync.SubscriptionSet.UpdateCallback ` + + + + +**Enclosing class:** + +:ref:`SubscriptionSet ` + + + +Callback used when asynchronously updating a subscription set. If an exception is throwing during the update, all changes will be rolled back and the exception will be reported in ``onError()`` . + + + + +Method Summary +============== + +.. list-table:: + :header-rows: 1 + + * - Modifier and Type + - Method and Description + + * - public **void** + - | :ref:`onError ` ( + | `Throwable `__ exception + | ) + + + + + + + + * - public **void** + - | :ref:`onSuccess ` ( + | :ref:`SubscriptionSet ` subscriptions + | ) + + + + + + + + + + +Inherited Methods +================= + + + +Method Detail +============= + +.. _onError: + +.. _onError__: + +.. _UpdateAsyncCallback_onError: + +.. _UpdateAsyncCallback_onError__: + +.. _SubscriptionSet_UpdateAsyncCallback_onError: + +.. _SubscriptionSet_UpdateAsyncCallback_onError__: + +.. _io_realm_mongodb_sync_SubscriptionSet_UpdateAsyncCallback_onError: + +.. _io_realm_mongodb_sync_SubscriptionSet_UpdateAsyncCallback_onError__: + + + +onError +------- + +.. _io_realm_mongodb_sync_SubscriptionSet_UpdateAsyncCallback_onError_java_lang_Throwable_: + +.. _io_realm_mongodb_sync_SubscriptionSet_UpdateAsyncCallback_onError_Throwable_: + +.. _onError_java_lang_Throwable_: + +.. _onError_Throwable_: + +.. _SubscriptionSet_UpdateAsyncCallback_onError_java_lang_Throwable_: + +.. _SubscriptionSet_UpdateAsyncCallback_onError_Throwable_: + +.. list-table:: + :header-rows: 1 + + * - | public **void** :ref:`onError ` ( + | `Throwable `__ exception + | ) + + + + + * - + + + + + + + + + + + + + + + +.. _onSuccess: + +.. _onSuccess__: + +.. _UpdateAsyncCallback_onSuccess: + +.. _UpdateAsyncCallback_onSuccess__: + +.. _SubscriptionSet_UpdateAsyncCallback_onSuccess: + +.. _SubscriptionSet_UpdateAsyncCallback_onSuccess__: + +.. _io_realm_mongodb_sync_SubscriptionSet_UpdateAsyncCallback_onSuccess: + +.. _io_realm_mongodb_sync_SubscriptionSet_UpdateAsyncCallback_onSuccess__: + + + +onSuccess +--------- + +.. _io_realm_mongodb_sync_SubscriptionSet_UpdateAsyncCallback_onSuccess_io_realm_mongodb_sync_SubscriptionSet_: + +.. _io_realm_mongodb_sync_SubscriptionSet_UpdateAsyncCallback_onSuccess_SubscriptionSet_: + +.. _onSuccess_io_realm_mongodb_sync_SubscriptionSet_: + +.. _onSuccess_SubscriptionSet_: + +.. _SubscriptionSet_UpdateAsyncCallback_onSuccess_io_realm_mongodb_sync_SubscriptionSet_: + +.. _SubscriptionSet_UpdateAsyncCallback_onSuccess_SubscriptionSet_: + +.. list-table:: + :header-rows: 1 + + * - | public **void** :ref:`onSuccess ` ( + | :ref:`SubscriptionSet ` subscriptions + | ) + + + + + * - + + + + + + + + + + + + + + + + diff --git a/source/sdk/java/api/io/realm/mongodb/sync/SubscriptionSet/UpdateCallback.txt b/source/sdk/java/api/io/realm/mongodb/sync/SubscriptionSet/UpdateCallback.txt new file mode 100644 index 0000000000..ed35a96643 --- /dev/null +++ b/source/sdk/java/api/io/realm/mongodb/sync/SubscriptionSet/UpdateCallback.txt @@ -0,0 +1,126 @@ + +.. contents:: On this page + :local: + :backlinks: none + :depth: 2 + :class: singlecol + + + +Interface SubscriptionSet.UpdateCallback +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. _io_realm_mongodb_sync_SubscriptionSet_UpdateCallback: + + + +io.realm.mongodb.sync +===================== + + + +**Enclosing class:** + +:ref:`SubscriptionSet ` + + + +Interface used when modifying a subscription set. See **update(UpdateCallback)** and **updateAsync(UpdateAsyncCallback)**. + + + + +Method Summary +============== + +.. list-table:: + :header-rows: 1 + + * - Modifier and Type + - Method and Description + + * - public **void** + - | :ref:`update ` ( + | :ref:`MutableSubscriptionSet ` subscriptions + | ) + + + Updates the current subscription set by passing in a version of it that can be modified. + + + + + + + +Method Detail +============= + +.. _update: + +.. _update__: + +.. _UpdateCallback_update: + +.. _UpdateCallback_update__: + +.. _SubscriptionSet_UpdateCallback_update: + +.. _SubscriptionSet_UpdateCallback_update__: + +.. _io_realm_mongodb_sync_SubscriptionSet_UpdateCallback_update: + +.. _io_realm_mongodb_sync_SubscriptionSet_UpdateCallback_update__: + + + +update +------ + +.. _io_realm_mongodb_sync_SubscriptionSet_UpdateCallback_update_io_realm_mongodb_sync_MutableSubscriptionSet_: + +.. _io_realm_mongodb_sync_SubscriptionSet_UpdateCallback_update_MutableSubscriptionSet_: + +.. _update_io_realm_mongodb_sync_MutableSubscriptionSet_: + +.. _update_MutableSubscriptionSet_: + +.. _SubscriptionSet_UpdateCallback_update_io_realm_mongodb_sync_MutableSubscriptionSet_: + +.. _SubscriptionSet_UpdateCallback_update_MutableSubscriptionSet_: + +.. list-table:: + :header-rows: 1 + + * - | public **void** :ref:`update ` ( + | :ref:`MutableSubscriptionSet ` subscriptions + | ) + + + + + * - Updates the current subscription set by passing in a version of it that can be modified. If an exception is throwing during the update, all changes will be rolled back. + + + + + **Parameters** + + - ``subscriptions`` - a modifiable version of the subscription set. + + + + + + + + + + + + + + + + + diff --git a/source/sdk/java/api/io/realm/mongodb/sync/Sync.txt b/source/sdk/java/api/io/realm/mongodb/sync/Sync.txt index 6064055f35..c955378c98 100644 --- a/source/sdk/java/api/io/realm/mongodb/sync/Sync.txt +++ b/source/sdk/java/api/io/realm/mongodb/sync/Sync.txt @@ -18,7 +18,7 @@ io.realm.mongodb.sync ===================== - | `java.lang.Object `__ + | `java.lang.Object `__ | io.realm.mongodb.sync.Sync @@ -90,7 +90,7 @@ Method Summary * - Modifier and Type - Method and Description - * - public synchronized `Collection `__ + * - public synchronized `Collection `__ - | :ref:`getAllSessions ` () | @@ -146,7 +146,7 @@ Inherited Methods -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` +- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` @@ -174,7 +174,7 @@ getAllSessions .. list-table:: :header-rows: 1 - * - | public synchronized `Collection `__ :ref:`getAllSessions ` () + * - | public synchronized `Collection `__ :ref:`getAllSessions ` () | @@ -272,7 +272,7 @@ getOrCreateSession **Throws** - - `IllegalArgumentException `__ - if syncConfiguration is ``null`` . + - `IllegalArgumentException `__ - if syncConfiguration is ``null`` . @@ -354,13 +354,13 @@ getSession **Throws** - - `IllegalArgumentException `__ - if syncConfiguration is ``null`` . + - `IllegalArgumentException `__ - if syncConfiguration is ``null`` . - - `IllegalStateException `__ - if the session could not be found using the provided ``SyncConfiguration`` . + - `IllegalStateException `__ - if the session could not be found using the provided ``SyncConfiguration`` . diff --git a/source/sdk/java/api/io/realm/mongodb/sync/Sync/Debug.txt b/source/sdk/java/api/io/realm/mongodb/sync/Sync/Debug.txt index 3523bc39d1..347cd6a9b4 100644 --- a/source/sdk/java/api/io/realm/mongodb/sync/Sync/Debug.txt +++ b/source/sdk/java/api/io/realm/mongodb/sync/Sync/Debug.txt @@ -18,7 +18,7 @@ io.realm.mongodb.sync ===================== - | `java.lang.Object `__ + | `java.lang.Object `__ | io.realm.mongodb.sync.Sync.Debug @@ -86,7 +86,7 @@ Inherited Methods -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` +- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` diff --git a/source/sdk/java/api/io/realm/mongodb/sync/SyncClientResetStrategy.txt b/source/sdk/java/api/io/realm/mongodb/sync/SyncClientResetStrategy.txt new file mode 100644 index 0000000000..06a3044d47 --- /dev/null +++ b/source/sdk/java/api/io/realm/mongodb/sync/SyncClientResetStrategy.txt @@ -0,0 +1,23 @@ + +.. contents:: On this page + :local: + :backlinks: none + :depth: 2 + :class: singlecol + + + +Interface SyncClientResetStrategy +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. _io_realm_mongodb_sync_SyncClientResetStrategy: + + + +io.realm.mongodb.sync +===================== + +Interface that defines a generic sync client reset strategy, it could be either :ref:`ManuallyRecoverUnsyncedChangesStrategy ` or :ref:`DiscardUnsyncedChangesStrategy ` . + + + diff --git a/source/sdk/java/api/io/realm/mongodb/sync/SyncConfiguration.txt b/source/sdk/java/api/io/realm/mongodb/sync/SyncConfiguration.txt index 5608544e11..ba32ee654d 100644 --- a/source/sdk/java/api/io/realm/mongodb/sync/SyncConfiguration.txt +++ b/source/sdk/java/api/io/realm/mongodb/sync/SyncConfiguration.txt @@ -18,7 +18,7 @@ io.realm.mongodb.sync ===================== - | `java.lang.Object `__ + | `java.lang.Object `__ | :ref:`io.realm.RealmConfiguration ` | io.realm.mongodb.sync.SyncConfiguration @@ -72,7 +72,7 @@ Synchronized Realms are created by using :ref:`Realm.getInstance(RealmConfigurat - - `The docs `__ for more information about the two types of synchronization. + - `The docs `__ for more information about synchronization. @@ -92,6 +92,10 @@ Nested Class Summary * - Modifier and Type - Class and Description + * - ``public static interface`` + - :ref:`SyncConfiguration.InitialFlexibleSyncSubscriptions ` + + * - ``public static final`` - :ref:`SyncConfiguration.Builder ` @@ -115,7 +119,7 @@ Method Summary | ) - Returns a default configuration for the given user and partition value. + Returns a default Partition-based Sync configuration for the given user and partition value. @@ -123,11 +127,11 @@ Method Summary * - public static :ref:`SyncConfiguration ` - | :ref:`defaultConfig ` ( | :ref:`User ` user, - | `Integer `__ partitionValue + | `Integer `__ partitionValue | ) - Returns a default configuration for the given user and partition value. + Returns a default Partition-based Sync configuration for the given user and partition value. @@ -135,11 +139,11 @@ Method Summary * - public static :ref:`SyncConfiguration ` - | :ref:`defaultConfig ` ( | :ref:`User ` user, - | `Long `__ partitionValue + | `Long `__ partitionValue | ) - Returns a default configuration for the given user and partition value. + Returns a default Partition-based Sync configuration for the given user and partition value. @@ -147,18 +151,29 @@ Method Summary * - public static :ref:`SyncConfiguration ` - | :ref:`defaultConfig ` ( | :ref:`User ` user, - | `String `__ partitionValue + | `String `__ partitionValue + | ) + + + Returns a default Partition-based Sync configuration for the given user and partition value. + + + + + * - public static :ref:`SyncConfiguration ` + - | :ref:`defaultConfig ` ( + | :ref:`User ` user | ) - Returns a default configuration for the given user and partition value. + Returns a default Flexible Sync configuration for the given user. * - public **boolean** - | :ref:`equals ` ( - | `Object `__ o + | `Object `__ o | ) @@ -169,7 +184,7 @@ Method Summary * - public static :ref:`RealmConfiguration ` - | :ref:`forRecovery ` ( - | `String `__ canonicalPath + | `String `__ canonicalPath | ) @@ -182,9 +197,9 @@ Method Summary * - public static :ref:`RealmConfiguration ` - | :ref:`forRecovery ` ( - | `String `__ canonicalPath, + | `String `__ canonicalPath, | **byte[]** encryptionKey, - | `java.lang.Object[] `__ modules + | `java.lang.Object[] `__ modules | ) @@ -227,7 +242,7 @@ Method Summary * - public **long** - | :ref:`getInitialRemoteDataTimeout ` ( - | `TimeUnit `__ unit + | `TimeUnit `__ unit | ) @@ -236,6 +251,16 @@ Method Summary + * - public :ref:`SyncConfiguration.InitialFlexibleSyncSubscriptions ` + - | :ref:`getInitialSubscriptionsHandler ` () + | + + + Returns the configured initial subscription handler for this realm. + + + + * - public **BsonValue** - | :ref:`getPartitionValue ` () | @@ -246,7 +271,7 @@ Method Summary - * - public `URI `__ + * - public `URI `__ - | :ref:`getServerUrl ` () | @@ -266,7 +291,17 @@ Method Summary - * - public `String `__ + * - public :ref:`SyncClientResetStrategy ` + - | :ref:`getSyncClientResetStrategy ` () + | + + + Returns the sync client reset strategy for this *SyncConfiguration*. + + + + + * - public `String `__ - | :ref:`getUrlPrefix ` () | @@ -296,6 +331,26 @@ Method Summary + * - public **boolean** + - | :ref:`isFlexibleSyncConfiguration ` () + | + + + Returns whether or not this configuration is for opening a Realm configured for Flexible Sync. + + + + + * - public **boolean** + - | :ref:`isPartitionBasedSyncConfiguration ` () + | + + + Returns whether or not this configuration is for opening a Realm configured for Partition-based Sync. + + + + * - protected **boolean** - | :ref:`isSyncConfiguration ` () | @@ -340,7 +395,7 @@ Method Summary - * - public `String `__ + * - public `String `__ - | :ref:`toString ` () | @@ -358,8 +413,8 @@ Inherited Methods -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` -- Methods inherited from class :ref:`io.realm.RealmConfiguration ` : ``getRealmDirectory`` , ``getRealmFileName`` , ``getEncryptionKey`` , ``getSchemaVersion`` , ``getMigration`` , ``shouldDeleteRealmIfMigrationNeeded`` , ``getDurability`` , ``getSchemaMediator`` , ``getInitialDataTransaction`` , ``getCompactOnLaunchCallback`` , ``getRealmObjectClasses`` , ``getPath`` , ``realmExists`` , ``getRxFactory`` , ``getFlowFactory`` , ``isReadOnly`` , ``isRecoveryConfiguration`` , ``getMaxNumberOfActiveVersions`` , ``isAllowWritesOnUiThread`` , ``isAllowQueriesOnUiThread`` , ``equals`` , ``hashCode`` , ``createSchemaMediator`` , ``toString`` , ``isSyncConfiguration`` , ``forRecovery`` +- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` +- Methods inherited from class :ref:`io.realm.RealmConfiguration ` : ``getRealmDirectory`` , ``getRealmFileName`` , ``getEncryptionKey`` , ``getSchemaVersion`` , ``getMigration`` , ``shouldDeleteRealmIfMigrationNeeded`` , ``getDurability`` , ``getSchemaMediator`` , ``getInitialDataTransaction`` , ``hasAssetFile`` , ``getAssetFilePath`` , ``getCompactOnLaunchCallback`` , ``getRealmObjectClasses`` , ``getPath`` , ``realmExists`` , ``getRxFactory`` , ``getFlowFactory`` , ``isReadOnly`` , ``isRecoveryConfiguration`` , ``getMaxNumberOfActiveVersions`` , ``isAllowWritesOnUiThread`` , ``isAllowQueriesOnUiThread`` , ``equals`` , ``getInstance`` , ``hashCode`` , ``createSchemaMediator`` , ``toString`` , ``isSyncConfiguration`` , ``forRecovery`` @@ -419,7 +474,7 @@ defaultConfig - * - Returns a default configuration for the given user and partition value. + * - Returns a default Partition-based Sync configuration for the given user and partition value. @@ -503,13 +558,13 @@ defaultConfig * - | public static :ref:`SyncConfiguration ` :ref:`defaultConfig ` ( | :ref:`User ` user, - | `Integer `__ partitionValue + | `Integer `__ partitionValue | ) - * - Returns a default configuration for the given user and partition value. + * - Returns a default Partition-based Sync configuration for the given user and partition value. @@ -593,13 +648,13 @@ defaultConfig * - | public static :ref:`SyncConfiguration ` :ref:`defaultConfig ` ( | :ref:`User ` user, - | `Long `__ partitionValue + | `Long `__ partitionValue | ) - * - Returns a default configuration for the given user and partition value. + * - Returns a default Partition-based Sync configuration for the given user and partition value. @@ -683,13 +738,13 @@ defaultConfig * - | public static :ref:`SyncConfiguration ` :ref:`defaultConfig ` ( | :ref:`User ` user, - | `String `__ partitionValue + | `String `__ partitionValue | ) - * - Returns a default configuration for the given user and partition value. + * - Returns a default Partition-based Sync configuration for the given user and partition value. @@ -720,6 +775,69 @@ defaultConfig +.. _io_realm_mongodb_sync_SyncConfiguration_defaultConfig_io_realm_mongodb_User_: + +.. _io_realm_mongodb_sync_SyncConfiguration_defaultConfig_User_: + +.. _defaultConfig_io_realm_mongodb_User_: + +.. _defaultConfig_User_: + +.. _SyncConfiguration_defaultConfig_io_realm_mongodb_User_: + +.. _SyncConfiguration_defaultConfig_User_: + +.. list-table:: + :header-rows: 1 + + * - | public static :ref:`SyncConfiguration ` :ref:`defaultConfig ` ( + | :ref:`User ` user + | ) + + + + + * - Returns a default Flexible Sync configuration for the given user. + + + + + **Parameters** + + - ``user`` - The user that will be used for accessing the Realm App. + + + + + + + + **Returns** + + the default Flexible Sync configuration for the given user. + + + + + + + + + .. seealso:: + + + + - **{@link SubscriptionSet} for more information about Flexible Sync.** + + + + + + + + + + .. _equals: @@ -755,7 +873,7 @@ equals :header-rows: 1 * - | public **boolean** :ref:`equals ` ( - | `Object `__ o + | `Object `__ o | ) @@ -814,7 +932,7 @@ forRecovery :header-rows: 1 * - | public static :ref:`RealmConfiguration ` :ref:`forRecovery ` ( - | `String `__ canonicalPath + | `String `__ canonicalPath | ) @@ -999,9 +1117,9 @@ forRecovery :header-rows: 1 * - | public static :ref:`RealmConfiguration ` :ref:`forRecovery ` ( - | `String `__ canonicalPath, + | `String `__ canonicalPath, | **byte[]** encryptionKey, - | `java.lang.Object[] `__ modules + | `java.lang.Object[] `__ modules | ) @@ -1224,7 +1342,7 @@ getInitialRemoteDataTimeout :header-rows: 1 * - | public **long** :ref:`getInitialRemoteDataTimeout ` ( - | `TimeUnit `__ unit + | `TimeUnit `__ unit | ) @@ -1269,6 +1387,53 @@ getInitialRemoteDataTimeout +.. _getInitialSubscriptionsHandler: + +.. _getInitialSubscriptionsHandler__: + +.. _SyncConfiguration_getInitialSubscriptionsHandler: + +.. _SyncConfiguration_getInitialSubscriptionsHandler__: + +.. _io_realm_mongodb_sync_SyncConfiguration_getInitialSubscriptionsHandler: + +.. _io_realm_mongodb_sync_SyncConfiguration_getInitialSubscriptionsHandler__: + + + +getInitialSubscriptionsHandler +------------------------------ + +.. list-table:: + :header-rows: 1 + + * - | public :ref:`SyncConfiguration.InitialFlexibleSyncSubscriptions ` :ref:`getInitialSubscriptionsHandler ` () + | + + + + + * - Returns the configured initial subscription handler for this realm. + + + + + + + **Returns** + + the handler used to configure initial subscriptions for this realm. + + + + + + + + + + + .. _getPartitionValue: .. _getPartitionValue__: @@ -1309,6 +1474,16 @@ getPartitionValue + **Throws** + + - `IllegalStateException `__ - if this configuration is for a realm configured for flexible sync. You can use :ref:`isPartitionBasedSyncConfiguration() ` before calling this method to check. + + + + + + + @@ -1336,7 +1511,7 @@ getServerUrl .. list-table:: :header-rows: 1 - * - | public `URI `__ :ref:`getServerUrl ` () + * - | public `URI `__ :ref:`getServerUrl ` () | @@ -1351,7 +1526,7 @@ getServerUrl **Returns** - `URI `__ identifying the MongoDB Realm this local Realm is synchronized with. + `URI `__ identifying the MongoDB Realm this local Realm is synchronized with. @@ -1412,6 +1587,53 @@ getSessionStopPolicy +.. _getSyncClientResetStrategy: + +.. _getSyncClientResetStrategy__: + +.. _SyncConfiguration_getSyncClientResetStrategy: + +.. _SyncConfiguration_getSyncClientResetStrategy__: + +.. _io_realm_mongodb_sync_SyncConfiguration_getSyncClientResetStrategy: + +.. _io_realm_mongodb_sync_SyncConfiguration_getSyncClientResetStrategy__: + + + +getSyncClientResetStrategy +-------------------------- + +.. list-table:: + :header-rows: 1 + + * - | public :ref:`SyncClientResetStrategy ` :ref:`getSyncClientResetStrategy ` () + | + + + + + * - Returns the sync client reset strategy for this *SyncConfiguration*. + + + + + + + **Returns** + + the sync client reset strategy. + + + + + + + + + + + .. _getUrlPrefix: .. _getUrlPrefix__: @@ -1432,7 +1654,7 @@ getUrlPrefix .. list-table:: :header-rows: 1 - * - | public `String `__ :ref:`getUrlPrefix ` () + * - | public `String `__ :ref:`getUrlPrefix ` () | @@ -1547,6 +1769,104 @@ hashCode +.. _isFlexibleSyncConfiguration: + +.. _isFlexibleSyncConfiguration__: + +.. _SyncConfiguration_isFlexibleSyncConfiguration: + +.. _SyncConfiguration_isFlexibleSyncConfiguration__: + +.. _io_realm_mongodb_sync_SyncConfiguration_isFlexibleSyncConfiguration: + +.. _io_realm_mongodb_sync_SyncConfiguration_isFlexibleSyncConfiguration__: + + + +isFlexibleSyncConfiguration +--------------------------- + +.. list-table:: + :header-rows: 1 + + * - | public **boolean** :ref:`isFlexibleSyncConfiguration ` () + | + + + + + * - Returns whether or not this configuration is for opening a Realm configured for Flexible Sync. + + + + + + + **Returns** + + ``true`` if this configuration is for a Flexible Sync Realm, ``false`` if not. + + + + + + + + + + + + + +.. _isPartitionBasedSyncConfiguration: + +.. _isPartitionBasedSyncConfiguration__: + +.. _SyncConfiguration_isPartitionBasedSyncConfiguration: + +.. _SyncConfiguration_isPartitionBasedSyncConfiguration__: + +.. _io_realm_mongodb_sync_SyncConfiguration_isPartitionBasedSyncConfiguration: + +.. _io_realm_mongodb_sync_SyncConfiguration_isPartitionBasedSyncConfiguration__: + + + +isPartitionBasedSyncConfiguration +--------------------------------- + +.. list-table:: + :header-rows: 1 + + * - | public **boolean** :ref:`isPartitionBasedSyncConfiguration ` () + | + + + + + * - Returns whether or not this configuration is for opening a Realm configured for Partition-based Sync. + + + + + + + **Returns** + + ``true`` if this configuration is for a Partition-based Sync Realm, ``false`` if not. + + + + + + + + + + + + + .. _isSyncConfiguration: .. _isSyncConfiguration__: @@ -1770,7 +2090,7 @@ toString .. list-table:: :header-rows: 1 - * - | public `String `__ :ref:`toString ` () + * - | public `String `__ :ref:`toString ` () | diff --git a/source/sdk/java/api/io/realm/mongodb/sync/SyncConfiguration/Builder.txt b/source/sdk/java/api/io/realm/mongodb/sync/SyncConfiguration/Builder.txt index f68555b2aa..ad36b750f8 100644 --- a/source/sdk/java/api/io/realm/mongodb/sync/SyncConfiguration/Builder.txt +++ b/source/sdk/java/api/io/realm/mongodb/sync/SyncConfiguration/Builder.txt @@ -18,7 +18,7 @@ io.realm.mongodb.sync ===================== - | `java.lang.Object `__ + | `java.lang.Object `__ | io.realm.mongodb.sync.SyncConfiguration.Builder @@ -41,13 +41,23 @@ Constructors * - Constructor and Description + * - | :ref:`Builder ` ( + | :ref:`User ` user + | ) + + + Creates an instance of the builder for a Flexible Sync *SyncConfiguration* with the given user. + + + + * - | :ref:`Builder ` ( | :ref:`User ` user, - | `String `__ partitionValue + | `String `__ partitionValue | ) - Creates an instance of the builder for a *SyncConfiguration* with the given user and partition value. + Creates an instance of the builder for a Partition-based Sync *SyncConfiguration* with the given user and partition value. @@ -58,7 +68,7 @@ Constructors | ) - Creates an instance of the builder for a *SyncConfiguration* with the given user and partition value. + Creates an instance of the builder for a Partition-based Sync *SyncConfiguration* with the given user and partition value. @@ -77,7 +87,7 @@ Method Summary * - public :ref:`SyncConfiguration.Builder ` - | :ref:`addModule ` ( - | `Object `__ module + | `Object `__ module | ) @@ -112,6 +122,17 @@ Method Summary + * - public :ref:`SyncConfiguration.Builder ` + - | :ref:`assetFile ` ( + | `String `__ assetFile + | ) + + + When opening the Realm for the first time, instead of creating an empty file, the Realm file will be copied from the provided asset file and used instead. + + + + * - public :ref:`SyncConfiguration ` - | :ref:`build ` () | @@ -214,13 +235,26 @@ Method Summary + * - public :ref:`SyncConfiguration.Builder ` + - | :ref:`initialSubscriptions ` ( + | :ref:`SyncConfiguration.InitialFlexibleSyncSubscriptions ` action + | ) + + + Sets the initial :ref:`Subscription ` s for the :ref:`io.realm.Realm ` . + + + + + + * - public :ref:`SyncConfiguration.Builder ` - | :ref:`maxNumberOfActiveVersions ` ( | **long** number | ) - Sets the maximum number of live versions in the Realm file before an `IllegalStateException `__ is thrown when attempting to write more data. + Sets the maximum number of live versions in the Realm file before an `IllegalStateException `__ is thrown when attempting to write more data. @@ -229,7 +263,7 @@ Method Summary * - public :ref:`SyncConfiguration.Builder ` - | :ref:`modules ` ( - | `java.lang.Iterable\ `__ modules + | `java.lang.Iterable\ `__ modules | ) @@ -242,8 +276,8 @@ Method Summary * - public :ref:`SyncConfiguration.Builder ` - | :ref:`modules ` ( - | `Object `__ baseModule, - | `java.lang.Object[] `__ additionalModules + | `Object `__ baseModule, + | `java.lang.Object[] `__ additionalModules | ) @@ -254,12 +288,23 @@ Method Summary + * - public :ref:`SyncConfiguration.Builder ` + - | :ref:`name ` ( + | `String `__ filename + | ) + + + Sets the filename for the Realm file on this device. + + + + * - public :ref:`SyncConfiguration.Builder ` - | :ref:`readOnly ` () | - Setting this will cause the Realm to become read only and all write transactions made against this Realm will fail with an `IllegalStateException `__ . + Setting this will cause the Realm to become read only and all write transactions made against this Realm will fail with an `IllegalStateException `__ . @@ -290,9 +335,31 @@ Method Summary + * - public :ref:`SyncConfiguration.Builder ` + - | :ref:`syncClientResetStrategy ` ( + | :ref:`DiscardUnsyncedChangesStrategy ` handler + | ) + + + Sets the handler for when a Client Reset occurs. + + + + + * - public :ref:`SyncConfiguration.Builder ` + - | :ref:`syncClientResetStrategy ` ( + | :ref:`ManuallyRecoverUnsyncedChangesStrategy ` handler + | ) + + + Sets the handler for when a Client Reset occurs. + + + + * - public :ref:`SyncConfiguration.Builder ` - | :ref:`urlPrefix ` ( - | `String `__ urlPrefix + | `String `__ urlPrefix | ) @@ -304,7 +371,7 @@ Method Summary * - public :ref:`SyncConfiguration.Builder ` - | :ref:`waitForInitialRemoteData ` ( | **long** timeout, - | `TimeUnit `__ unit + | `TimeUnit `__ unit | ) @@ -331,7 +398,7 @@ Inherited Methods -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` +- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` @@ -339,6 +406,58 @@ Inherited Methods Constructor Detail ================== +.. _Builder: + +.. _Builder__: + +.. _io_realm_mongodb_sync_SyncConfiguration_Builder: + +.. _io_realm_mongodb_sync_SyncConfiguration_Builder__: + +.. list-table:: + :header-rows: 1 + + * - | public :ref:`Builder ` ( + | :ref:`User ` user + | ) + + + + + * - Creates an instance of the builder for a Flexible Sync *SyncConfiguration* with the given user. + + + + + **Parameters** + + - ``user`` - The user that will be used for accessing the Realm App. + + + + + + + + + + .. seealso:: + + + + - **{@link SubscriptionSet} for more information about Flexible Sync.** + + + + + + + + + + + + .. _Builder: .. _Builder__: @@ -352,13 +471,13 @@ Constructor Detail * - | public :ref:`Builder ` ( | :ref:`User ` user, - | `String `__ partitionValue + | `String `__ partitionValue | ) - * - Creates an instance of the builder for a *SyncConfiguration* with the given user and partition value. + * - Creates an instance of the builder for a Partition-based Sync *SyncConfiguration* with the given user and partition value. @@ -401,7 +520,7 @@ Constructor Detail - * - Creates an instance of the builder for a *SyncConfiguration* with the given user and partition value. + * - Creates an instance of the builder for a Partition-based Sync *SyncConfiguration* with the given user and partition value. @@ -467,7 +586,7 @@ addModule :header-rows: 1 * - | public :ref:`SyncConfiguration.Builder ` :ref:`addModule ` ( - | `Object `__ module + | `Object `__ module | ) @@ -607,6 +726,91 @@ allowWritesOnUiThread +.. _assetFile: + +.. _assetFile__: + +.. _Builder_assetFile: + +.. _Builder_assetFile__: + +.. _SyncConfiguration_Builder_assetFile: + +.. _SyncConfiguration_Builder_assetFile__: + +.. _io_realm_mongodb_sync_SyncConfiguration_Builder_assetFile: + +.. _io_realm_mongodb_sync_SyncConfiguration_Builder_assetFile__: + + + +assetFile +--------- + +.. _io_realm_mongodb_sync_SyncConfiguration_Builder_assetFile_java_lang_String_: + +.. _io_realm_mongodb_sync_SyncConfiguration_Builder_assetFile_String_: + +.. _assetFile_java_lang_String_: + +.. _assetFile_String_: + +.. _SyncConfiguration_Builder_assetFile_java_lang_String_: + +.. _SyncConfiguration_Builder_assetFile_String_: + +.. list-table:: + :header-rows: 1 + + * - | public :ref:`SyncConfiguration.Builder ` :ref:`assetFile ` ( + | `String `__ assetFile + | ) + + + + + * - When opening the Realm for the first time, instead of creating an empty file, the Realm file will be copied from the provided asset file and used instead.This can be used to pre-populate the Realm with data, so it doesn't have to be downloaded from the server. + + The provided Realm file must be a valid synced Realm for the given user, and it must have been created using the **Realm.writeCopyTo(File)** API. + + + + WARNING: This could potentially be a lengthy operation and should ideally be done on a background thread. + + + + + + + **Parameters** + + - ``assetFile`` - path to the asset database file. + + + + + + + + + + **Throws** + + - `IllegalStateException `__ - if this Realm is also marked as :ref:`inMemory() ` . + + + + + + + + + + + + + + .. _build: .. _build__: @@ -655,7 +859,7 @@ build **Throws** - - `IllegalStateException `__ - if the configuration parameters are invalid or inconsistent. + - `IllegalStateException `__ - if the configuration parameters are invalid or inconsistent. @@ -899,7 +1103,7 @@ encryptionKey **Throws** - - `IllegalArgumentException `__ - if key is invalid. + - `IllegalArgumentException `__ - if key is invalid. @@ -984,7 +1188,7 @@ errorHandler **Throws** - - `IllegalArgumentException `__ - if ``null`` is given as an error handler. + - `IllegalArgumentException `__ - if ``null`` is given as an error handler. @@ -1191,6 +1395,83 @@ initialData +.. _initialSubscriptions: + +.. _initialSubscriptions__: + +.. _Builder_initialSubscriptions: + +.. _Builder_initialSubscriptions__: + +.. _SyncConfiguration_Builder_initialSubscriptions: + +.. _SyncConfiguration_Builder_initialSubscriptions__: + +.. _io_realm_mongodb_sync_SyncConfiguration_Builder_initialSubscriptions: + +.. _io_realm_mongodb_sync_SyncConfiguration_Builder_initialSubscriptions__: + + + +initialSubscriptions +-------------------- + +.. _io_realm_mongodb_sync_SyncConfiguration_Builder_initialSubscriptions_io_realm_mongodb_sync_SyncConfiguration_InitialFlexibleSyncSubscriptions_: + +.. _io_realm_mongodb_sync_SyncConfiguration_Builder_initialSubscriptions_InitialFlexibleSyncSubscriptions_: + +.. _io_realm_mongodb_sync_SyncConfiguration_Builder_initialSubscriptions_SyncConfiguration_InitialFlexibleSyncSubscriptions_: + +.. _initialSubscriptions_io_realm_mongodb_sync_SyncConfiguration_InitialFlexibleSyncSubscriptions_: + +.. _initialSubscriptions_InitialFlexibleSyncSubscriptions_: + +.. _initialSubscriptions_SyncConfiguration_InitialFlexibleSyncSubscriptions_: + +.. _SyncConfiguration_Builder_initialSubscriptions_io_realm_mongodb_sync_SyncConfiguration_InitialFlexibleSyncSubscriptions_: + +.. _SyncConfiguration_Builder_initialSubscriptions_InitialFlexibleSyncSubscriptions_: + +.. _SyncConfiguration_Builder_initialSubscriptions_SyncConfiguration_InitialFlexibleSyncSubscriptions_: + +.. list-table:: + :header-rows: 1 + + * - | public :ref:`SyncConfiguration.Builder ` :ref:`initialSubscriptions ` ( + | :ref:`SyncConfiguration.InitialFlexibleSyncSubscriptions ` action + | ) + + + + + * - Sets the initial :ref:`Subscription ` s for the :ref:`io.realm.Realm ` . This will only be executed the first time the Realm file is opened (and the file created). If :ref:`waitForInitialRemoteData() ` is configured as well, the realm file isn't fully opened until all subscription data also has been uploaded. + + + + + + + **Parameters** + + - ``action`` - :ref:`MutableSubscriptionSet ` where subscriptions can be added. + + + + + + + + + + + + + + + + + + .. _maxNumberOfActiveVersions: .. _maxNumberOfActiveVersions__: @@ -1228,7 +1509,7 @@ maxNumberOfActiveVersions - * - Sets the maximum number of live versions in the Realm file before an `IllegalStateException `__ is thrown when attempting to write more data. + * - Sets the maximum number of live versions in the Realm file before an `IllegalStateException `__ is thrown when attempting to write more data. Realm is capable of concurrently handling many different versions of Realm objects. This can happen if you have a Realm open on many different threads or are freezing objects while data is being written to the file. @@ -1261,7 +1542,7 @@ maxNumberOfActiveVersions - - `FAQ `__ + - `FAQ `__ @@ -1314,7 +1595,7 @@ modules :header-rows: 1 * - | public :ref:`SyncConfiguration.Builder ` :ref:`modules ` ( - | `java.lang.Iterable\ `__ modules + | `java.lang.Iterable\ `__ modules | ) @@ -1349,7 +1630,7 @@ modules **Throws** - - `IllegalArgumentException `__ - if any of the modules don't have the :ref:`RealmModule ` annotation. + - `IllegalArgumentException `__ - if any of the modules don't have the :ref:`RealmModule ` annotation. @@ -1452,8 +1733,8 @@ modules :header-rows: 1 * - | public :ref:`SyncConfiguration.Builder ` :ref:`modules ` ( - | `Object `__ baseModule, - | `java.lang.Object[] `__ additionalModules + | `Object `__ baseModule, + | `java.lang.Object[] `__ additionalModules | ) @@ -1492,7 +1773,7 @@ modules **Throws** - - `IllegalArgumentException `__ - if any of the modules don't have the :ref:`RealmModule ` annotation. + - `IllegalArgumentException `__ - if any of the modules don't have the :ref:`RealmModule ` annotation. @@ -1521,6 +1802,73 @@ modules +.. _name: + +.. _name__: + +.. _Builder_name: + +.. _Builder_name__: + +.. _SyncConfiguration_Builder_name: + +.. _SyncConfiguration_Builder_name__: + +.. _io_realm_mongodb_sync_SyncConfiguration_Builder_name: + +.. _io_realm_mongodb_sync_SyncConfiguration_Builder_name__: + + + +name +---- + +.. _io_realm_mongodb_sync_SyncConfiguration_Builder_name_java_lang_String_: + +.. _io_realm_mongodb_sync_SyncConfiguration_Builder_name_String_: + +.. _name_java_lang_String_: + +.. _name_String_: + +.. _SyncConfiguration_Builder_name_java_lang_String_: + +.. _SyncConfiguration_Builder_name_String_: + +.. list-table:: + :header-rows: 1 + + * - | public :ref:`SyncConfiguration.Builder ` :ref:`name ` ( + | `String `__ filename + | ) + + + + + * - Sets the filename for the Realm file on this device. + + + + + **Parameters** + + - ``filename`` - name for the Realm file. + + + + + + + + + + + + + + + + .. _readOnly: .. _readOnly__: @@ -1551,9 +1899,9 @@ readOnly - * - Setting this will cause the Realm to become read only and all write transactions made against this Realm will fail with an `IllegalStateException `__ . + * - Setting this will cause the Realm to become read only and all write transactions made against this Realm will fail with an `IllegalStateException `__ . - This in particular mean that :ref:`initialData(Realm.Transaction) ` will not work in combination with a read only Realm and setting this will result in a `IllegalStateException `__ being thrown. + This in particular mean that :ref:`initialData(Realm.Transaction) ` will not work in combination with a read only Realm and setting this will result in a `IllegalStateException `__ being thrown. @@ -1716,7 +2064,7 @@ schemaVersion **Throws** - - `IllegalArgumentException `__ - if schema version is invalid. + - `IllegalArgumentException `__ - if schema version is invalid. @@ -1729,6 +2077,119 @@ schemaVersion +.. _syncClientResetStrategy: + +.. _syncClientResetStrategy__: + +.. _Builder_syncClientResetStrategy: + +.. _Builder_syncClientResetStrategy__: + +.. _SyncConfiguration_Builder_syncClientResetStrategy: + +.. _SyncConfiguration_Builder_syncClientResetStrategy__: + +.. _io_realm_mongodb_sync_SyncConfiguration_Builder_syncClientResetStrategy: + +.. _io_realm_mongodb_sync_SyncConfiguration_Builder_syncClientResetStrategy__: + + + +syncClientResetStrategy +----------------------- + +.. _io_realm_mongodb_sync_SyncConfiguration_Builder_syncClientResetStrategy_io_realm_mongodb_sync_DiscardUnsyncedChangesStrategy_: + +.. _io_realm_mongodb_sync_SyncConfiguration_Builder_syncClientResetStrategy_DiscardUnsyncedChangesStrategy_: + +.. _syncClientResetStrategy_io_realm_mongodb_sync_DiscardUnsyncedChangesStrategy_: + +.. _syncClientResetStrategy_DiscardUnsyncedChangesStrategy_: + +.. _SyncConfiguration_Builder_syncClientResetStrategy_io_realm_mongodb_sync_DiscardUnsyncedChangesStrategy_: + +.. _SyncConfiguration_Builder_syncClientResetStrategy_DiscardUnsyncedChangesStrategy_: + +.. list-table:: + :header-rows: 1 + + * - | public :ref:`SyncConfiguration.Builder ` :ref:`syncClientResetStrategy ` ( + | :ref:`DiscardUnsyncedChangesStrategy ` handler + | ) + + + + + * - Sets the handler for when a Client Reset occurs. If no handler is set, and error is logged when a Client Reset occurs. This strategy is only available for synced realms using partition based sync. Realms using flexible sync currently only support :ref:`syncClientResetStrategy(ManuallyRecoverUnsyncedChangesStrategy) ` . + + + + + + + **Parameters** + + - ``handler`` - custom seamless loss handler in case of a Client Reset. + + + + + + + + + + + + + + +.. _io_realm_mongodb_sync_SyncConfiguration_Builder_syncClientResetStrategy_io_realm_mongodb_sync_ManuallyRecoverUnsyncedChangesStrategy_: + +.. _io_realm_mongodb_sync_SyncConfiguration_Builder_syncClientResetStrategy_ManuallyRecoverUnsyncedChangesStrategy_: + +.. _syncClientResetStrategy_io_realm_mongodb_sync_ManuallyRecoverUnsyncedChangesStrategy_: + +.. _syncClientResetStrategy_ManuallyRecoverUnsyncedChangesStrategy_: + +.. _SyncConfiguration_Builder_syncClientResetStrategy_io_realm_mongodb_sync_ManuallyRecoverUnsyncedChangesStrategy_: + +.. _SyncConfiguration_Builder_syncClientResetStrategy_ManuallyRecoverUnsyncedChangesStrategy_: + +.. list-table:: + :header-rows: 1 + + * - | public :ref:`SyncConfiguration.Builder ` :ref:`syncClientResetStrategy ` ( + | :ref:`ManuallyRecoverUnsyncedChangesStrategy ` handler + | ) + + + + + * - Sets the handler for when a Client Reset occurs. If no handler is set, and error is logged when a Client Reset occurs. + + + + + **Parameters** + + - ``handler`` - custom manual handler in case of a Client Reset. + + + + + + + + + + + + + + + + .. _urlPrefix: .. _urlPrefix__: @@ -1766,13 +2227,13 @@ urlPrefix :header-rows: 1 * - | public :ref:`SyncConfiguration.Builder ` :ref:`urlPrefix ` ( - | `String `__ urlPrefix + | `String `__ urlPrefix | ) - * - The prefix that is prepended to the path in the WebSocket request that initiates a sync connection to MongoDB Realm. The value specified must match the server's configuration otherwise the device will not be able to create a connection. This value is optional and should only be set if a specific firewall rule requires it. + * - The prefix that is prepended to the path in the WebSocket request that initiates a sync connection to MongoDB Realm. The value specified must match the server’s configuration otherwise the device will not be able to create a connection. This value is optional and should only be set if a specific firewall rule requires it. @@ -1792,21 +2253,6 @@ urlPrefix - - .. seealso:: - - - - - `Adding a custom proxy `__ - - - - - - - - - @@ -1861,7 +2307,7 @@ waitForInitialRemoteData * - | public :ref:`SyncConfiguration.Builder ` :ref:`waitForInitialRemoteData ` ( | **long** timeout, - | `TimeUnit `__ unit + | `TimeUnit `__ unit | ) diff --git a/source/sdk/java/api/io/realm/mongodb/sync/SyncConfiguration/InitialFlexibleSyncSubscriptions.txt b/source/sdk/java/api/io/realm/mongodb/sync/SyncConfiguration/InitialFlexibleSyncSubscriptions.txt new file mode 100644 index 0000000000..11aa52c3d6 --- /dev/null +++ b/source/sdk/java/api/io/realm/mongodb/sync/SyncConfiguration/InitialFlexibleSyncSubscriptions.txt @@ -0,0 +1,168 @@ + +.. contents:: On this page + :local: + :backlinks: none + :depth: 2 + :class: singlecol + + + +Interface SyncConfiguration.InitialFlexibleSyncSubscriptions +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. _io_realm_mongodb_sync_SyncConfiguration_InitialFlexibleSyncSubscriptions: + + + +io.realm.mongodb.sync +===================== + + + +**Enclosing class:** + +:ref:`SyncConfiguration ` + + + +Interface for configuring the initial set of of subscriptions. This should only be used for synced realms configured for flexible sync. + + +.. seealso:: + + + + - :ref:`Builder.initialSubscriptions(SyncConfiguration.InitialFlexibleSyncSubscriptions) ` + + + + + + + + + +Method Summary +============== + +.. list-table:: + :header-rows: 1 + + * - Modifier and Type + - Method and Description + + * - public **void** + - | :ref:`configure ` ( + | :ref:`Realm ` realm, + | :ref:`MutableSubscriptionSet ` subscriptions + | ) + + + + + + + + + + +Method Detail +============= + +.. _configure: + +.. _configure__: + +.. _InitialFlexibleSyncSubscriptions_configure: + +.. _InitialFlexibleSyncSubscriptions_configure__: + +.. _SyncConfiguration_InitialFlexibleSyncSubscriptions_configure: + +.. _SyncConfiguration_InitialFlexibleSyncSubscriptions_configure__: + +.. _io_realm_mongodb_sync_SyncConfiguration_InitialFlexibleSyncSubscriptions_configure: + +.. _io_realm_mongodb_sync_SyncConfiguration_InitialFlexibleSyncSubscriptions_configure__: + + + +configure +--------- + +.. _io_realm_mongodb_sync_SyncConfiguration_InitialFlexibleSyncSubscriptions_configure_io_realm_Realm_io_realm_mongodb_sync_MutableSubscriptionSet_: + +.. _io_realm_mongodb_sync_SyncConfiguration_InitialFlexibleSyncSubscriptions_configure_io_realm_Realm__io_realm_mongodb_sync_MutableSubscriptionSet_: + +.. _io_realm_mongodb_sync_SyncConfiguration_InitialFlexibleSyncSubscriptions_configure_io_realm_Realm_MutableSubscriptionSet_: + +.. _io_realm_mongodb_sync_SyncConfiguration_InitialFlexibleSyncSubscriptions_configure_io_realm_Realm__MutableSubscriptionSet_: + +.. _io_realm_mongodb_sync_SyncConfiguration_InitialFlexibleSyncSubscriptions_configure_Realm_io_realm_mongodb_sync_MutableSubscriptionSet_: + +.. _io_realm_mongodb_sync_SyncConfiguration_InitialFlexibleSyncSubscriptions_configure_Realm__io_realm_mongodb_sync_MutableSubscriptionSet_: + +.. _io_realm_mongodb_sync_SyncConfiguration_InitialFlexibleSyncSubscriptions_configure_Realm_MutableSubscriptionSet_: + +.. _io_realm_mongodb_sync_SyncConfiguration_InitialFlexibleSyncSubscriptions_configure_Realm__MutableSubscriptionSet_: + +.. _configure_io_realm_Realm_io_realm_mongodb_sync_MutableSubscriptionSet_: + +.. _configure_io_realm_Realm__io_realm_mongodb_sync_MutableSubscriptionSet_: + +.. _configure_io_realm_Realm_MutableSubscriptionSet_: + +.. _configure_io_realm_Realm__MutableSubscriptionSet_: + +.. _configure_Realm_io_realm_mongodb_sync_MutableSubscriptionSet_: + +.. _configure_Realm__io_realm_mongodb_sync_MutableSubscriptionSet_: + +.. _configure_Realm_MutableSubscriptionSet_: + +.. _configure_Realm__MutableSubscriptionSet_: + +.. _SyncConfiguration_InitialFlexibleSyncSubscriptions_configure_io_realm_Realm_io_realm_mongodb_sync_MutableSubscriptionSet_: + +.. _SyncConfiguration_InitialFlexibleSyncSubscriptions_configure_io_realm_Realm__io_realm_mongodb_sync_MutableSubscriptionSet_: + +.. _SyncConfiguration_InitialFlexibleSyncSubscriptions_configure_io_realm_Realm_MutableSubscriptionSet_: + +.. _SyncConfiguration_InitialFlexibleSyncSubscriptions_configure_io_realm_Realm__MutableSubscriptionSet_: + +.. _SyncConfiguration_InitialFlexibleSyncSubscriptions_configure_Realm_io_realm_mongodb_sync_MutableSubscriptionSet_: + +.. _SyncConfiguration_InitialFlexibleSyncSubscriptions_configure_Realm__io_realm_mongodb_sync_MutableSubscriptionSet_: + +.. _SyncConfiguration_InitialFlexibleSyncSubscriptions_configure_Realm_MutableSubscriptionSet_: + +.. _SyncConfiguration_InitialFlexibleSyncSubscriptions_configure_Realm__MutableSubscriptionSet_: + +.. list-table:: + :header-rows: 1 + + * - | public **void** :ref:`configure ` ( + | :ref:`Realm ` realm, + | :ref:`MutableSubscriptionSet ` subscriptions + | ) + + + + + * - + + + + + + + + + + + + + + + + diff --git a/source/sdk/java/api/io/realm/mongodb/sync/SyncSession.txt b/source/sdk/java/api/io/realm/mongodb/sync/SyncSession.txt index 61fc60c891..b1df900f3d 100644 --- a/source/sdk/java/api/io/realm/mongodb/sync/SyncSession.txt +++ b/source/sdk/java/api/io/realm/mongodb/sync/SyncSession.txt @@ -18,7 +18,7 @@ io.realm.mongodb.sync ===================== - | `java.lang.Object `__ + | `java.lang.Object `__ | io.realm.mongodb.sync.SyncSession @@ -116,7 +116,7 @@ Method Summary * - public **boolean** - | :ref:`downloadAllServerChanges ` ( | **long** timeout, - | `TimeUnit `__ unit + | `TimeUnit `__ unit | ) @@ -159,12 +159,12 @@ Method Summary - * - public `URI `__ + * - public `URI `__ - | :ref:`getServerUrl ` () | - Returns the `URI `__ describing the remote Realm which this session connects to and synchronizes changes with. + Returns the `URI `__ describing the remote Realm which this session connects to and synchronizes changes with. @@ -252,7 +252,7 @@ Method Summary * - public **boolean** - | :ref:`uploadAllLocalChanges ` ( | **long** timeout, - | `TimeUnit `__ unit + | `TimeUnit `__ unit | ) @@ -279,7 +279,7 @@ Inherited Methods -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` +- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` @@ -347,7 +347,7 @@ addConnectionChangeListener **Throws** - - `IllegalArgumentException `__ - if the listener is ``null`` . + - `IllegalArgumentException `__ - if the listener is ``null`` . @@ -642,7 +642,7 @@ downloadAllServerChanges * - | public **boolean** :ref:`downloadAllServerChanges ` ( | **long** timeout, - | `TimeUnit `__ unit + | `TimeUnit `__ unit | ) @@ -668,15 +668,15 @@ downloadAllServerChanges **Throws** - - `IllegalStateException `__ - if called on the Android main thread. + - `IllegalStateException `__ - if called on the Android main thread. - - `InterruptedException `__ - if the download took longer than the specified timeout or the thread was interrupted while downloading was in progress. The download will continue in the background even after this exception is thrown. + - `InterruptedException `__ - if the download took longer than the specified timeout or the thread was interrupted while downloading was in progress. The download will continue in the background even after this exception is thrown. - - `IllegalArgumentException `__ - if ``timeout`` is less than or equal to ``0`` or ``unit`` is ``null`` . + - `IllegalArgumentException `__ - if ``timeout`` is less than or equal to ``0`` or ``unit`` is ``null`` . @@ -713,11 +713,11 @@ downloadAllServerChanges **Throws** - - `IllegalStateException `__ - if called on the Android main thread. + - `IllegalStateException `__ - if called on the Android main thread. - - `InterruptedException `__ - if the thread was interrupted while downloading was in progress. + - `InterruptedException `__ - if the thread was interrupted while downloading was in progress. @@ -862,13 +862,13 @@ getServerUrl .. list-table:: :header-rows: 1 - * - | public `URI `__ :ref:`getServerUrl ` () + * - | public `URI `__ :ref:`getServerUrl ` () | - * - Returns the `URI `__ describing the remote Realm which this session connects to and synchronizes changes with. + * - Returns the `URI `__ describing the remote Realm which this session connects to and synchronizes changes with. @@ -879,7 +879,7 @@ getServerUrl **Returns** - `URI `__ describing the remote Realm. + `URI `__ describing the remote Realm. @@ -1120,7 +1120,7 @@ removeConnectionChangeListener **Throws** - - `IllegalArgumentException `__ - if the listener is ``null`` . + - `IllegalArgumentException `__ - if the listener is ``null`` . @@ -1362,7 +1362,7 @@ uploadAllLocalChanges * - | public **boolean** :ref:`uploadAllLocalChanges ` ( | **long** timeout, - | `TimeUnit `__ unit + | `TimeUnit `__ unit | ) @@ -1388,15 +1388,15 @@ uploadAllLocalChanges **Throws** - - `IllegalStateException `__ - if called on the Android main thread. + - `IllegalStateException `__ - if called on the Android main thread. - - `InterruptedException `__ - if the upload took longer than the specified timeout or the thread was interrupted while uploading was in progress. The upload will continue in the background even after this exception is thrown. + - `InterruptedException `__ - if the upload took longer than the specified timeout or the thread was interrupted while uploading was in progress. The upload will continue in the background even after this exception is thrown. - - `IllegalArgumentException `__ - if ``timeout`` is less than or equal to ``0`` or ``unit`` is ``null`` . + - `IllegalArgumentException `__ - if ``timeout`` is less than or equal to ``0`` or ``unit`` is ``null`` . @@ -1433,11 +1433,11 @@ uploadAllLocalChanges **Throws** - - `IllegalStateException `__ - if called on the Android main thread. + - `IllegalStateException `__ - if called on the Android main thread. - - `InterruptedException `__ - if the thread was interrupted while downloading was in progress. + - `InterruptedException `__ - if the thread was interrupted while downloading was in progress. diff --git a/source/sdk/java/api/io/realm/mongodb/sync/SyncSession/ClientResetHandler.txt b/source/sdk/java/api/io/realm/mongodb/sync/SyncSession/ClientResetHandler.txt index 59b53c2971..b3ba88702b 100644 --- a/source/sdk/java/api/io/realm/mongodb/sync/SyncSession/ClientResetHandler.txt +++ b/source/sdk/java/api/io/realm/mongodb/sync/SyncSession/ClientResetHandler.txt @@ -17,6 +17,14 @@ Interface SyncSession.ClientResetHandler io.realm.mongodb.sync ===================== +**Implemented interfaces:** + + + +- :ref:`io.realm.mongodb.sync.ManuallyRecoverUnsyncedChangesStrategy ` +- :ref:`io.realm.mongodb.sync.SyncClientResetStrategy ` + + **Enclosing class:** @@ -52,143 +60,7 @@ The client reset process can be initiated in one of two ways: **WARNING:** Any writes to the Realm file between this callback and Client Reset has been executed, will not be synchronized to MongoDB Realm. Those changes will only be present in the backed up file. It is therefore recommended to close all open Realm instances as soon as possible. -Method Summary -============== - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Method and Description - - * - public **void** - - | :ref:`onClientReset ` ( - | :ref:`SyncSession ` session, - | :ref:`ClientResetRequiredError ` error - | ) - - - Callback that indicates a Client Reset has happened. - - - - - - - -Method Detail -============= - -.. _onClientReset: - -.. _onClientReset__: - -.. _ClientResetHandler_onClientReset: - -.. _ClientResetHandler_onClientReset__: - -.. _SyncSession_ClientResetHandler_onClientReset: - -.. _SyncSession_ClientResetHandler_onClientReset__: - -.. _io_realm_mongodb_sync_SyncSession_ClientResetHandler_onClientReset: - -.. _io_realm_mongodb_sync_SyncSession_ClientResetHandler_onClientReset__: - - - -onClientReset -------------- - -.. _io_realm_mongodb_sync_SyncSession_ClientResetHandler_onClientReset_io_realm_mongodb_sync_SyncSession_io_realm_mongodb_sync_ClientResetRequiredError_: - -.. _io_realm_mongodb_sync_SyncSession_ClientResetHandler_onClientReset_io_realm_mongodb_sync_SyncSession__io_realm_mongodb_sync_ClientResetRequiredError_: - -.. _io_realm_mongodb_sync_SyncSession_ClientResetHandler_onClientReset_io_realm_mongodb_sync_SyncSession_ClientResetRequiredError_: - -.. _io_realm_mongodb_sync_SyncSession_ClientResetHandler_onClientReset_io_realm_mongodb_sync_SyncSession__ClientResetRequiredError_: - -.. _io_realm_mongodb_sync_SyncSession_ClientResetHandler_onClientReset_SyncSession_io_realm_mongodb_sync_ClientResetRequiredError_: - -.. _io_realm_mongodb_sync_SyncSession_ClientResetHandler_onClientReset_SyncSession__io_realm_mongodb_sync_ClientResetRequiredError_: - -.. _io_realm_mongodb_sync_SyncSession_ClientResetHandler_onClientReset_SyncSession_ClientResetRequiredError_: - -.. _io_realm_mongodb_sync_SyncSession_ClientResetHandler_onClientReset_SyncSession__ClientResetRequiredError_: - -.. _onClientReset_io_realm_mongodb_sync_SyncSession_io_realm_mongodb_sync_ClientResetRequiredError_: - -.. _onClientReset_io_realm_mongodb_sync_SyncSession__io_realm_mongodb_sync_ClientResetRequiredError_: - -.. _onClientReset_io_realm_mongodb_sync_SyncSession_ClientResetRequiredError_: - -.. _onClientReset_io_realm_mongodb_sync_SyncSession__ClientResetRequiredError_: - -.. _onClientReset_SyncSession_io_realm_mongodb_sync_ClientResetRequiredError_: - -.. _onClientReset_SyncSession__io_realm_mongodb_sync_ClientResetRequiredError_: - -.. _onClientReset_SyncSession_ClientResetRequiredError_: - -.. _onClientReset_SyncSession__ClientResetRequiredError_: - -.. _SyncSession_ClientResetHandler_onClientReset_io_realm_mongodb_sync_SyncSession_io_realm_mongodb_sync_ClientResetRequiredError_: - -.. _SyncSession_ClientResetHandler_onClientReset_io_realm_mongodb_sync_SyncSession__io_realm_mongodb_sync_ClientResetRequiredError_: - -.. _SyncSession_ClientResetHandler_onClientReset_io_realm_mongodb_sync_SyncSession_ClientResetRequiredError_: - -.. _SyncSession_ClientResetHandler_onClientReset_io_realm_mongodb_sync_SyncSession__ClientResetRequiredError_: - -.. _SyncSession_ClientResetHandler_onClientReset_SyncSession_io_realm_mongodb_sync_ClientResetRequiredError_: - -.. _SyncSession_ClientResetHandler_onClientReset_SyncSession__io_realm_mongodb_sync_ClientResetRequiredError_: - -.. _SyncSession_ClientResetHandler_onClientReset_SyncSession_ClientResetRequiredError_: - -.. _SyncSession_ClientResetHandler_onClientReset_SyncSession__ClientResetRequiredError_: - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`onClientReset ` ( - | :ref:`SyncSession ` session, - | :ref:`ClientResetRequiredError ` error - | ) - - - - - * - Callback that indicates a Client Reset has happened. This should be handled as quickly as possible as any further changes to the Realm will not be synchronized with the server and must be moved manually from the backup Realm to the new one. - - - - - **Parameters** - - - ``session`` - :ref:`SyncSession ` this error happened on. - - - - - - - ``error`` - :ref:`ClientResetRequiredError ` the specific Client Reset error. - - - - - - - - - - - - - - - - - +Inherited Methods +================= diff --git a/source/sdk/java/api/io/realm/mongodb/sync/SyncSession/State.txt b/source/sdk/java/api/io/realm/mongodb/sync/SyncSession/State.txt index 52d07a4b66..c8b08e14d7 100644 --- a/source/sdk/java/api/io/realm/mongodb/sync/SyncSession/State.txt +++ b/source/sdk/java/api/io/realm/mongodb/sync/SyncSession/State.txt @@ -18,8 +18,8 @@ io.realm.mongodb.sync ===================== - | `java.lang.Object `__ - | `java.lang.Enum `__ + | `java.lang.Object `__ + | `java.lang.Enum `__ | io.realm.mongodb.sync.SyncSession.State @@ -71,6 +71,13 @@ Enum Constant Summary + * - :ref:`WAITING_FOR_ACCESS_TOKEN ` + + The user is attempting to synchronize data but needs a valid access token to do so. + + + + @@ -85,7 +92,7 @@ Method Summary * - public static :ref:`SyncSession.State ` - | :ref:`valueOf ` ( - | `String `__ name + | `String `__ name | ) @@ -112,8 +119,8 @@ Inherited Methods -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` -- Methods inherited from class `java.lang.Enum `__ : ``name`` , ``ordinal`` , ``toString`` , ``equals`` , ``hashCode`` , ``clone`` , ``compareTo`` , ``getDeclaringClass`` , ``valueOf`` , ``finalize`` +- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` +- Methods inherited from class `java.lang.Enum `__ : ``name`` , ``ordinal`` , ``toString`` , ``equals`` , ``hashCode`` , ``clone`` , ``compareTo`` , ``getDeclaringClass`` , ``valueOf`` , ``finalize`` @@ -177,6 +184,27 @@ This is the initial state. The session is closed. No data is being synchronized. +.. _io_realm_mongodb_sync_SyncSession_State_WAITING_FOR_ACCESS_TOKEN: + +.. _SyncSession_State_WAITING_FOR_ACCESS_TOKEN: + + + +``WAITING_FOR_ACCESS_TOKEN`` +----------------------------- + +public static final :ref:`SyncSession.State ` + +The user is attempting to synchronize data but needs a valid access token to do so. Realm will either use a cached token or automatically try to acquire one based on the current users login. This requires a network connection.Data cannot be synchronized in this state. + +Once a valid token is acquired, the session will transition to :ref:`ACTIVE ` . + + + + + + + Method Detail ============= @@ -218,7 +246,7 @@ valueOf :header-rows: 1 * - | public static :ref:`SyncSession.State ` :ref:`valueOf ` ( - | `String `__ name + | `String `__ name | ) diff --git a/source/sdk/java/api/io/realm/rx/CollectionChange.txt b/source/sdk/java/api/io/realm/rx/CollectionChange.txt index 7a794e2b00..9be6d6b05a 100644 --- a/source/sdk/java/api/io/realm/rx/CollectionChange.txt +++ b/source/sdk/java/api/io/realm/rx/CollectionChange.txt @@ -18,7 +18,7 @@ io.realm.rx =========== - | `java.lang.Object `__ + | `java.lang.Object `__ | io.realm.rx.CollectionChange @@ -64,7 +64,7 @@ Method Summary * - public **boolean** - | :ref:`equals ` ( - | `Object `__ o + | `Object `__ o | ) @@ -111,7 +111,7 @@ Inherited Methods -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` +- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` @@ -200,7 +200,7 @@ equals :header-rows: 1 * - | public **boolean** :ref:`equals ` ( - | `Object `__ o + | `Object `__ o | ) @@ -219,7 +219,7 @@ equals **Overrides** - ``equals`` in class `Object `__ + ``equals`` in class `Object `__ @@ -381,7 +381,7 @@ hashCode **Overrides** - ``hashCode`` in class `Object `__ + ``hashCode`` in class `Object `__ diff --git a/source/sdk/java/api/io/realm/rx/ObjectChange.txt b/source/sdk/java/api/io/realm/rx/ObjectChange.txt index 50e55f0192..82dc98ad5f 100644 --- a/source/sdk/java/api/io/realm/rx/ObjectChange.txt +++ b/source/sdk/java/api/io/realm/rx/ObjectChange.txt @@ -18,7 +18,7 @@ io.realm.rx =========== - | `java.lang.Object `__ + | `java.lang.Object `__ | io.realm.rx.ObjectChange @@ -64,7 +64,7 @@ Method Summary * - public **boolean** - | :ref:`equals ` ( - | `Object `__ o + | `Object `__ o | ) @@ -103,7 +103,7 @@ Method Summary - * - public `String `__ + * - public `String `__ - | :ref:`toString ` () | @@ -121,7 +121,7 @@ Inherited Methods -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` +- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` @@ -210,7 +210,7 @@ equals :header-rows: 1 * - | public **boolean** :ref:`equals ` ( - | `Object `__ o + | `Object `__ o | ) @@ -229,7 +229,7 @@ equals **Overrides** - ``equals`` in class `Object `__ + ``equals`` in class `Object `__ @@ -386,7 +386,7 @@ hashCode **Overrides** - ``hashCode`` in class `Object `__ + ``hashCode`` in class `Object `__ @@ -413,7 +413,7 @@ toString .. list-table:: :header-rows: 1 - * - | public `String `__ :ref:`toString ` () + * - | public `String `__ :ref:`toString ` () | @@ -432,7 +432,7 @@ toString **Overrides** - ``toString`` in class `Object `__ + ``toString`` in class `Object `__ diff --git a/source/sdk/java/api/io/realm/rx/RealmObservableFactory.txt b/source/sdk/java/api/io/realm/rx/RealmObservableFactory.txt index b262a75777..e94c95bf79 100644 --- a/source/sdk/java/api/io/realm/rx/RealmObservableFactory.txt +++ b/source/sdk/java/api/io/realm/rx/RealmObservableFactory.txt @@ -18,7 +18,7 @@ io.realm.rx =========== - | `java.lang.Object `__ + | `java.lang.Object `__ | io.realm.rx.RealmObservableFactory @@ -178,7 +178,7 @@ Method Summary * - public **boolean** - | :ref:`equals ` ( - | `Object `__ o + | `Object `__ o | ) @@ -343,7 +343,7 @@ Inherited Methods -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` +- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` @@ -938,7 +938,7 @@ equals :header-rows: 1 * - | public **boolean** :ref:`equals ` ( - | `Object `__ o + | `Object `__ o | ) @@ -957,7 +957,7 @@ equals **Overrides** - ``equals`` in class `Object `__ + ``equals`` in class `Object `__ @@ -1758,7 +1758,7 @@ hashCode **Overrides** - ``hashCode`` in class `Object `__ + ``hashCode`` in class `Object `__ diff --git a/source/sdk/java/api/io/realm/transformer.txt b/source/sdk/java/api/io/realm/transformer.txt new file mode 100644 index 0000000000..ddc64b86fb --- /dev/null +++ b/source/sdk/java/api/io/realm/transformer.txt @@ -0,0 +1,27 @@ + +.. contents:: On this page + :local: + :backlinks: none + :depth: 2 + :class: singlecol + + + +io.realm.transformer +^^^^^^^^^^^^^^^^^^^^ + +.. toctree:: + :titlesonly: + :hidden: + + + Utils + + + +| + +- :ref:`io.realm.transformer.Utils ` + + + diff --git a/source/sdk/java/api/io/realm/transformer/Utils.txt b/source/sdk/java/api/io/realm/transformer/Utils.txt new file mode 100644 index 0000000000..f8a649f4a4 --- /dev/null +++ b/source/sdk/java/api/io/realm/transformer/Utils.txt @@ -0,0 +1,424 @@ + +.. contents:: On this page + :local: + :backlinks: none + :depth: 2 + :class: singlecol + + + +Class Utils +^^^^^^^^^^^ + +.. _io_realm_transformer_Utils: + + + +io.realm.transformer +==================== + + + | `java.lang.Object `__ + | io.realm.transformer.Utils + + + + + +Constructors +============ + +.. list-table:: + :header-rows: 1 + + * - Constructor and Description + + * - | :ref:`Utils ` () + | + + + + + + + + + + +Method Summary +============== + +.. list-table:: + :header-rows: 1 + + * - Modifier and Type + - Method and Description + + * - public static `String `__ + - | :ref:`base64Encode ` ( + | `String `__ data + | ) + + + Encode the given string with Base64 + + + + + * - public static `String `__ + - | :ref:`hexStringify ` ( + | **byte[]** data + | ) + + + Convert a byte array to its hex-string + + + + + * - public static **boolean** + - | :ref:`isSyncEnabled ` ( + | **Project** project + | ) + + + + + + + + * - public static **byte** + - | :ref:`sha256Hash ` ( + | **byte[]** data + | ) + + + Compute the SHA-256 hash of the given byte array + + + + + + + +Inherited Methods +================= + + + +- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` + + + + +Constructor Detail +================== + +.. _Utils: + +.. _Utils__: + +.. _io_realm_transformer_Utils: + +.. _io_realm_transformer_Utils__: + +.. list-table:: + :header-rows: 1 + + * - | public :ref:`Utils ` () + | + + + + + * - + + + + + + + + + + + + + +Method Detail +============= + +.. _base64Encode: + +.. _base64Encode__: + +.. _Utils_base64Encode: + +.. _Utils_base64Encode__: + +.. _io_realm_transformer_Utils_base64Encode: + +.. _io_realm_transformer_Utils_base64Encode__: + + + +base64Encode +------------ + +.. _io_realm_transformer_Utils_base64Encode_java_lang_String_: + +.. _io_realm_transformer_Utils_base64Encode_String_: + +.. _base64Encode_java_lang_String_: + +.. _base64Encode_String_: + +.. _Utils_base64Encode_java_lang_String_: + +.. _Utils_base64Encode_String_: + +.. list-table:: + :header-rows: 1 + + * - | public static `String `__ :ref:`base64Encode ` ( + | `String `__ data + | ) + + + + + * - Encode the given string with Base64 + + + + + **Parameters** + + - ``data`` - the string to encode + + + + + + + + **Returns** + + the encoded string + + + + + **Throws** + + - `UnsupportedEncodingException `__ - + + + + + + + + + + + + +.. _hexStringify: + +.. _hexStringify__: + +.. _Utils_hexStringify: + +.. _Utils_hexStringify__: + +.. _io_realm_transformer_Utils_hexStringify: + +.. _io_realm_transformer_Utils_hexStringify__: + + + +hexStringify +------------ + +.. _io_realm_transformer_Utils_hexStringify_byte_: + +.. _io_realm_transformer_Utils_hexStringify_byte____: + +.. _hexStringify_byte_: + +.. _hexStringify_byte____: + +.. _Utils_hexStringify_byte_: + +.. _Utils_hexStringify_byte____: + +.. _io_realm_transformer_Utils_hexStringify_byte[]_: + +.. list-table:: + :header-rows: 1 + + * - | public static `String `__ :ref:`hexStringify ` ( + | **byte[]** data + | ) + + + + + * - Convert a byte array to its hex-string + + + + + **Parameters** + + - ``data`` - the byte array to convert + + + + + + + + **Returns** + + the hex-string of the byte array + + + + + + + + + + + +.. _isSyncEnabled: + +.. _isSyncEnabled__: + +.. _Utils_isSyncEnabled: + +.. _Utils_isSyncEnabled__: + +.. _io_realm_transformer_Utils_isSyncEnabled: + +.. _io_realm_transformer_Utils_isSyncEnabled__: + + + +isSyncEnabled +------------- + +.. _io_realm_transformer_Utils_isSyncEnabled_Project_: + +.. _isSyncEnabled_Project_: + +.. _Utils_isSyncEnabled_Project_: + +.. list-table:: + :header-rows: 1 + + * - | public static **boolean** :ref:`isSyncEnabled ` ( + | **Project** project + | ) + + + + + * - + + + + + + + + + + + + + + + +.. _sha256Hash: + +.. _sha256Hash__: + +.. _Utils_sha256Hash: + +.. _Utils_sha256Hash__: + +.. _io_realm_transformer_Utils_sha256Hash: + +.. _io_realm_transformer_Utils_sha256Hash__: + + + +sha256Hash +---------- + +.. _io_realm_transformer_Utils_sha256Hash_byte_: + +.. _io_realm_transformer_Utils_sha256Hash_byte____: + +.. _sha256Hash_byte_: + +.. _sha256Hash_byte____: + +.. _Utils_sha256Hash_byte_: + +.. _Utils_sha256Hash_byte____: + +.. _io_realm_transformer_Utils_sha256Hash_byte[]_: + +.. list-table:: + :header-rows: 1 + + * - | public static **byte** :ref:`sha256Hash ` ( + | **byte[]** data + | ) + + + + + * - Compute the SHA-256 hash of the given byte array + + + + + **Parameters** + + - ``data`` - the byte array to hash + + + + + + + + **Returns** + + the hashed byte array + + + + + **Throws** + + - `NoSuchAlgorithmException `__ - + + + + + + + + + + + + +