Skip to content

Commit 50aea47

Browse files
authored
Add comment to ProgressCallback doc (#5286)
Signed-off-by: Chris Jackson <chris@cd-jackson.com>
1 parent 3706443 commit 50aea47

1 file changed

Lines changed: 4 additions & 2 deletions

File tree

  • bundles/org.openhab.core.thing/src/main/java/org/openhab/core/thing/binding/firmware

bundles/org.openhab.core.thing/src/main/java/org/openhab/core/thing/binding/firmware/ProgressCallback.java

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -105,11 +105,13 @@ public interface ProgressCallback {
105105
* Callback operation to update the percentage progress of the firmware update.
106106
* This method can be used to provide detailed progress information additional to the sequence or even without a
107107
* previous defined sequence.
108+
* <br>
109+
* Note that calling this method before the first call to next() will cause the iterator to be stepped to the first
110+
* state!
108111
*
109112
* @param progress the progress between 0 and 100
110113
* @throws IllegalArgumentException if given progress is {@code < 0} or {@code > 100} or if given progress is
111-
* smaller than old
112-
* progress
114+
* smaller than old progress
113115
* @throws IllegalStateException if update is finished
114116
*/
115117
void update(int progress);

0 commit comments

Comments
 (0)