Skip to content

Commit 4dceedc

Browse files
authored
Revert "remove java api" (#3379)
Reverts #3378
1 parent 2a868af commit 4dceedc

File tree

247 files changed

+148767
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

247 files changed

+148767
-0
lines changed

source/sdk/cpp/facets.toml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
.. meta::
2+
:robots: noindex, nosnippet
3+
14
[[facets]]
25
category = "programming_language"
36
value = "cpp"

source/sdk/dotnet/facets.toml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
.. meta::
2+
:robots: noindex, nosnippet
3+
14
[[facets]]
25
category = "programming_language"
36
value = "csharp"

source/sdk/flutter/facets.toml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
.. meta::
2+
:robots: noindex, nosnippet
3+
14
[[facets]]
25
category = "programming_language"
36
value = "dart"

source/sdk/java/adapters.txt

Lines changed: 178 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,178 @@
1+
.. meta::
2+
:robots: noindex, nosnippet
3+
4+
.. _java-adapters:
5+
6+
==============================
7+
Display Collections - Java SDK
8+
==============================
9+
10+
.. contents:: On this page
11+
:local:
12+
:backlinks: none
13+
:depth: 2
14+
:class: singlecol
15+
16+
Android apps often populate the UI using
17+
:android:`RecyclerView <reference/androidx/recyclerview/widget/RecyclerView.html>`
18+
or :android:`ListView <reference/android/widget/ListView>` components.
19+
Realm offers **adapters** to display realm object
20+
:ref:`collections <java-client-collections>`. These collections implement
21+
the ``OrderedRealmCollections`` interface. :ref:`RealmResults <java-results-collections>`
22+
and :ref:`RealmList <java-list-collections>` are examples of these adaptors.
23+
With these adapters, UI components update when your app changes
24+
Realm objects.
25+
26+
Install Adapters
27+
----------------
28+
29+
Add these dependencies to your application level ``build.gradle`` file:
30+
31+
.. code-block:: gradle
32+
:copyable: false
33+
34+
dependencies {
35+
implementation 'io.realm:android-adapters:4.0.0'
36+
implementation 'androidx.recyclerview:recyclerview:1.1.0'
37+
}
38+
39+
Realm hosts these adapters on the
40+
`JCenter <https://mvnrepository.com/repos/jcenter>`_
41+
artifact repository. To use ``jcenter`` in your Android app, add it to your
42+
project-level ``build.gradle`` file:
43+
44+
.. code-block:: gradle
45+
:emphasize-lines: 3, 9
46+
:copyable: false
47+
48+
buildscript {
49+
repositories {
50+
jcenter()
51+
}
52+
}
53+
54+
allprojects {
55+
repositories {
56+
jcenter()
57+
}
58+
}
59+
60+
.. seealso::
61+
62+
Source code: :github:`realm/realm-android-adapters` on GitHub.
63+
64+
.. _java-adapters-model-item:
65+
66+
Example Models
67+
--------------
68+
69+
The examples on this page use a Realm object named ``Item``.
70+
This class contains a string named "name" and an identifier number named
71+
"id":
72+
73+
.. tabs-realm-languages::
74+
75+
.. tab::
76+
:tabid: java
77+
78+
.. literalinclude:: /examples/generated/java/local/JavaItem.snippet.complete.java
79+
:language: java
80+
:copyable: false
81+
82+
.. tab::
83+
:tabid: kotlin
84+
85+
.. literalinclude:: /examples/generated/java/local/Item.snippet.complete.kt
86+
:language: kotlin
87+
:copyable: false
88+
89+
.. _java-adapters-listview:
90+
91+
Display Collections in a ListView
92+
---------------------------------
93+
94+
Display Realm objects in a
95+
:android:`ListView <reference/android/widget/ListView>` by extending
96+
:github:`RealmBaseAdapter
97+
<realm/realm-android-adapters/blob/master/adapters/src/main/java/io/realm/RealmBaseAdapter.java>`.
98+
The adapter uses the ``ListAdapter`` interface. Implementation works
99+
like any ``ListAdapter``. This provides support for automatically-updating
100+
Realm objects.
101+
102+
Subclass ``RealmBaseAdapter`` to display
103+
:ref:`Item <java-adapters-model-item>` objects in a ``ListView``:
104+
105+
.. tabs-realm-languages::
106+
107+
.. tab::
108+
:tabid: java
109+
110+
.. literalinclude:: /examples/generated/java/local/ExampleListAdapter.snippet.complete.java
111+
:language: java
112+
:copyable: false
113+
114+
To display list data in an activity, instantiate a ``ListView``. Then,
115+
attach an ``ExampleListAdapter``:
116+
117+
.. literalinclude:: /examples/generated/java/local/AdapterTest.snippet.list-adapter.java
118+
:language: java
119+
:copyable: false
120+
121+
.. tab::
122+
:tabid: kotlin
123+
124+
.. literalinclude:: /examples/generated/java/local/ExampleListAdapter.snippet.complete.kt
125+
:language: kotlin
126+
127+
To display list data in an activity, instantiate a ``ListView``. Then,
128+
attach an ``ExampleListAdapter``:
129+
130+
.. literalinclude:: /examples/generated/java/local/AdapterTest.snippet.list-adapter.kt
131+
:language: kotlin
132+
:copyable: false
133+
134+
.. _java-adapters-recyclerview:
135+
136+
Display Collections in a RecyclerView
137+
-------------------------------------
138+
139+
Display Realm objects in a
140+
:android:`RecyclerView <reference/androidx/recyclerview/widget/RecyclerView.html>`
141+
by extending :github:`RealmRecyclerViewAdapter
142+
<realm/realm-android-adapters/blob/master/adapters/src/main/java/io/realm/RealmRecyclerViewAdapter.java>`.
143+
The adapter extends ``RecyclerView.Adapter``. Implementation works like any
144+
``RecyclerView`` adapter. This provides support
145+
for automatically-updating Realm objects.
146+
147+
Subclass ``RealmRecyclerViewAdapter`` to display
148+
:ref:`Item <java-adapters-model-item>` objects in a ``RecyclerView``:
149+
150+
.. tabs-realm-languages::
151+
152+
.. tab::
153+
:tabid: java
154+
155+
.. literalinclude:: /examples/generated/java/local/ExampleRecyclerViewAdapter.snippet.complete.java
156+
:language: java
157+
:copyable: false
158+
159+
To display list data in an activity, instantiate a ``RecyclerView``. Then,
160+
attach an ``ExampleRecyclerViewAdapter``:
161+
162+
.. literalinclude:: /examples/generated/java/local/AdapterTest.snippet.recycler-view-adapter.java
163+
:language: java
164+
:copyable: false
165+
166+
.. tab::
167+
:tabid: kotlin
168+
169+
.. literalinclude:: /examples/generated/java/local/ExampleRecyclerViewAdapter.snippet.complete.kt
170+
:language: kotlin
171+
:copyable: false
172+
173+
To display list data in an activity, instantiate a ``RecyclerView``. Then,
174+
attach an ``ExampleRecyclerViewAdapter``:
175+
176+
.. literalinclude:: /examples/generated/java/local/AdapterTest.snippet.recycler-view-adapter.kt
177+
:language: kotlin
178+
:copyable: false

source/sdk/java/api.txt

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
.. meta::
2+
:robots: noindex, nosnippet
3+
4+
=============
5+
API Reference
6+
=============
7+
8+
.. contents:: On this page
9+
:local:
10+
:backlinks: none
11+
:depth: 2
12+
:class: singlecol
13+
14+
.. toctree::
15+
:titlesonly:
16+
:hidden:
17+
18+
io.realm </sdk/java/api/io/realm>
19+
io.realm.annotations </sdk/java/api/io/realm/annotations>
20+
io.realm.coroutines </sdk/java/api/io/realm/coroutines>
21+
io.realm.exceptions </sdk/java/api/io/realm/exceptions>
22+
io.realm.log </sdk/java/api/io/realm/log>
23+
io.realm.mongodb </sdk/java/api/io/realm/mongodb>
24+
io.realm.mongodb.auth </sdk/java/api/io/realm/mongodb/auth>
25+
io.realm.mongodb.functions </sdk/java/api/io/realm/mongodb/functions>
26+
io.realm.mongodb.log.obfuscator </sdk/java/api/io/realm/mongodb/log/obfuscator>
27+
io.realm.mongodb.mongo </sdk/java/api/io/realm/mongodb/mongo>
28+
io.realm.mongodb.mongo.events </sdk/java/api/io/realm/mongodb/mongo/events>
29+
io.realm.mongodb.mongo.iterable </sdk/java/api/io/realm/mongodb/mongo/iterable>
30+
io.realm.mongodb.mongo.options </sdk/java/api/io/realm/mongodb/mongo/options>
31+
io.realm.mongodb.mongo.result </sdk/java/api/io/realm/mongodb/mongo/result>
32+
io.realm.mongodb.push </sdk/java/api/io/realm/mongodb/push>
33+
io.realm.mongodb.sync </sdk/java/api/io/realm/mongodb/sync>
34+
io.realm.rx </sdk/java/api/io/realm/rx>
35+
36+
37+
The Java API reference docs are now integrated into the main
38+
documentation site. Use the side bar to browse packages. Miss the old
39+
reference docs? You can still see the `Javadoc version
40+
<https://www.mongodb.com/docs/realm-sdks/java/latest/>`__ and the `Kotlin
41+
Extensions Reference Manual
42+
<https://www.mongodb.com/docs/realm-sdks/java/latest/kotlin-extensions/>`__.

source/sdk/java/api/index.txt

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
.. meta::
2+
:robots: noindex, nosnippet
3+
4+
:orphan:
5+
6+
.. contents:: On this page
7+
:local:
8+
:backlinks: none
9+
:depth: 2
10+
:class: singlecol
11+
12+
13+
14+
API Reference
15+
^^^^^^^^^^^^^
16+
17+
.. toctree::
18+
:titlesonly:
19+
:hidden:
20+
21+
io.realm </sdk/java/api/io/realm>
22+
io.realm.annotations </sdk/java/api/io/realm/annotations>
23+
io.realm.coroutines </sdk/java/api/io/realm/coroutines>
24+
io.realm.exceptions </sdk/java/api/io/realm/exceptions>
25+
io.realm.gradle </sdk/java/api/io/realm/gradle>
26+
io.realm.log </sdk/java/api/io/realm/log>
27+
io.realm.mongodb </sdk/java/api/io/realm/mongodb>
28+
io.realm.mongodb.auth </sdk/java/api/io/realm/mongodb/auth>
29+
io.realm.mongodb.functions </sdk/java/api/io/realm/mongodb/functions>
30+
io.realm.mongodb.log.obfuscator </sdk/java/api/io/realm/mongodb/log/obfuscator>
31+
io.realm.mongodb.mongo </sdk/java/api/io/realm/mongodb/mongo>
32+
io.realm.mongodb.mongo.events </sdk/java/api/io/realm/mongodb/mongo/events>
33+
io.realm.mongodb.mongo.iterable </sdk/java/api/io/realm/mongodb/mongo/iterable>
34+
io.realm.mongodb.mongo.options </sdk/java/api/io/realm/mongodb/mongo/options>
35+
io.realm.mongodb.mongo.result </sdk/java/api/io/realm/mongodb/mongo/result>
36+
io.realm.mongodb.push </sdk/java/api/io/realm/mongodb/push>
37+
io.realm.mongodb.sync </sdk/java/api/io/realm/mongodb/sync>
38+
io.realm.rx </sdk/java/api/io/realm/rx>
39+
40+

source/sdk/java/api/io.txt

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
.. meta::
2+
:robots: noindex, nosnippet
3+
4+
:orphan:
5+
6+
.. contents:: On this page
7+
:local:
8+
:backlinks: none
9+
:depth: 2
10+
:class: singlecol
11+
12+
13+
14+
Realm Java API
15+
^^^^^^^^^^^^^^
16+
17+
.. toctree::
18+
:titlesonly:
19+
:hidden:
20+
21+
22+
io.realm </sdk/java/api/io/realm>
23+
io.realm.annotations </sdk/java/api/io/realm/annotations>
24+
io.realm.coroutines </sdk/java/api/io/realm/coroutines>
25+
io.realm.exceptions </sdk/java/api/io/realm/exceptions>
26+
io.realm.log </sdk/java/api/io/realm/log>
27+
io.realm.mongodb </sdk/java/api/io/realm/mongodb>
28+
io.realm.mongodb.functions </sdk/java/api/io/realm/mongodb/functions>
29+
io.realm.mongodb.log.obfuscator </sdk/java/api/io/realm/mongodb/log/obfuscator>
30+
io.realm.mongodb.mongo </sdk/java/api/io/realm/mongodb/mongo>
31+
io.realm.mongodb.mongo.events </sdk/java/api/io/realm/mongodb/mongo/events>
32+
io.realm.mongodb.mongo.iterable </sdk/java/api/io/realm/mongodb/mongo/iterable>
33+
io.realm.mongodb.mongo.options </sdk/java/api/io/realm/mongodb/mongo/options>
34+
io.realm.mongodb.mongo.result </sdk/java/api/io/realm/mongodb/mongo/result>
35+
io.realm.mongodb.push </sdk/java/api/io/realm/mongodb/push>
36+
io.realm.mongodb.sync </sdk/java/api/io/realm/mongodb/sync>
37+
io.realm.rx </sdk/java/api/io/realm/rx>

source/sdk/java/api/io/realm.txt

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
.. meta::
2+
:robots: noindex, nosnippet
3+
4+
5+
.. contents:: On this page
6+
:local:
7+
:backlinks: none
8+
:depth: 2
9+
:class: singlecol
10+
11+
12+
13+
io.realm
14+
^^^^^^^^
15+
16+
.. toctree::
17+
:titlesonly:
18+
:hidden:
19+
20+
21+
Case </sdk/java/api/io/realm/Case>
22+
CollectionUtils </sdk/java/api/io/realm/CollectionUtils>
23+
CompactOnLaunchCallback </sdk/java/api/io/realm/CompactOnLaunchCallback>
24+
DefaultCompactOnLaunchCallback </sdk/java/api/io/realm/DefaultCompactOnLaunchCallback>
25+
DynamicRealm </sdk/java/api/io/realm/DynamicRealm>
26+
DynamicRealm.Callback </sdk/java/api/io/realm/DynamicRealm/Callback>
27+
DynamicRealm.Transaction </sdk/java/api/io/realm/DynamicRealm/Transaction>
28+
DynamicRealm.Transaction.Callback </sdk/java/api/io/realm/DynamicRealm/Transaction/Callback>
29+
DynamicRealm.Transaction.OnError </sdk/java/api/io/realm/DynamicRealm/Transaction/OnError>
30+
DynamicRealm.Transaction.OnSuccess </sdk/java/api/io/realm/DynamicRealm/Transaction/OnSuccess>
31+
DynamicRealmObject </sdk/java/api/io/realm/DynamicRealmObject>
32+
FieldAttribute </sdk/java/api/io/realm/FieldAttribute>
33+
FrozenPendingRow </sdk/java/api/io/realm/FrozenPendingRow>
34+
ImportFlag </sdk/java/api/io/realm/ImportFlag>
35+
MapChangeListener </sdk/java/api/io/realm/MapChangeListener>
36+
MapChangeSet </sdk/java/api/io/realm/MapChangeSet>
37+
MutableRealmInteger </sdk/java/api/io/realm/MutableRealmInteger>
38+
ObjectChangeSet </sdk/java/api/io/realm/ObjectChangeSet>
39+
OrderedCollectionChangeSet </sdk/java/api/io/realm/OrderedCollectionChangeSet>
40+
OrderedCollectionChangeSet.Range </sdk/java/api/io/realm/OrderedCollectionChangeSet/Range>
41+
OrderedCollectionChangeSet.State </sdk/java/api/io/realm/OrderedCollectionChangeSet/State>
42+
OrderedRealmCollection </sdk/java/api/io/realm/OrderedRealmCollection>
43+
OrderedRealmCollectionChangeListener </sdk/java/api/io/realm/OrderedRealmCollectionChangeListener>
44+
OrderedRealmCollectionSnapshot </sdk/java/api/io/realm/OrderedRealmCollectionSnapshot>
45+
ProxyState </sdk/java/api/io/realm/ProxyState>
46+
Realm </sdk/java/api/io/realm/Realm>
47+
Realm.Callback </sdk/java/api/io/realm/Realm/Callback>
48+
Realm.Transaction </sdk/java/api/io/realm/Realm/Transaction>
49+
Realm.Transaction.Callback </sdk/java/api/io/realm/Realm/Transaction/Callback>
50+
Realm.Transaction.OnError </sdk/java/api/io/realm/Realm/Transaction/OnError>
51+
Realm.Transaction.OnSuccess </sdk/java/api/io/realm/Realm/Transaction/OnSuccess>
52+
RealmAny </sdk/java/api/io/realm/RealmAny>
53+
RealmAny.Type </sdk/java/api/io/realm/RealmAny/Type>
54+
RealmAnyNativeFunctionsImpl </sdk/java/api/io/realm/RealmAnyNativeFunctionsImpl>
55+
RealmAnyOperator </sdk/java/api/io/realm/RealmAnyOperator>
56+
RealmAsyncTask </sdk/java/api/io/realm/RealmAsyncTask>
57+
RealmChangeListener </sdk/java/api/io/realm/RealmChangeListener>
58+
RealmCollection </sdk/java/api/io/realm/RealmCollection>
59+
RealmConfiguration </sdk/java/api/io/realm/RealmConfiguration>
60+
RealmConfiguration.Builder </sdk/java/api/io/realm/RealmConfiguration/Builder>
61+
RealmDictionary </sdk/java/api/io/realm/RealmDictionary>
62+
RealmFieldType </sdk/java/api/io/realm/RealmFieldType>
63+
RealmList </sdk/java/api/io/realm/RealmList>
64+
RealmMap </sdk/java/api/io/realm/RealmMap>
65+
RealmMigration </sdk/java/api/io/realm/RealmMigration>
66+
RealmModel </sdk/java/api/io/realm/RealmModel>
67+
RealmObject </sdk/java/api/io/realm/RealmObject>
68+
RealmObjectChangeListener </sdk/java/api/io/realm/RealmObjectChangeListener>
69+
RealmObjectSchema </sdk/java/api/io/realm/RealmObjectSchema>
70+
RealmObjectSchema.Function </sdk/java/api/io/realm/RealmObjectSchema/Function>
71+
RealmQuery </sdk/java/api/io/realm/RealmQuery>
72+
RealmResults </sdk/java/api/io/realm/RealmResults>
73+
RealmSchema </sdk/java/api/io/realm/RealmSchema>
74+
RealmSet </sdk/java/api/io/realm/RealmSet>
75+
SetChangeListener </sdk/java/api/io/realm/SetChangeListener>
76+
SetChangeSet </sdk/java/api/io/realm/SetChangeSet>
77+
Sort </sdk/java/api/io/realm/Sort>

0 commit comments

Comments
 (0)