From: David ‘Bombe’ Roden Date: Thu, 26 Nov 2009 09:07:07 +0000 (+0100) Subject: Enhance javadoc. X-Git-Tag: v0.1.2.1~4 X-Git-Url: https://git.pterodactylus.net/?a=commitdiff_plain;h=ff507a2bd95ba0ea46937591e3a36d726d57e98e;p=jFCPlib.git Enhance javadoc. --- diff --git a/src/main/java/net/pterodactylus/fcp/highlevel/PutRequest.java b/src/main/java/net/pterodactylus/fcp/highlevel/PutRequest.java index cba84a6..c43580d 100644 --- a/src/main/java/net/pterodactylus/fcp/highlevel/PutRequest.java +++ b/src/main/java/net/pterodactylus/fcp/highlevel/PutRequest.java @@ -21,12 +21,18 @@ package net.pterodactylus.fcp.highlevel; import net.pterodactylus.fcp.PersistentPut; /** - * TODO + * High-level wrapper around a {@link PersistentPut}. * * @author David ‘Bombe’ Roden <bombe@freenetproject.org> */ public class PutRequest extends Request { + /** + * Creates a new put request. + * + * @param persistentPut + * The FCP message to wrap + */ PutRequest(PersistentPut persistentPut) { super(persistentPut.getIdentifier(), persistentPut.getClientToken(), persistentPut.isGlobal()); } diff --git a/src/main/java/net/pterodactylus/fcp/highlevel/Request.java b/src/main/java/net/pterodactylus/fcp/highlevel/Request.java index 0b0f46e..6264a5a 100644 --- a/src/main/java/net/pterodactylus/fcp/highlevel/Request.java +++ b/src/main/java/net/pterodactylus/fcp/highlevel/Request.java @@ -260,85 +260,102 @@ public abstract class Request { } /** - * TODO + * Returns the number of required blocks. Any progress percentages should be + * calculated against this value as 100%. Also, as long as + * {@link #isFinalizedTotal()} returns {@code false} this value might + * change. * - * @return the requiredBlocks + * @return The number of required blocks */ public int getRequiredBlocks() { return requiredBlocks; } /** - * TODO + * Sets the number of required blocks. * * @param requiredBlocks - * the requiredBlocks to set + * The number of required blocks */ public void setRequiredBlocks(int requiredBlocks) { this.requiredBlocks = requiredBlocks; } /** - * TODO + * Returns the number of succeeded blocks. * - * @return the succeededBlocks + * @return The number of succeeded blocks */ public int getSucceededBlocks() { return succeededBlocks; } /** - * TODO + * Sets the number of succeeded blocks. * * @param succeededBlocks - * the succeededBlocks to set + * The number of succeeded blocks */ public void setSucceededBlocks(int succeededBlocks) { this.succeededBlocks = succeededBlocks; } /** - * TODO + * Returns the number of failed blocks. These blocks may be retried untill + * the maximum number of retries has been reached. * - * @return the failedBlocks + * @return The number of failed blocks */ public int getFailedBlocks() { return failedBlocks; } /** - * TODO + * Sets the number of failed blocks. * * @param failedBlocks - * the failedBlocks to set + * The number of failed blocks */ public void setFailedBlocks(int failedBlocks) { this.failedBlocks = failedBlocks; } /** - * TODO + * Returns the number of fatally failed blocks. * - * @return the fatallyFailedBlocks + * @return The number of fatally failed blocks */ public int getFatallyFailedBlocks() { return fatallyFailedBlocks; } /** - * TODO + * Sets the number of fatally failed blocks. * * @param fatallyFailedBlocks - * the fatallyFailedBlocks to set + * The number of fatally failed blocks */ public void setFatallyFailedBlocks(int fatallyFailedBlocks) { this.fatallyFailedBlocks = fatallyFailedBlocks; } + /** + * Returns whether the number of blocks has been finalized. + * + * @return {@code true} if the number of blocks is finalized, {@code false} + * otherwise + */ public boolean isFinalizedTotal() { return finalizedTotal; } + /** + * Sets whether the number of blocks has been finalized. + * + * @param finalizedTotal + * {@code true} if the number of blocks has been finalized, + * {@code false} otherwise + */ void setFinalizedTotal(boolean finalizedTotal) { this.finalizedTotal = finalizedTotal; }