Skip to content

Commit fc4d736

Browse files
committed
Add hint that a DatabaseReference is a Query
1 parent 7bbf755 commit fc4d736

File tree

4 files changed

+6
-4
lines changed

4 files changed

+6
-4
lines changed

database/src/main/java/com/firebase/ui/database/FirebaseIndexListAdapter.java

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,8 @@ public abstract class FirebaseIndexListAdapter<T> extends FirebaseListAdapter<T>
1414
* model class
1515
* @param keyQuery The Firebase location containing the list of keys to be found in {@code
1616
* dataRef}. Can also be a slice of a location, using some combination of {@code
17-
* limit()}, {@code startAt()}, and {@code endAt()}.
17+
* limit()}, {@code startAt()}, and {@code endAt()}. <b>Note, this can also be a
18+
* {@link DatabaseReference}.</b>
1819
* @param dataRef The Firebase location to watch for data changes. Each key key found at {@code
1920
* keyQuery}'s location represents a list item in the {@link ListView}.
2021
* @see FirebaseIndexListAdapter#FirebaseIndexListAdapter(Activity, SnapshotParser, int, Query,

database/src/main/java/com/firebase/ui/database/FirebaseIndexRecyclerAdapter.java

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,8 @@ public abstract class FirebaseIndexRecyclerAdapter<T, VH extends RecyclerView.Vi
1414
* model class
1515
* @param keyQuery The Firebase location containing the list of keys to be found in {@code
1616
* dataRef}. Can also be a slice of a location, using some combination of {@code
17-
* limit()}, {@code startAt()}, and {@code endAt()}.
17+
* limit()}, {@code startAt()}, and {@code endAt()}. <b>Note, this can also be a
18+
* {@link DatabaseReference}.</b>
1819
* @param dataRef The Firebase location to watch for data changes. Each key key found at {@code
1920
* keyQuery}'s location represents a list item in the {@link RecyclerView}.
2021
* @see FirebaseRecyclerAdapter#FirebaseRecyclerAdapter(ObservableSnapshotArray, int, Class)

database/src/main/java/com/firebase/ui/database/FirebaseListAdapter.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ public FirebaseListAdapter(Activity activity,
5353
* class
5454
* @param query The Firebase location to watch for data changes. Can also be a slice of a
5555
* location, using some combination of {@code limit()}, {@code startAt()}, and
56-
* {@code endAt()}.
56+
* {@code endAt()}. <b>Note, this can also be a {@link DatabaseReference}.</b>
5757
* @see #FirebaseListAdapter(Activity, ObservableSnapshotArray, int)
5858
*/
5959
public FirebaseListAdapter(Activity activity,

database/src/main/java/com/firebase/ui/database/FirebaseRecyclerAdapter.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ public FirebaseRecyclerAdapter(ObservableSnapshotArray<T> snapshots,
5858
* class
5959
* @param query The Firebase location to watch for data changes. Can also be a slice of a
6060
* location, using some combination of {@code limit()}, {@code startAt()}, and
61-
* {@code endAt()}.
61+
* {@code endAt()}. <b>Note, this can also be a {@link DatabaseReference}.</b>
6262
* @see #FirebaseRecyclerAdapter(ObservableSnapshotArray, int, Class)
6363
*/
6464
public FirebaseRecyclerAdapter(SnapshotParser<T> parser,

0 commit comments

Comments
 (0)