updated JavaDoc

Former-commit-id: 38777540e58ce5821fbb86f183e824c143635825
This commit is contained in:
Jeremy Long
2014-01-04 08:54:36 -05:00
parent a4771090ed
commit 8e2e258518

View File

@@ -21,20 +21,20 @@ package org.owasp.dependencycheck.data;
import org.owasp.dependencycheck.update.UpdateException; import org.owasp.dependencycheck.update.UpdateException;
/** /**
* Defines an Index who's data is retrieved from the Internet. This data can be * Defines a data source who's data is retrieved from the Internet. This data
* downloaded and the index updated. * can be downloaded and the local cache updated.
* *
* @author Jeremy Long (jeremy.long@owasp.org) * @author Jeremy Long (jeremy.long@owasp.org)
*/ */
public interface CachedWebDataSource { public interface CachedWebDataSource {
/** /**
* Determines if an update to the current index is needed, if it is the new * Determines if an update to the current data store is needed, if it is the
* data is downloaded from the Internet and imported into the current Lucene * new data is downloaded from the Internet and imported into the current
* Index. * cached data store.
* *
* @throws UpdateException is thrown if there is an exception updating the * @throws UpdateException is thrown if there is an exception downloading
* index. * the data or updating the data store.
*/ */
void update() throws UpdateException; void update() throws UpdateException;
} }