Skip to content
This repository has been archived by the owner on Dec 15, 2020. It is now read-only.

Commit

Permalink
Add missing params to javadocs
Browse files Browse the repository at this point in the history
  • Loading branch information
anupcowkur committed Jun 26, 2016
1 parent f8729d3 commit 2cdcc74
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions Library/src/main/java/com/anupcowkur/reservoir/Reservoir.java
Original file line number Diff line number Diff line change
Expand Up @@ -171,6 +171,7 @@ public void call(Subscriber<? super Boolean> subscriber) {
/**
* Get an object from Reservoir with the given key. This a blocking IO operation.
*
* @param <T> the type of the object to get.
* @param key the key string.
* @param classOfT the class type of the expected return object.
* @return the object of the given type if it exists.
Expand All @@ -190,6 +191,7 @@ public static <T> T get(final String key, final Class<T> classOfT) throws IOExce
/**
* Get an object from Reservoir with the given key. This a blocking IO operation.
*
* @param <T> the type of the object to get.
* @param key the key string.
* @param typeOfT the type of the expected return object.
* @return the object of the given type if it exists.
Expand All @@ -209,6 +211,7 @@ public static <T> T get(final String key, final Type typeOfT) throws IOException
/**
* Get an object from Reservoir with the given key asynchronously.
*
* @param <T> the type of the object to get.
* @param key the key string.
* @param classOfT the class type of the expected return object.
* @param callback a callback of type {@link com.anupcowkur.reservoir.ReservoirGetCallback}
Expand All @@ -225,6 +228,7 @@ public static <T> void getAsync(final String key, final Class<T> classOfT,
/**
* Get an object from Reservoir with the given key asynchronously.
*
* @param <T> the type of the object to get.
* @param key the key string.
* @param typeOfT the type of the expected return object.
* @param callback a callback of type {@link com.anupcowkur.reservoir.ReservoirGetCallback}
Expand All @@ -241,6 +245,7 @@ public static <T> void getAsync(final String key, final Type typeOfT,
/**
* Get an object from Reservoir with the given key asynchronously.
*
* @param <T> the type of the object to get.
* @param key the key string.
* @param classOfT the class type of the expected return object.
* @return an {@link Observable} that will fetch the object from Reservoir. By default, this
Expand All @@ -267,6 +272,7 @@ public void call(Subscriber<? super T> subscriber) {
/**
* Get an object from Reservoir with the given key asynchronously.
*
* @param <T> the type of the object to get.
* @param key the key string.
* @param classOfT the class type of the expected return object.
* @param typeOfT the type of the collection object which contains objects of type {@code classOfT}.
Expand Down Expand Up @@ -367,6 +373,8 @@ public static void clear() throws IOException {
/**
* Clears the cache. Deletes all the stored key-value pairs asynchronously.
*
* @param callback a callback of type {@link com.anupcowkur.reservoir.ReservoirClearCallback}
* which is called upon completion.
* @throws IllegalStateException thrown if init method hasn't been called.
*/
public static void clearAsync(final ReservoirClearCallback callback){
Expand Down

0 comments on commit 2cdcc74

Please sign in to comment.