svn commit: r880688 - /james/mime4j/trunk/core/src/main/java/org/apache/james/mime4j/parser/MimeEntityConfig.java

[mwiederkehr]

Author: mwiederkehr
Date: Mon Nov 16 09:31:21 2009
New Revision: 880688

URL: http://svn.apache.org/viewvc?rev=880688&view=rev
Log:
An attempt to explain #setMaximalBodyDescriptor

Modified:
    
james/mime4j/trunk/core/src/main/java/org/apache/james/mime4j/parser/MimeEntityConfig.java

Modified: 
james/mime4j/trunk/core/src/main/java/org/apache/james/mime4j/parser/MimeEntityConfig.java
URL: 
http://svn.apache.org/viewvc/james/mime4j/trunk/core/src/main/java/org/apache/james/mime4j/parser/MimeEntityConfig.java?rev=880688&r1=880687&r2=880688&view=diff
==============================================================================
--- 
james/mime4j/trunk/core/src/main/java/org/apache/james/mime4j/parser/MimeEntityConfig.java
 (original)
+++ 
james/mime4j/trunk/core/src/main/java/org/apache/james/mime4j/parser/MimeEntityConfig.java
 Mon Nov 16 09:31:21 2009
@@ -43,10 +43,30 @@
         this.countLineNumbers = false;
     }
     
+    /**
+     * Returns <code>true</code> if the maximum body descriptor should be
+     * used, <code>false</code> for the default body descriptor.
+     *
+     * @see #setMaximalBodyDescriptor(boolean)
+     *
+     * @return value of maximum body descriptor.
+     */
     public boolean isMaximalBodyDescriptor() {
         return this.maximalBodyDescriptor;
     }
-    
+
+    /**
+     * Specified whether the parser should use an instance of
+     * {...@link MaximalBodyDescriptor} instead of {...@link 
DefaultBodyDescriptor} to
+     * encapsulate the values of MIME-specific header fields.
+     * <p>
+     * The body descriptor can be retrieved by calling
+     * {...@link MimeTokenStream#getBodyDescriptor()}.
+     *
+     * @param maximalBodyDescriptor <code>true</code> to use an instance of
+     *            {...@link MaximalBodyDescriptor}, <code>false</code> for an
+     *            instance of {...@link DefaultBodyDescriptor}.
+     */
     public void setMaximalBodyDescriptor(boolean maximalBodyDescriptor) {
         this.maximalBodyDescriptor = maximalBodyDescriptor;
     }