Add Maven project description.
[jFCPlib.git] / src / net / pterodactylus / fcp / ClientPutDiskDir.java
index 540e088..d9b3924 100644 (file)
@@ -1,6 +1,5 @@
 /*
- * jSite2 - ClientPutDiskDir.java -
- * Copyright © 2008 David Roden
+ * jFCPlib - ClientPutDiskDir.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,14 +21,14 @@ package net.pterodactylus.fcp;
 /**
  * The “ClientPutDiskDir” message is used to insert a complete directory from
  * the disk to a single key.
- * 
+ *
  * @author David ‘Bombe’ Roden <bombe@freenetproject.org>
  */
 public class ClientPutDiskDir extends FcpMessage {
 
        /**
         * Creates a new “ClientPutDiskDir” message.
-        * 
+        *
         * @param uri
         *            The URI to insert the file to
         * @param identifier
@@ -48,7 +47,7 @@ public class ClientPutDiskDir 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
@@ -59,7 +58,7 @@ public class ClientPutDiskDir extends FcpMessage {
 
        /**
         * The number of retries for a request if the initial try failed.
-        * 
+        *
         * @param maxRetries
         *            The maximum number of retries after failure, or
         *            <code>-1</code> to retry forever.
@@ -70,7 +69,7 @@ public class ClientPutDiskDir extends FcpMessage {
 
        /**
         * Sets the priority of the request.
-        * 
+        *
         * @param priority
         *            The priority of the request
         */
@@ -81,7 +80,7 @@ public class ClientPutDiskDir extends FcpMessage {
        /**
         * Determines whether the node should really insert the data or generate the
         * final CHK only.
-        * 
+        *
         * @param getCHKOnly
         *            <code>true</code> to generate the final CHK only,
         *            <code>false</code> to really insert the data
@@ -92,7 +91,7 @@ public class ClientPutDiskDir extends FcpMessage {
 
        /**
         * Determines whether this request appears on the global queue.
-        * 
+        *
         * @param global
         *            <code>true</code> to put the request on the global queue,
         *            <code>false</code> for the client-local queue.
@@ -104,10 +103,10 @@ public class ClientPutDiskDir extends FcpMessage {
        /**
         * Determines whether the node should skip compression because the file has
         * already been compressed.
-        * 
+        *
         * @param dontCompress
-        *            <code>true</code> to skip compression of the data in the
-        *            node, <code>false</code> to allow compression
+        *            <code>true</code> to skip compression of the data in the node,
+        *            <code>false</code> to allow compression
         */
        public void setDontCompress(boolean dontCompress) {
                setField("DontCompress", String.valueOf(dontCompress));
@@ -117,7 +116,7 @@ public class ClientPutDiskDir 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
         */
@@ -127,7 +126,7 @@ public class ClientPutDiskDir extends FcpMessage {
 
        /**
         * Sets the persistence of this request.
-        * 
+        *
         * @param persistence
         *            The persistence of this request
         */
@@ -138,7 +137,7 @@ public class ClientPutDiskDir extends FcpMessage {
        /**
         * Sets the name of the default file. The default file is shown when the key
         * is requested with an additional name.
-        * 
+        *
         * @param defaultName
         *            The name of the default file
         */
@@ -148,7 +147,7 @@ public class ClientPutDiskDir extends FcpMessage {
 
        /**
         * Sets whether unreadable files allow the insert to continue.
-        * 
+        *
         * @param allowUnreadableFiles
         *            <code>true</code> to just ignore unreadable files,
         *            <code>false</code> to let the insert fail when an unreadable