svn commit: r1781325 - /webservices/axiom/trunk/axiom-api/src/main/java/org/apache/axiom/mime/MIMEMessage.java

[ve...@apache.org]

Author: veithen
Date: Wed Feb  1 22:15:07 2017
New Revision: 1781325

URL: http://svn.apache.org/viewvc?rev=1781325&view=rev
Log:
Add more Javadoc to MIMEMessage.

Modified:
    webservices/axiom/trunk/axiom-api/src/main/java/org/apache/axiom/mime/MIMEMessage.java

Modified: webservices/axiom/trunk/axiom-api/src/main/java/org/apache/axiom/mime/MIMEMessage.java
URL: http://svn.apache.org/viewvc/webservices/axiom/trunk/axiom-api/src/main/java/org/apache/axiom/mime/MIMEMessage.java?rev=1781325&r1=1781324&r2=1781325&view=diff
==============================================================================
--- webservices/axiom/trunk/axiom-api/src/main/java/org/apache/axiom/mime/MIMEMessage.java (original)
+++ webservices/axiom/trunk/axiom-api/src/main/java/org/apache/axiom/mime/MIMEMessage.java Wed Feb  1 22:15:07 2017
@@ -41,7 +41,15 @@ import org.apache.james.mime4j.stream.Mi
 import org.apache.james.mime4j.stream.RecursionMode;
 
 /**
- * Represents a MIME multipart message read from a stream.
+ * A MIME multipart message read from a stream. This class exposes an API that represents the
+ * message as a sequence of {@link Part} instances. It implements the {@link Iterable} interface to
+ * enable access to all parts. In addition, it supports lookup by content ID. Data is read from the
+ * stream on demand. This means that the stream must be kept open until all parts have been
+ * processed or {@link #detach()} has been called. It also means that any invocation of a method on
+ * an instance of this class or an individual {@link Part} instance may trigger a
+ * {@link MIMEException} if there is an I/O error on the stream or a MIME parsing error.
+ * <p>
+ * Instances of this class are created using a fluent builder; see {@link #newBuilder()}.
  */
 public final class MIMEMessage implements Iterable<Part> {
     public interface PartCreationListener {