Skip to content

Commit a371fe5

Browse files
committed
Add javadoc about forced updates
1 parent 610752a commit a371fe5

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

src/main/java/net/imagej/updater/FilesCollection.java

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -907,12 +907,20 @@ public boolean hasUploadOrRemove() {
907907
return has(oneOf(Action.UPLOAD, Action.REMOVE));
908908
}
909909

910+
/**
911+
* @return True essentially if any files differ from the update site (locally modified or out of date).
912+
*/
910913
public boolean hasForcableUpdates() {
911914
for (final FileObject file : updateable(true))
912915
if (!file.isUpdateable(false)) return true;
913916
return false;
914917
}
915918

919+
/**
920+
* @param evenForcedOnes If false, only look at updateable items with a known checksum.
921+
* If true, this will also include things like locally modified files.
922+
* @return An iterable over any updateable items.
923+
*/
916924
public Iterable<FileObject> updateable(final boolean evenForcedOnes) {
917925
return filter(new Filter() {
918926

0 commit comments

Comments
 (0)