From: David ‘Bombe’ Roden Date: Wed, 8 Jul 2015 18:31:29 +0000 (+0200) Subject: Add quelaton package javadoc X-Git-Url: https://git.pterodactylus.net/?a=commitdiff_plain;h=6ecfcc6d3db14ad21765d3c2346df81d13d6a1fd;p=jFCPlib.git Add quelaton package javadoc --- diff --git a/src/main/java/net/pterodactylus/fcp/quelaton/package-info.java b/src/main/java/net/pterodactylus/fcp/quelaton/package-info.java new file mode 100644 index 0000000..f82557b --- /dev/null +++ b/src/main/java/net/pterodactylus/fcp/quelaton/package-info.java @@ -0,0 +1,25 @@ +/** + * Quelaton – a high-level FCP client with an easy-to-use fluent interface. + *

+ * Quelaton can be used by FCP applications to easily perform the most commons tasks, such as retrieving or inserting + * data, or generating keys. The main entry class is {@link net.pterodactylus.fcp.quelaton.FcpClient} which can create + * FCP commands which can then be fed arguments or data and which can be executed, yielding a result in form of a + * {@link java.util.concurrent.Future}. + *

+ * FcpClient fcpClient = ...
+ * Optional<Data> data = fcpClient.clientGet().uri("KSK@gpl.txt").{@link java.util.concurrent.Future#get()
+ * get()};
+ * if (data.isPresent()) {
+ *     ... process data ...
+ * }
+ * 
+ *

+ * As is the case with {@link java.util.concurrent.Future}’s, the call to {@link java.util.concurrent.Future#get()} + * will block until the request has finished. This allows starting the request (by calling + * {@link net.pterodactylus.fcp.quelaton.ClientGetCommand#uri(String)}) and waiting for it to finish in a different + * thread. Using Guava’s {@link com.google.common.util.concurrent.ListenableFuture} allows client applications to + * register listeners that will automatically be run once the request finishes. + * + * @author David ‘Bombe’ Roden + */ +package net.pterodactylus.fcp.quelaton;