Skip to content

Commit 9fb601e

Browse files
committed
FilesCollection: add note on usage
1 parent 943d610 commit 9fb601e

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

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

+12
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,18 @@
7575

7676
/**
7777
* This class represents the database of available {@link FileObject}s.
78+
* <p>
79+
* By itself, a {@code FilesCollection} is fairly naive. If built around an
80+
* existing installation, the first action to take after instantiation is often
81+
* {@link #tryLoadingCollection()} - which will then recongnize update sites,
82+
* etc...
83+
* </p>
84+
* <p>
85+
* After any updates to the {@code FilesCollection}, the {@link #write()} method
86+
* is used to persist state to the {@code db.xml.gz} on disk. Note that this
87+
* does not actually perform any file updates - the
88+
* {@link net.imagej.updater.Installer} is required for such operations.
89+
* </p>
7890
*
7991
* @author Johannes Schindelin
8092
*/

0 commit comments

Comments
 (0)