Skip to content

Commit f4512eb

Browse files
committed
fix comments
1 parent 4175550 commit f4512eb

File tree

1 file changed

+5
-4
lines changed
  • firebase-firestore/src/main/java/com/google/firebase/firestore/util

1 file changed

+5
-4
lines changed

firebase-firestore/src/main/java/com/google/firebase/firestore/util/DocumentId.java

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -32,10 +32,11 @@
3232
* <p>A run time exception will be thrown if this annotation is applied to a property that is not
3333
* writeable (eg, a Java Bean getter without a backing field.).
3434
*
35-
* <p>If there are conflicts between this annotation and property name matches, this annotation will
36-
* take precedence. For example: If a POJO has a field `firstName` annotated by @DocumentId, and
37-
* there is a property from the document named `firstName` as well, the SDK will set the value to be
38-
* the document ID.
35+
* <p>If there are conflicts between this annotation and property name matches, a runtime exception
36+
* will be thrown. For example: If a POJO has a field `firstName` annotated by @DocumentId, and
37+
* there is a property from the document named `firstName` as well, an exception will be thrown when
38+
* you try to read document into the POJO via {@link DocumentSnapshot#toObject} or {@link
39+
* DocumentReference#get}.
3940
*
4041
* <p>When writing a POJO to Firestore, the @DocumentId-annotated property will be ignored, to allow
4142
* writing to any documents that are not the origin of the POJO.

0 commit comments

Comments
 (0)