commons-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From simonetrip...@apache.org
Subject svn commit: r1453201 - /commons/proper/fileupload/trunk/src/main/java/org/apache/commons/fileupload/MultipartStream.java
Date Wed, 06 Mar 2013 08:31:18 GMT
Author: simonetripodi
Date: Wed Mar  6 08:31:17 2013
New Revision: 1453201

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

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

Modified: commons/proper/fileupload/trunk/src/main/java/org/apache/commons/fileupload/MultipartStream.java
URL: http://svn.apache.org/viewvc/commons/proper/fileupload/trunk/src/main/java/org/apache/commons/fileupload/MultipartStream.java?rev=1453201&r1=1453200&r2=1453201&view=diff
==============================================================================
--- commons/proper/fileupload/trunk/src/main/java/org/apache/commons/fileupload/MultipartStream.java
(original)
+++ commons/proper/fileupload/trunk/src/main/java/org/apache/commons/fileupload/MultipartStream.java
Wed Mar  6 08:31:17 2013
@@ -85,25 +85,37 @@ import org.apache.commons.fileupload.uti
  * @version $Id$
  */
 public class MultipartStream {
+
     /**
      * Internal class, which is used to invoke the
      * {@link ProgressListener}.
      */
-	public static class ProgressNotifier {
-        /** The listener to invoke.
+    public static class ProgressNotifier {
+
+        /**
+         * The listener to invoke.
          */
         private final ProgressListener listener;
-        /** Number of expected bytes, if known, or -1.
+
+        /**
+         * Number of expected bytes, if known, or -1.
          */
         private final long contentLength;
-        /** Number of bytes, which have been read so far.
+
+        /**
+         * Number of bytes, which have been read so far.
          */
         private long bytesRead;
-        /** Number of items, which have been read so far.
+
+        /**
+         * Number of items, which have been read so far.
          */
         private int items;
-        /** Creates a new instance with the given listener
+
+        /**
+         * Creates a new instance with the given listener
          * and content length.
+         *
          * @param pListener The listener to invoke.
          * @param pContentLength The expected content length.
          */
@@ -111,7 +123,10 @@ public class MultipartStream {
             listener = pListener;
             contentLength = pContentLength;
         }
-        /** Called to indicate that bytes have been read.
+
+        /**
+         * Called to indicate that bytes have been read.
+         *
          * @param pBytes Number of bytes, which have been read.
          */
         void noteBytesRead(int pBytes) {
@@ -121,126 +136,110 @@ public class MultipartStream {
             bytesRead += pBytes;
             notifyListener();
         }
-        /** Called to indicate, that a new file item has been detected.
+
+        /**
+         * Called to indicate, that a new file item has been detected.
          */
         void noteItem() {
             ++items;
             notifyListener();
         }
-        /** Called for notifying the listener.
+
+        /**
+         * Called for notifying the listener.
          */
         private void notifyListener() {
             if (listener != null) {
                 listener.update(bytesRead, contentLength, items);
             }
         }
+
     }
 
     // ----------------------------------------------------- Manifest constants
 
-
     /**
      * The Carriage Return ASCII character value.
      */
     public static final byte CR = 0x0D;
 
-
     /**
      * The Line Feed ASCII character value.
      */
     public static final byte LF = 0x0A;
 
-
     /**
      * The dash (-) ASCII character value.
      */
     public static final byte DASH = 0x2D;
 
-
     /**
      * The maximum length of <code>header-part</code> that will be
      * processed (10 kilobytes = 10240 bytes.).
      */
     public static final int HEADER_PART_SIZE_MAX = 10240;
 
-
     /**
      * The default length of the buffer used for processing a request.
      */
     protected static final int DEFAULT_BUFSIZE = 4096;
 
-
     /**
      * A byte sequence that marks the end of <code>header-part</code>
      * (<code>CRLFCRLF</code>).
      */
-    protected static final byte[] HEADER_SEPARATOR = {
-        CR, LF, CR, LF };
-
+    protected static final byte[] HEADER_SEPARATOR = { CR, LF, CR, LF };
 
     /**
      * A byte sequence that that follows a delimiter that will be
      * followed by an encapsulation (<code>CRLF</code>).
      */
-    protected static final byte[] FIELD_SEPARATOR = {
-        CR, LF};
-
+    protected static final byte[] FIELD_SEPARATOR = { CR, LF};
 
     /**
      * A byte sequence that that follows a delimiter of the last
      * encapsulation in the stream (<code>--</code>).
      */
-    protected static final byte[] STREAM_TERMINATOR = {
-        DASH, DASH};
-
+    protected static final byte[] STREAM_TERMINATOR = { DASH, DASH};
 
     /**
      * A byte sequence that precedes a boundary (<code>CRLF--</code>).
      */
-    protected static final byte[] BOUNDARY_PREFIX = {
-        CR, LF, DASH, DASH};
-
+    protected static final byte[] BOUNDARY_PREFIX = { CR, LF, DASH, DASH};
 
     // ----------------------------------------------------------- Data members
 
-
     /**
      * The input stream from which data is read.
      */
     private final InputStream input;
 
-
     /**
      * The length of the boundary token plus the leading <code>CRLF--</code>.
      */
     private int boundaryLength;
 
-
     /**
      * The amount of data, in bytes, that must be kept in the buffer in order
      * to detect delimiters reliably.
      */
     private int keepRegion;
 
-
     /**
      * The byte sequence that partitions the stream.
      */
     private byte[] boundary;
 
-
     /**
      * The length of the buffer used for processing the request.
      */
     private final int bufSize;
 
-
     /**
      * The buffer used for processing the request.
      */
     private final byte[] buffer;
 
-
     /**
      * The index of first valid character in the buffer.
      * <br>
@@ -248,7 +247,6 @@ public class MultipartStream {
      */
     private int head;
 
-
     /**
      * The index of last valid characer in the buffer + 1.
      * <br>
@@ -256,13 +254,11 @@ public class MultipartStream {
      */
     private int tail;
 
-
     /**
      * The content encoding to use when reading headers.
      */
     private String headerEncoding;
 
-
     /**
      * The progress notifier, if any, or null.
      */
@@ -272,6 +268,7 @@ public class MultipartStream {
 
     /**
      * Creates a new instance.
+     *
      * @deprecated Use {@link #MultipartStream(InputStream, byte[],
      * org.apache.commons.fileupload.MultipartStream.ProgressNotifier)},
      * or {@link #MultipartStream(InputStream, byte[], int,
@@ -347,7 +344,6 @@ public class MultipartStream {
         tail = 0;
     }
 
-
     /**
      * <p> Constructs a <code>MultipartStream</code> with a default size
buffer.
      *
@@ -386,12 +382,10 @@ public class MultipartStream {
 
     // --------------------------------------------------------- Public methods
 
-
     /**
      * Retrieves the character encoding used when reading the headers of an
      * individual part. When not specified, or <code>null</code>, the platform
      * default encoding is used.
-
      *
      * @return The encoding used to read part headers.
      */
@@ -399,7 +393,6 @@ public class MultipartStream {
         return headerEncoding;
     }
 
-
     /**
      * Specifies the character encoding to be used when reading the headers of
      * individual parts. When not specified, or <code>null</code>, the platform
@@ -411,7 +404,6 @@ public class MultipartStream {
         headerEncoding = encoding;
     }
 
-
     /**
      * Reads a byte from the <code>buffer</code>, and refills it as
      * necessary.
@@ -437,7 +429,6 @@ public class MultipartStream {
         return buffer[head++];
     }
 
-
     /**
      * Skips a <code>boundary</code> token, and checks whether more
      * <code>encapsulations</code> are contained in the stream.
@@ -481,7 +472,6 @@ public class MultipartStream {
         return nextChunk;
     }
 
-
     /**
      * <p>Changes the boundary token used for partitioning the stream.
      *
@@ -511,7 +501,6 @@ public class MultipartStream {
                 boundary.length);
     }
 
-
     /**
      * <p>Reads the <code>header-part</code> of the current
      * <code>encapsulation</code>.
@@ -527,8 +516,7 @@ public class MultipartStream {
      *
      * @throws MalformedStreamException if the stream ends unexpecetedly.
      */
-    public String readHeaders()
-    throws MalformedStreamException {
+    public String readHeaders() throws MalformedStreamException {
         int i = 0;
         byte b;
         // to support multi-byte characters
@@ -569,7 +557,6 @@ public class MultipartStream {
         return headers;
     }
 
-
     /**
      * <p>Reads <code>body-data</code> from the current
      * <code>encapsulation</code> and writes its contents into the
@@ -615,13 +602,10 @@ public class MultipartStream {
      * @throws MalformedStreamException if the stream ends unexpectedly.
      * @throws IOException              if an i/o error occurs.
      */
-    public int discardBodyData()
-    throws MalformedStreamException,
-    IOException {
+    public int discardBodyData() throws MalformedStreamException, IOException {
         return readBodyData(null);
     }
 
-
     /**
      * Finds the beginning of the first <code>encapsulation</code>.
      *
@@ -630,8 +614,7 @@ public class MultipartStream {
      *
      * @throws IOException if an i/o error occurs.
      */
-    public boolean skipPreamble()
-    throws IOException {
+    public boolean skipPreamble() throws IOException {
         // First delimiter may be not preceeded with a CRLF.
         System.arraycopy(boundary, 2, boundary, 0, boundary.length - 2);
         boundaryLength = boundary.length - 2;
@@ -653,7 +636,6 @@ public class MultipartStream {
         }
     }
 
-
     /**
      * Compares <code>count</code> first bytes in the arrays
      * <code>a</code> and <code>b</code>.
@@ -676,7 +658,6 @@ public class MultipartStream {
         return true;
     }
 
-
     /**
      * Searches for a byte of specified value in the <code>buffer</code>,
      * starting at the specified <code>position</code>.
@@ -698,7 +679,6 @@ public class MultipartStream {
         return -1;
     }
 
-
     /**
      * Searches for the <code>boundary</code> in the <code>buffer</code>
      * region delimited by <code>head</code> and <code>tail</code>.
@@ -734,8 +714,8 @@ public class MultipartStream {
      * Thrown to indicate that the input stream fails to follow the
      * required syntax.
      */
-    public static class MalformedStreamException
-    extends IOException {
+    public static class MalformedStreamException extends IOException {
+
         /**
          * The UID to use when serializing this instance.
          */
@@ -758,14 +738,14 @@ public class MultipartStream {
         public MalformedStreamException(String message) {
             super(message);
         }
-    }
 
+    }
 
     /**
      * Thrown upon attempt of setting an invalid boundary token.
      */
-    public static class IllegalBoundaryException
-            extends IOException {
+    public static class IllegalBoundaryException extends IOException {
+
         /**
          * The UID to use when serializing this instance.
          */
@@ -788,23 +768,32 @@ public class MultipartStream {
         public IllegalBoundaryException(String message) {
             super(message);
         }
+
     }
 
     /**
      * An {@link InputStream} for reading an items contents.
      */
     public class ItemInputStream extends InputStream implements Closeable {
-        /** The number of bytes, which have been read so far.
+
+        /**
+         * The number of bytes, which have been read so far.
          */
         private long total;
-        /** The number of bytes, which must be hold, because
+
+        /**
+         * The number of bytes, which must be hold, because
          * they might be a part of the boundary.
          */
         private int pad;
-        /** The current offset in the buffer.
+
+        /**
+         * The current offset in the buffer.
          */
         private int pos;
-        /** Whether the stream is already closed.
+
+        /**
+         * Whether the stream is already closed.
          */
         private boolean closed;
 
@@ -832,6 +821,7 @@ public class MultipartStream {
         /**
          * Returns the number of bytes, which have been read
          * by the stream.
+         *
          * @return Number of bytes, which have been read so far.
          */
         public long getBytesRead() {
@@ -841,6 +831,7 @@ public class MultipartStream {
         /**
          * Returns the number of bytes, which are currently
          * available, without blocking.
+         *
          * @throws IOException An I/O error occurs.
          * @return Number of bytes in the buffer.
          */
@@ -852,12 +843,14 @@ public class MultipartStream {
             return pos - head;
         }
 
-        /** Offset when converting negative bytes to integers.
+        /**
+         * Offset when converting negative bytes to integers.
          */
         private static final int BYTE_POSITIVE_OFFSET = 256;
 
         /**
          * Returns the next byte in the stream.
+         *
          * @return The next byte in the stream, as a non-negative
          *   integer, or -1 for EOF.
          * @throws IOException An I/O error occurred.
@@ -882,6 +875,7 @@ public class MultipartStream {
 
         /**
          * Reads bytes into the given buffer.
+         *
          * @param b The destination buffer, where to write to.
          * @param off Offset of the first byte in the buffer.
          * @param len Maximum number of bytes to read.
@@ -913,6 +907,7 @@ public class MultipartStream {
 
         /**
          * Closes the input stream.
+         *
          * @throws IOException An I/O error occurred.
          */
         @Override
@@ -922,6 +917,7 @@ public class MultipartStream {
 
         /**
          * Closes the input stream.
+         *
          * @param pCloseUnderlying Whether to close the underlying stream
          *   (hard close)
          * @throws IOException An I/O error occurred.
@@ -950,6 +946,7 @@ public class MultipartStream {
 
         /**
          * Skips the given number of bytes.
+         *
          * @param bytes Number of bytes to skip.
          * @return The number of bytes, which have actually been
          *   skipped.
@@ -974,6 +971,7 @@ public class MultipartStream {
 
         /**
          * Attempts to read more data.
+         *
          * @return Number of available bytes
          * @throws IOException An I/O error occurred.
          */
@@ -1015,10 +1013,13 @@ public class MultipartStream {
 
         /**
          * Returns, whether the stream is closed.
+         *
          * @return True, if the stream is closed, otherwise false.
          */
         public boolean isClosed() {
             return closed;
         }
+
     }
+
 }



Mime
View raw message