svn commit: r345440 - /webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/attachments/MIMEHelper.java

[di...@apache.org]

Author: dims
Date: Thu Nov 17 20:24:21 2005
New Revision: 345440

URL: http://svn.apache.org/viewcvs?rev=345440&view=rev
Log:
more cleanup.


Modified:
    webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/attachments/MIMEHelper.java

Modified: webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/attachments/MIMEHelper.java
URL: http://svn.apache.org/viewcvs/webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/attachments/MIMEHelper.java?rev=345440&r1=345439&r2=345440&view=diff
==============================================================================
--- webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/attachments/MIMEHelper.java (original)
+++ webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/attachments/MIMEHelper.java Thu Nov 17 20:24:21 2005
@@ -86,13 +86,14 @@
 
 
     /**
+     * Moves the pointer to the beginning of the first MIME part. Reads
+     * till first MIME boundary is found or end of stream is reached.
+     *
      * @param inStream
      * @param contentTypeString
      * @param fileCacheEnable
      * @param attachmentRepoDir
-     * @throws OMException
-     * Will move the pointer to the begining of the first MIME part. Will
-     *      read till first MIME boundary is found or end of stream reached.
+     * @throws OMException 
      */
     public MIMEHelper(InputStream inStream, String contentTypeString,
                       boolean fileCacheEnable, String attachmentRepoDir,
@@ -121,7 +122,7 @@
         pushbackInStream = new PushbackInputStream(inStream,
                 (this.boundary.length + 2));
 
-        // Move the read pointer to the begining of the first part
+        // Move the read pointer to the beginning of the first part
         // read till the end of first boundary
         while (true) {
             int value;
@@ -152,10 +153,11 @@
     }
 
     /**
+     * Sets file cache to false.
+     *
      * @param inStream
      * @param contentTypeString
      * @throws OMException
-     * Will set file cache to false
      */
     public MIMEHelper(InputStream inStream, String contentTypeString)
             throws OMException {
@@ -163,8 +165,8 @@
     }
 
     /**
-     * @return whether Message Type is SOAP with Attachments or MTOM optimised
-     *         by checking the application type parameter in the Contant Type
+     * @return whether Message Type is SOAP with Attachments or MTOM optimized,
+     *         by checking the application type parameter in the Content Type.
      */
     public String getAttachmentSpecType() {
         if (this.applicationType == null) {
@@ -182,9 +184,9 @@
     }
 
     /**
-     * @return the InputStream which includes the SOAP Envelope We assumes that
+     * @return the InputStream which includes the SOAP Envelope. It assumes that
      *         the root mime part is always pointed by "start" parameter in
-     *         content-type
+     *         content-type.
      */
     public InputStream getSOAPPartInputStream() throws OMException {
         DataHandler dh;
@@ -244,7 +246,7 @@
     /**
      * @param blobContentID
      *            (without the surrounding angle brackets and "cid:" prefix)
-     * @return The DataHandler of the mime part refered by the content-Id
+     * @return The DataHandler of the mime part referred by the Content-Id
      * @throws OMException
      */
     public DataHandler getDataHandler(String blobContentID) throws OMException {
@@ -259,12 +261,14 @@
     }
 
     /**
+     * Checks whether the MIME part is already parsed by checking the
+     * parts HashMap. If it is not parsed yet then call the getNextPart()
+     * till the required part is found.
+     *
      * @param blobContentID
-     * @return The Part refered by the content-Id
+     * @return The Part referred by the Content-Id
      * @throws OMException
-     * First checks whether the MIME part is already parsed by checking the
-     * parts HashMap. If it is not parsed yet then call the getNextPart()
-     * till we find the required part.
+     * 
      */
     public Part getPart(String blobContentID) {
         Part bodyPart;
@@ -296,7 +300,7 @@
     /**
      * @return the Next valid MIME part + store the Part in the Parts List
      * @throws OMException
-     *             throw if cotent id is null or if two MIME parts contain the
+     *             throw if content id is null or if two MIME parts contain the
      *             same content-ID & the exceptions throws by getPart()
      */
     private Part getNextPart() throws OMException {