svn commit: r1453224 - /commons/proper/fileupload/trunk/src/main/java/org/apache/commons/fileupload/util/Streams.java

[si...@apache.org]

Author: simonetripodi
Date: Wed Mar  6 09:01:58 2013
New Revision: 1453224

URL: http://svn.apache.org/r1453224
Log:
trivial: code/javadoc format, no functional modification

Modified:
    commons/proper/fileupload/trunk/src/main/java/org/apache/commons/fileupload/util/Streams.java

Modified: commons/proper/fileupload/trunk/src/main/java/org/apache/commons/fileupload/util/Streams.java
URL: http://svn.apache.org/viewvc/commons/proper/fileupload/trunk/src/main/java/org/apache/commons/fileupload/util/Streams.java?rev=1453224&r1=1453223&r2=1453224&view=diff
==============================================================================
--- commons/proper/fileupload/trunk/src/main/java/org/apache/commons/fileupload/util/Streams.java (original)
+++ commons/proper/fileupload/trunk/src/main/java/org/apache/commons/fileupload/util/Streams.java Wed Mar  6 09:01:58 2013
@@ -23,10 +23,11 @@ import java.io.OutputStream;
 
 import org.apache.commons.fileupload.InvalidFileNameException;
 
-
-/** Utility class for working with streams.
+/**
+ * Utility class for working with streams.
  */
 public final class Streams {
+
     /**
      * Private constructor, to prevent instantiation.
      * This class has only static methods.
@@ -47,6 +48,7 @@ public final class Streams {
      * <pre>
      *   copy(pInputStream, pOutputStream, new byte[8192]);
      * </pre>
+     *
      * @param pInputStream The input stream, which is being read.
      * It is guaranteed, that {@link InputStream#close()} is called
      * on the stream.
@@ -70,6 +72,7 @@ public final class Streams {
     /**
      * Copies the contents of the given {@link InputStream}
      * to the given {@link OutputStream}.
+     *
      * @param pIn The input stream, which is being read.
      *   It is guaranteed, that {@link InputStream#close()} is called
      *   on the stream.
@@ -138,6 +141,7 @@ public final class Streams {
      * {@link org.apache.commons.fileupload.FileItemStream}'s
      * content into a string. The platform's default character encoding
      * is used for converting bytes into characters.
+     *
      * @param pStream The input stream to read.
      * @see #asString(InputStream, String)
      * @return The streams contents, as a string.
@@ -153,6 +157,7 @@ public final class Streams {
      * This convenience method allows to read a
      * {@link org.apache.commons.fileupload.FileItemStream}'s
      * content into a string, using the given character encoding.
+     *
      * @param pStream The input stream to read.
      * @param pEncoding The character encoding, typically "UTF-8".
      * @see #asString(InputStream)
@@ -171,6 +176,7 @@ public final class Streams {
      * that it doesn't contain any NUL characters. If the file name
      * is valid, it will be returned without any modifications. Otherwise,
      * an {@link InvalidFileNameException} is raised.
+     *
      * @param pFileName The file name to check
      * @return Unmodified file name, if valid.
      * @throws InvalidFileNameException The file name was found to be invalid.
@@ -195,4 +201,5 @@ public final class Streams {
         }
         return pFileName;
     }
+
 }