X-Git-Url: https://git.pterodactylus.net/?a=blobdiff_plain;f=src%2Fnet%2Fpterodactylus%2Ffcp%2FClientPut.java;h=f7dfabc3bbc59a8302f22572630d0f576ca9b209;hb=a655177a4605236e866ac7e0ce32f7cb5289cbc4;hp=f3d3d1d5e17edc0c9a8a6e6798f4228fd756757e;hpb=f553531be78d6d6d95dc152728f2b8d40242b57d;p=jFCPlib.git diff --git a/src/net/pterodactylus/fcp/ClientPut.java b/src/net/pterodactylus/fcp/ClientPut.java index f3d3d1d..f7dfabc 100644 --- a/src/net/pterodactylus/fcp/ClientPut.java +++ b/src/net/pterodactylus/fcp/ClientPut.java @@ -1,6 +1,5 @@ /* - * jSite2 - ClientPut.java - - * Copyright © 2008 David Roden + * jFCPlib - ClientPut.java - Copyright © 2008 David Roden * * This program is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by @@ -22,10 +21,10 @@ package net.pterodactylus.fcp; /** * A “ClientPut” requests inserts a single file into freenet, either uploading * it directly with this messge ({@link UploadFrom#direct}), uploading it from - * disk ({@link UploadFrom#disk}) or by creating a redirect to another URI ({@link UploadFrom#redirect}). - * + * disk ({@link UploadFrom#disk}) or by creating a redirect to another URI ( + * {@link UploadFrom#redirect}). + * * @author David ‘Bombe’ Roden <bombe@freenetproject.org> - * @version $Id$ */ public class ClientPut extends FcpMessage { @@ -36,7 +35,7 @@ public class ClientPut extends FcpMessage { * constructor is the same as using * {@link #ClientPut(String, String, UploadFrom)} with * {@link UploadFrom#direct} as third parameter. - * + * * @param uri * The URI to insert the file to * @param identifier @@ -48,18 +47,17 @@ public class ClientPut extends FcpMessage { /** * Creates a new “ClientPut” message that inserts a file to the given URI. - * Depending on uploadFrom the file data has to be supplied - * in different ways: If uploadFrom is - * {@link UploadFrom#direct}, use - * {@link #setPayloadInputStream(java.io.InputStream)} to supply the input - * data. If uploadFrom is {@link UploadFrom#disk}, use + * Depending on uploadFrom the file data has to be supplied in + * different ways: If uploadFrom is {@link UploadFrom#direct}, + * use {@link #setPayloadInputStream(java.io.InputStream)} to supply the + * input data. If uploadFrom is {@link UploadFrom#disk}, use * {@link #setFilename(String)} to supply the file to upload. You have to * test your direct-disk access (see {@link TestDDARequest}, * {@link TestDDAReply}, {@link TestDDAResponse}, {@link TestDDAComplete}) * before using this option! If uploadFrom is - * {@link UploadFrom#redirect}, use {@link #setTargetURI(String)} to set - * the target URI of the redirect. - * + * {@link UploadFrom#redirect}, use {@link #setTargetURI(String)} to set the + * target URI of the redirect. + * * @param uri * The URI to insert to * @param identifier @@ -76,7 +74,7 @@ public class ClientPut extends FcpMessage { /** * The MIME type of the content. - * + * * @param metadataContentType * The MIME type of the content */ @@ -88,7 +86,7 @@ public class ClientPut extends FcpMessage { * The verbosity of the request. Depending on this parameter you will * received only the bare minimum of messages for the request (i.e. “it * completed”) or a whole lot more. - * + * * @see Verbosity * @param verbosity * The verbosity of the request @@ -99,7 +97,7 @@ public class ClientPut extends FcpMessage { /** * The number of retries for a request if the initial try failed. - * + * * @param maxRetries * The maximum number of retries after failure, or * -1 to retry forever. @@ -110,7 +108,7 @@ public class ClientPut extends FcpMessage { /** * Sets the priority of the request. - * + * * @param priority * The priority of the request */ @@ -121,7 +119,7 @@ public class ClientPut extends FcpMessage { /** * Determines whether the node should really insert the data or generate the * final CHK only. - * + * * @param getCHKOnly * true to generate the final CHK only, * false to really insert the data @@ -132,7 +130,7 @@ public class ClientPut extends FcpMessage { /** * Determines whether this request appears on the global queue. - * + * * @param global * true to put the request on the global queue, * false for the client-local queue. @@ -144,10 +142,10 @@ public class ClientPut extends FcpMessage { /** * Determines whether the node should skip compression because the file has * already been compressed. - * + * * @param dontCompress - * true to skip compression of the data in the - * node, false to allow compression + * true to skip compression of the data in the node, + * false to allow compression */ public void setDontCompress(boolean dontCompress) { setField("DontCompress", String.valueOf(dontCompress)); @@ -157,7 +155,7 @@ public class ClientPut extends FcpMessage { * Sets an optional client token. This client token is mentioned in progress * and other request-related messages and can be used to identify this * request. - * + * * @param clientToken * The client token */ @@ -167,7 +165,7 @@ public class ClientPut extends FcpMessage { /** * Sets the persistence of this request. - * + * * @param persistence * The persistence of this request */ @@ -178,7 +176,7 @@ public class ClientPut extends FcpMessage { /** * Sets the target filename of the inserted file. This value is ignored for * all inserts that do not have “CHK@” as a target. - * + * * @param targetFilename * The filename of the target */ @@ -189,7 +187,7 @@ public class ClientPut extends FcpMessage { /** * Determines whether to encode the complete file early in the life of the * request. - * + * * @param earlyEncode * true to generate the final key long before the * file is completely fetchable @@ -201,7 +199,7 @@ public class ClientPut extends FcpMessage { /** * Sets the length of the data that will be transferred after this message * if uploadFrom is {@link UploadFrom#direct} is used. - * + * * @param dataLength * The length of the data */ @@ -211,7 +209,7 @@ public class ClientPut extends FcpMessage { /** * Sets the name of the file to upload the data from. - * + * * @param filename * The filename to upload */ @@ -222,7 +220,7 @@ public class ClientPut extends FcpMessage { /** * If uploadFrom is {@link UploadFrom#redirect}, use this * method to determine that target of the redirect. - * + * * @param targetURI * The target URI to redirect to */