AbstractChangeUpdate: Clarify when notes can be null

Change-Id: I3330e91f66d9fd60e1e6f3f424c76db28735036c
This commit is contained in:
Dave Borowitz 2017-02-16 16:59:44 -05:00
parent ef3fb11948
commit 24d3106b00

@ -133,6 +133,14 @@ public abstract class AbstractChangeUpdate {
return change.getId();
}
/**
* @return notes for the state of this change prior to this update. If this update is part of a
* series managed by a {@link NoteDbUpdateManager}, then this reflects the state prior to the
* first update in the series. A null return value can only happen when the change is being
* rebuilt from NoteDb. A change that is in the process of being created will result in a
* non-null return value from this method, but a null return value from {@link
* ChangeNotes#getRevision()}.
*/
@Nullable
public ChangeNotes getNotes() {
return notes;