Skip to content

Commit 8ae8967

Browse files
committed
JavaDoc tweaks
1 parent 0a5a78d commit 8ae8967

File tree

1 file changed

+11
-6
lines changed

1 file changed

+11
-6
lines changed

src/main/java/org/dataloader/DataLoader.java

+11-6
Original file line numberDiff line numberDiff line change
@@ -361,12 +361,14 @@ public CompletableFuture<V> load(K key) {
361361
}
362362

363363
/**
364-
* This will return an optional promise to a value previously loaded via {@link #load(Object)} call or empty if not call has been made for that key.
364+
* This will return an optional promise to a value previously loaded via a {@link #load(Object)} call or empty if not call has been made for that key.
365365
* <p>
366366
* If you do get a present CompletableFuture it does not mean it has been dispatched and completed yet. It just means
367-
* its at least pending and in cache. Of course if caching is disabled there will never be a present Optional returned.
367+
* its at least pending and in cache.
368368
* <p>
369-
* NOTE : This will NOT cause a data load to happen. You must called {@link #load(Object)} for that.
369+
* If caching is disabled there will never be a present Optional returned.
370+
* <p>
371+
* NOTE : This will NOT cause a data load to happen. You must called {@link #load(Object)} for that to happen.
370372
*
371373
* @param key the key to check
372374
* @return an Optional to the future of the value
@@ -376,12 +378,15 @@ public Optional<CompletableFuture<V>> getIfPresent(K key) {
376378
}
377379

378380
/**
379-
* This will return an optional promise to a value previously loaded via {@link #load(Object)} call that has in fact been completed or empty
381+
* This will return an optional promise to a value previously loaded via a {@link #load(Object)} call that has in fact been completed or empty
380382
* if no call has been made for that key or the promise has not completed yet.
381383
* <p>
382-
* If you do get a present CompletableFuture it means it has been dispatched and completed.
384+
* If you do get a present CompletableFuture it means it has been dispatched and completed. Completed is defined as
385+
* {@link java.util.concurrent.CompletableFuture#isDone()} returning true.
386+
* <p>
387+
* If caching is disabled there will never be a present Optional returned.
383388
* <p>
384-
* NOTE : This will NOT cause a data load to happen. You must called {@link #load(Object)} for that.
389+
* NOTE : This will NOT cause a data load to happen. You must called {@link #load(Object)} for that to happen.
385390
*
386391
* @param key the key to check
387392
* @return an Optional to the future of the value

0 commit comments

Comments
 (0)