Add Maven project description.
[jFCPlib.git] / src / net / pterodactylus / fcp / ClientPutComplexDir.java
index cb40da1..55e5779 100644 (file)
@@ -1,6 +1,5 @@
 /*
- * jSite2 - ClientPutComplexDir.java -
- * Copyright © 2008 David Roden
+ * jFCPlib - ClientPutComplexDir.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
@@ -34,10 +33,9 @@ import net.pterodactylus.fcp.FileEntry.DirectFileEntry;
 /**
  * The “ClientPutComplexDir” lets you upload a directory with different sources
  * for each file.
- * 
+ *
  * @see FileEntry
  * @author David ‘Bombe’ Roden <bombe@freenetproject.org>
- * @version $Id$
  */
 public class ClientPutComplexDir extends FcpMessage {
 
@@ -49,7 +47,7 @@ public class ClientPutComplexDir extends FcpMessage {
 
        /**
         * Creates a new “ClientPutComplexDir” with the given identifier and URI.
-        * 
+        *
         * @param identifier
         *            The identifier of the request
         * @param uri
@@ -63,7 +61,7 @@ public class ClientPutComplexDir extends FcpMessage {
 
        /**
         * Sets the verbosity of the request.
-        * 
+        *
         * @param verbosity
         *            The verbosity of the request
         */
@@ -73,7 +71,7 @@ public class ClientPutComplexDir extends FcpMessage {
 
        /**
         * Sets the maximum number of retries for failed blocks.
-        * 
+        *
         * @param maxRetries
         *            The maximum number of retries for failed blocks, or
         *            <code>-1</code> to retry endlessly
@@ -84,7 +82,7 @@ public class ClientPutComplexDir extends FcpMessage {
 
        /**
         * Sets the priority of the request.
-        * 
+        *
         * @param priority
         *            The priority of the request
         */
@@ -94,7 +92,7 @@ public class ClientPutComplexDir extends FcpMessage {
 
        /**
         * Sets whether to generate the final URI only.
-        * 
+        *
         * @param getCHKOnly
         *            <code>true</code> to generate the final CHK only,
         *            <code>false</code> to complete the insert
@@ -105,7 +103,7 @@ public class ClientPutComplexDir extends FcpMessage {
 
        /**
         * Sets whether the request is on the global queue.
-        * 
+        *
         * @param global
         *            <code>true</code> to put the request on the global queue,
         *            <code>false</code> to put it on the client-local queue
@@ -116,7 +114,7 @@ public class ClientPutComplexDir extends FcpMessage {
 
        /**
         * Sets whether the node should not try to compress the data.
-        * 
+        *
         * @param dontCompress
         *            <code>true</code> to skip compression of the data,
         *            <code>false</code> to try and compress the data
@@ -127,7 +125,7 @@ public class ClientPutComplexDir extends FcpMessage {
 
        /**
         * Sets the client token of the request.
-        * 
+        *
         * @param clientToken
         *            The client token of the request
         */
@@ -137,7 +135,7 @@ public class ClientPutComplexDir extends FcpMessage {
 
        /**
         * Sets the persistence of the request.
-        * 
+        *
         * @param persistence
         *            The persistence of the request
         */
@@ -148,7 +146,7 @@ public class ClientPutComplexDir extends FcpMessage {
        /**
         * Sets the target filename of the request. This is useful for inserts that
         * go to “CHK@” only and creates a manifest with a single file.
-        * 
+        *
         * @param targetFilename
         *            The target filename
         */
@@ -159,7 +157,7 @@ public class ClientPutComplexDir extends FcpMessage {
        /**
         * Sets whether to encode the complete data early to generate the
         * {@link URIGenerated} message early.
-        * 
+        *
         * @param earlyEncode
         *            <code>true</code> to encode the complete data early,
         *            <code>false</code> otherwise
@@ -171,7 +169,7 @@ public class ClientPutComplexDir extends FcpMessage {
        /**
         * Sets the default name. This is the name of the file that should be shown
         * if no file was specified.
-        * 
+        *
         * @param defaultName
         *            The default name
         */
@@ -181,13 +179,13 @@ public class ClientPutComplexDir extends FcpMessage {
 
        /**
         * Adds an entry for a file.
-        * 
+        *
         * @param fileEntry
         *            The file entry to add
         */
        public void addFileEntry(FileEntry fileEntry) {
                Map<String, String> fields = fileEntry.getFields();
-               for (Entry<String, String> fieldEntry: fields.entrySet()) {
+               for (Entry<String, String> fieldEntry : fields.entrySet()) {
                        setField("Files." + fileIndex + "." + fieldEntry.getKey(), fieldEntry.getValue());
                }
                fileIndex++;
@@ -200,8 +198,8 @@ public class ClientPutComplexDir extends FcpMessage {
         * {@inheritDoc}
         * <p>
         * Do not call this method to add input streams! The input streams, if any,
-        * will be taken directly from the {@link FileEntry}s and the stream you
-        * set here will be overridden!
+        * will be taken directly from the {@link FileEntry}s and the stream you set
+        * here will be overridden!
         */
        @Override
        public void setPayloadInputStream(InputStream payloadInputStream) {