james-mime4j-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ol...@apache.org
Subject svn commit: r1147109 - in /james/mime4j/trunk: core/src/main/java/org/apache/james/mime4j/stream/ dom/src/main/java/org/apache/james/mime4j/dom/ dom/src/main/java/org/apache/james/mime4j/dom/field/ dom/src/main/java/org/apache/james/mime4j/field/addres...
Date Fri, 15 Jul 2011 11:57:12 GMT
Author: olegk
Date: Fri Jul 15 11:57:09 2011
New Revision: 1147109

URL: http://svn.apache.org/viewvc?rev=1147109&view=rev
Log:
Updated javadocs for mime4j dom classes

Modified:
    james/mime4j/trunk/core/src/main/java/org/apache/james/mime4j/stream/BodyDescriptor.java
    james/mime4j/trunk/core/src/main/java/org/apache/james/mime4j/stream/ContentDescriptor.java
    james/mime4j/trunk/dom/src/main/java/org/apache/james/mime4j/dom/Body.java
    james/mime4j/trunk/dom/src/main/java/org/apache/james/mime4j/dom/Entity.java
    james/mime4j/trunk/dom/src/main/java/org/apache/james/mime4j/dom/FieldParser.java
    james/mime4j/trunk/dom/src/main/java/org/apache/james/mime4j/dom/Header.java
    james/mime4j/trunk/dom/src/main/java/org/apache/james/mime4j/dom/Message.java
    james/mime4j/trunk/dom/src/main/java/org/apache/james/mime4j/dom/MessageBuilder.java
    james/mime4j/trunk/dom/src/main/java/org/apache/james/mime4j/dom/MessageWriter.java
    james/mime4j/trunk/dom/src/main/java/org/apache/james/mime4j/dom/Multipart.java
    james/mime4j/trunk/dom/src/main/java/org/apache/james/mime4j/dom/field/ParsedField.java
    james/mime4j/trunk/dom/src/main/java/org/apache/james/mime4j/field/address/AddressBuilder.java
    james/mime4j/trunk/dom/src/main/java/org/apache/james/mime4j/field/address/AddressFormatter.java
    james/mime4j/trunk/dom/src/main/java/org/apache/james/mime4j/field/address/LenientAddressBuilder.java
    james/mime4j/trunk/dom/src/main/java/org/apache/james/mime4j/message/AbstractEntity.java
    james/mime4j/trunk/dom/src/main/java/org/apache/james/mime4j/message/AbstractHeader.java
    james/mime4j/trunk/dom/src/main/java/org/apache/james/mime4j/message/AbstractMessage.java
    james/mime4j/trunk/dom/src/main/java/org/apache/james/mime4j/message/AbstractMultipart.java
    james/mime4j/trunk/dom/src/main/java/org/apache/james/mime4j/message/BodyPart.java
    james/mime4j/trunk/dom/src/main/java/org/apache/james/mime4j/message/DefaultBodyDescriptorBuilder.java
    james/mime4j/trunk/dom/src/main/java/org/apache/james/mime4j/message/DefaultMessageBuilder.java
    james/mime4j/trunk/dom/src/main/java/org/apache/james/mime4j/message/DefaultMessageWriter.java
    james/mime4j/trunk/dom/src/main/java/org/apache/james/mime4j/message/HeaderImpl.java
    james/mime4j/trunk/dom/src/main/java/org/apache/james/mime4j/message/MaximalBodyDescriptor.java
    james/mime4j/trunk/dom/src/main/java/org/apache/james/mime4j/message/MessageImpl.java
    james/mime4j/trunk/dom/src/main/java/org/apache/james/mime4j/message/MultipartImpl.java
    james/mime4j/trunk/dom/src/main/java/org/apache/james/mime4j/message/SimpleContentHandler.java

Modified: james/mime4j/trunk/core/src/main/java/org/apache/james/mime4j/stream/BodyDescriptor.java
URL: http://svn.apache.org/viewvc/james/mime4j/trunk/core/src/main/java/org/apache/james/mime4j/stream/BodyDescriptor.java?rev=1147109&r1=1147108&r2=1147109&view=diff
==============================================================================
--- james/mime4j/trunk/core/src/main/java/org/apache/james/mime4j/stream/BodyDescriptor.java
(original)
+++ james/mime4j/trunk/core/src/main/java/org/apache/james/mime4j/stream/BodyDescriptor.java
Fri Jul 15 11:57:09 2011
@@ -20,7 +20,7 @@
 package org.apache.james.mime4j.stream;
 
 /**
- * Descriptor containing common MIME content body properties.
+ * A descriptor containing common MIME content body properties.
  */
 public interface BodyDescriptor extends ContentDescriptor {
 

Modified: james/mime4j/trunk/core/src/main/java/org/apache/james/mime4j/stream/ContentDescriptor.java
URL: http://svn.apache.org/viewvc/james/mime4j/trunk/core/src/main/java/org/apache/james/mime4j/stream/ContentDescriptor.java?rev=1147109&r1=1147108&r2=1147109&view=diff
==============================================================================
--- james/mime4j/trunk/core/src/main/java/org/apache/james/mime4j/stream/ContentDescriptor.java
(original)
+++ james/mime4j/trunk/core/src/main/java/org/apache/james/mime4j/stream/ContentDescriptor.java
Fri Jul 15 11:57:09 2011
@@ -20,7 +20,7 @@
 package org.apache.james.mime4j.stream;
 
 /**
- * Descriptor containing common MIME content properties.
+ * A descriptor containing common MIME content properties.
  */
 public interface ContentDescriptor {
 

Modified: james/mime4j/trunk/dom/src/main/java/org/apache/james/mime4j/dom/Body.java
URL: http://svn.apache.org/viewvc/james/mime4j/trunk/dom/src/main/java/org/apache/james/mime4j/dom/Body.java?rev=1147109&r1=1147108&r2=1147109&view=diff
==============================================================================
--- james/mime4j/trunk/dom/src/main/java/org/apache/james/mime4j/dom/Body.java (original)
+++ james/mime4j/trunk/dom/src/main/java/org/apache/james/mime4j/dom/Body.java Fri Jul 15
11:57:09 2011
@@ -20,8 +20,8 @@
 package org.apache.james.mime4j.dom;
 
 /**
- * Encapsulates the body of an entity (see RFC 2045).
- * <p>
+ * A body of an MIME entity (as defined in RFC 2045).
+ * <p/>
  * A body can be a {@link Message}, a {@link Multipart} or a {@link SingleBody}.
  * This interface should not be implemented directly by classes other than
  * those.

Modified: james/mime4j/trunk/dom/src/main/java/org/apache/james/mime4j/dom/Entity.java
URL: http://svn.apache.org/viewvc/james/mime4j/trunk/dom/src/main/java/org/apache/james/mime4j/dom/Entity.java?rev=1147109&r1=1147108&r2=1147109&view=diff
==============================================================================
--- james/mime4j/trunk/dom/src/main/java/org/apache/james/mime4j/dom/Entity.java (original)
+++ james/mime4j/trunk/dom/src/main/java/org/apache/james/mime4j/dom/Entity.java Fri Jul 15
11:57:09 2011
@@ -20,7 +20,7 @@
 package org.apache.james.mime4j.dom;
 
 /**
- * MIME entity. An entity has a header and a body (see RFC 2045).
+ * A MIME entity. An entity has a header and a body (as defined in RFC 2045).
  */
 public interface Entity extends Disposable {
 

Modified: james/mime4j/trunk/dom/src/main/java/org/apache/james/mime4j/dom/FieldParser.java
URL: http://svn.apache.org/viewvc/james/mime4j/trunk/dom/src/main/java/org/apache/james/mime4j/dom/FieldParser.java?rev=1147109&r1=1147108&r2=1147109&view=diff
==============================================================================
--- james/mime4j/trunk/dom/src/main/java/org/apache/james/mime4j/dom/FieldParser.java (original)
+++ james/mime4j/trunk/dom/src/main/java/org/apache/james/mime4j/dom/FieldParser.java Fri
Jul 15 11:57:09 2011
@@ -23,8 +23,15 @@ import org.apache.james.mime4j.codec.Dec
 import org.apache.james.mime4j.dom.field.ParsedField;
 import org.apache.james.mime4j.stream.Field;
 
+/**
+ * A parser or transformation process intended to convert raw (unstructured) {@link Field}s
into
+ * structured {@link ParsedField}s.
+ */
 public interface FieldParser<T extends ParsedField> {
 
+    /**
+     * Parses raw (unstructured) field and converts it into a structured field.
+     */
     T parse(Field rawField, DecodeMonitor monitor);
 
 }

Modified: james/mime4j/trunk/dom/src/main/java/org/apache/james/mime4j/dom/Header.java
URL: http://svn.apache.org/viewvc/james/mime4j/trunk/dom/src/main/java/org/apache/james/mime4j/dom/Header.java?rev=1147109&r1=1147108&r2=1147109&view=diff
==============================================================================
--- james/mime4j/trunk/dom/src/main/java/org/apache/james/mime4j/dom/Header.java (original)
+++ james/mime4j/trunk/dom/src/main/java/org/apache/james/mime4j/dom/Header.java Fri Jul 15
11:57:09 2011
@@ -25,7 +25,7 @@ import java.util.List;
 import org.apache.james.mime4j.stream.Field;
 
 /**
- * The header of an entity (see RFC 2045).
+ * A header of an MIME entity (as defined in RFC 2045).
  */
 public interface Header extends Iterable<Field> {
 

Modified: james/mime4j/trunk/dom/src/main/java/org/apache/james/mime4j/dom/Message.java
URL: http://svn.apache.org/viewvc/james/mime4j/trunk/dom/src/main/java/org/apache/james/mime4j/dom/Message.java?rev=1147109&r1=1147108&r2=1147109&view=diff
==============================================================================
--- james/mime4j/trunk/dom/src/main/java/org/apache/james/mime4j/dom/Message.java (original)
+++ james/mime4j/trunk/dom/src/main/java/org/apache/james/mime4j/dom/Message.java Fri Jul
15 11:57:09 2011
@@ -28,6 +28,9 @@ import org.apache.james.mime4j.dom.addre
 import org.apache.james.mime4j.dom.address.Mailbox;
 import org.apache.james.mime4j.dom.address.MailboxList;
 
+/**
+ * An MIME message (as defined in RFC 2045).
+ */
 public interface Message extends Entity, Body {
 
     /**

Modified: james/mime4j/trunk/dom/src/main/java/org/apache/james/mime4j/dom/MessageBuilder.java
URL: http://svn.apache.org/viewvc/james/mime4j/trunk/dom/src/main/java/org/apache/james/mime4j/dom/MessageBuilder.java?rev=1147109&r1=1147108&r2=1147109&view=diff
==============================================================================
--- james/mime4j/trunk/dom/src/main/java/org/apache/james/mime4j/dom/MessageBuilder.java (original)
+++ james/mime4j/trunk/dom/src/main/java/org/apache/james/mime4j/dom/MessageBuilder.java Fri
Jul 15 11:57:09 2011
@@ -25,7 +25,9 @@ import java.io.InputStream;
 import org.apache.james.mime4j.MimeException;
 
 /**
- * Defines the API to obtain Message instances from a mime stream.
+ * An interface to build instances of {@link Message} and other DOM elements either without
+ * any content, by copying content of an existing object or by reading content from
+ * an {@link InputStream}.
  */
 public interface MessageBuilder {
 

Modified: james/mime4j/trunk/dom/src/main/java/org/apache/james/mime4j/dom/MessageWriter.java
URL: http://svn.apache.org/viewvc/james/mime4j/trunk/dom/src/main/java/org/apache/james/mime4j/dom/MessageWriter.java?rev=1147109&r1=1147108&r2=1147109&view=diff
==============================================================================
--- james/mime4j/trunk/dom/src/main/java/org/apache/james/mime4j/dom/MessageWriter.java (original)
+++ james/mime4j/trunk/dom/src/main/java/org/apache/james/mime4j/dom/MessageWriter.java Fri
Jul 15 11:57:09 2011
@@ -25,7 +25,8 @@ import java.io.OutputStream;
 import org.apache.james.mime4j.stream.Field;
 
 /**
- * Defines the API to write Message and other DOM objects to an output stream.
+ * An interface to write out content of {@link Message} and other DOM elements to
+ * an {@link OutputStream}.
  */
 public interface MessageWriter {
 

Modified: james/mime4j/trunk/dom/src/main/java/org/apache/james/mime4j/dom/Multipart.java
URL: http://svn.apache.org/viewvc/james/mime4j/trunk/dom/src/main/java/org/apache/james/mime4j/dom/Multipart.java?rev=1147109&r1=1147108&r2=1147109&view=diff
==============================================================================
--- james/mime4j/trunk/dom/src/main/java/org/apache/james/mime4j/dom/Multipart.java (original)
+++ james/mime4j/trunk/dom/src/main/java/org/apache/james/mime4j/dom/Multipart.java Fri Jul
15 11:57:09 2011
@@ -22,11 +22,10 @@ package org.apache.james.mime4j.dom;
 import java.util.List;
 
 /**
- * Represents a MIME multipart body (see RFC 2045).A multipart body has a
- * ordered list of body parts. The multipart body also has a preamble and
- * epilogue. The preamble consists of whatever characters appear before the
- * first body part while the epilogue consists of whatever characters come after
- * the last body part.
+ * A MIME multipart body (as defined in RFC 2045). A multipart body has a ordered list of
+ * body parts. The multipart body also has a preamble and epilogue. The preamble consists
of
+ * whatever characters appear before the first body part while the epilogue consists of whatever
+ * characters come after the last body part.
  */
 public interface Multipart extends Body {
 

Modified: james/mime4j/trunk/dom/src/main/java/org/apache/james/mime4j/dom/field/ParsedField.java
URL: http://svn.apache.org/viewvc/james/mime4j/trunk/dom/src/main/java/org/apache/james/mime4j/dom/field/ParsedField.java?rev=1147109&r1=1147108&r2=1147109&view=diff
==============================================================================
--- james/mime4j/trunk/dom/src/main/java/org/apache/james/mime4j/dom/field/ParsedField.java
(original)
+++ james/mime4j/trunk/dom/src/main/java/org/apache/james/mime4j/dom/field/ParsedField.java
Fri Jul 15 11:57:09 2011
@@ -21,7 +21,9 @@ package org.apache.james.mime4j.dom.fiel
 
 import org.apache.james.mime4j.stream.Field;
 
-
+/**
+ * A structured field that has been processed by a parsing routine.
+ */
 public interface ParsedField extends Field {
 
     /**

Modified: james/mime4j/trunk/dom/src/main/java/org/apache/james/mime4j/field/address/AddressBuilder.java
URL: http://svn.apache.org/viewvc/james/mime4j/trunk/dom/src/main/java/org/apache/james/mime4j/field/address/AddressBuilder.java?rev=1147109&r1=1147108&r2=1147109&view=diff
==============================================================================
--- james/mime4j/trunk/dom/src/main/java/org/apache/james/mime4j/field/address/AddressBuilder.java
(original)
+++ james/mime4j/trunk/dom/src/main/java/org/apache/james/mime4j/field/address/AddressBuilder.java
Fri Jul 15 11:57:09 2011
@@ -27,6 +27,9 @@ import org.apache.james.mime4j.dom.addre
 import org.apache.james.mime4j.dom.address.Group;
 import org.apache.james.mime4j.dom.address.Mailbox;
 
+/**
+ * Default (strict) builder for {@link Address} and its subclasses.
+ */
 public class AddressBuilder {
 
     public static final AddressBuilder DEFAULT = new AddressBuilder();

Modified: james/mime4j/trunk/dom/src/main/java/org/apache/james/mime4j/field/address/AddressFormatter.java
URL: http://svn.apache.org/viewvc/james/mime4j/trunk/dom/src/main/java/org/apache/james/mime4j/field/address/AddressFormatter.java?rev=1147109&r1=1147108&r2=1147109&view=diff
==============================================================================
--- james/mime4j/trunk/dom/src/main/java/org/apache/james/mime4j/field/address/AddressFormatter.java
(original)
+++ james/mime4j/trunk/dom/src/main/java/org/apache/james/mime4j/field/address/AddressFormatter.java
Fri Jul 15 11:57:09 2011
@@ -24,6 +24,9 @@ import org.apache.james.mime4j.dom.addre
 import org.apache.james.mime4j.dom.address.Group;
 import org.apache.james.mime4j.dom.address.Mailbox;
 
+/**
+ * Default formatter for {@link Address} and its subclasses.
+ */
 public class AddressFormatter {
 
     public static final AddressFormatter DEFAULT = new AddressFormatter();
@@ -51,7 +54,6 @@ public class AddressFormatter {
      * @param includeRoute
      *            <code>true</code> if the route should be included if it
      *            exists, <code>false</code> otherwise.
-     * @return a string representation of this address intended to be displayed.
      */
     public void format(final StringBuilder sb, final Address address, boolean includeRoute)
{
         if (address == null) {
@@ -71,9 +73,6 @@ public class AddressFormatter {
      * transport purposes. The route is never included in this representation
      * because routes are obsolete and RFC 5322 states that obsolete syntactic
      * forms MUST NOT be generated.
-     *
-     * @return a string representation of this address intended for transport
-     *         purposes.
      */
     public void encode(final StringBuilder sb, final Address address) {
         if (address == null) {

Modified: james/mime4j/trunk/dom/src/main/java/org/apache/james/mime4j/field/address/LenientAddressBuilder.java
URL: http://svn.apache.org/viewvc/james/mime4j/trunk/dom/src/main/java/org/apache/james/mime4j/field/address/LenientAddressBuilder.java?rev=1147109&r1=1147108&r2=1147109&view=diff
==============================================================================
--- james/mime4j/trunk/dom/src/main/java/org/apache/james/mime4j/field/address/LenientAddressBuilder.java
(original)
+++ james/mime4j/trunk/dom/src/main/java/org/apache/james/mime4j/field/address/LenientAddressBuilder.java
Fri Jul 15 11:57:09 2011
@@ -35,6 +35,10 @@ import org.apache.james.mime4j.util.Byte
 import org.apache.james.mime4j.util.CharsetUtil;
 import org.apache.james.mime4j.util.ContentUtil;
 
+/**
+ * Lenient (tolerant to non-critical format violations) builder for {@link Address}
+ * and its subclasses.
+ */
 public class LenientAddressBuilder {
 
     private static final int AT                = '@';

Modified: james/mime4j/trunk/dom/src/main/java/org/apache/james/mime4j/message/AbstractEntity.java
URL: http://svn.apache.org/viewvc/james/mime4j/trunk/dom/src/main/java/org/apache/james/mime4j/message/AbstractEntity.java?rev=1147109&r1=1147108&r2=1147109&view=diff
==============================================================================
--- james/mime4j/trunk/dom/src/main/java/org/apache/james/mime4j/message/AbstractEntity.java
(original)
+++ james/mime4j/trunk/dom/src/main/java/org/apache/james/mime4j/message/AbstractEntity.java
Fri Jul 15 11:57:09 2011
@@ -38,7 +38,7 @@ import org.apache.james.mime4j.dom.field
 import org.apache.james.mime4j.dom.field.ParsedField;
 
 /**
- * MIME entity. An entity has a header and a body (see RFC 2045).
+ * Abstract MIME entity.
  */
 public abstract class AbstractEntity implements Entity {
     private Header header = null;
@@ -188,7 +188,7 @@ public abstract class AbstractEntity imp
      *
      * @param textBody
      *            the <code>TextBody</code> to set as body.
-     * @see org.apache.james.mime4j.message.BodyFactory#textBody(String)
+     * @see org.apache.james.mime4j.message.BodyFactory#textBody(java.io.InputStream, String)
      */
     public void setText(TextBody textBody) {
         setText(textBody, "plain");
@@ -205,7 +205,6 @@ public abstract class AbstractEntity imp
      * @param subtype
      *            the text subtype (e.g. &quot;plain&quot;, &quot;html&quot;
or
      *            &quot;xml&quot;).
-     * @see org.apache.james.mime4j.message.BodyFactory#textBody(String)
      */
     public void setText(TextBody textBody, String subtype) {
         String mimeType = "text/" + subtype;

Modified: james/mime4j/trunk/dom/src/main/java/org/apache/james/mime4j/message/AbstractHeader.java
URL: http://svn.apache.org/viewvc/james/mime4j/trunk/dom/src/main/java/org/apache/james/mime4j/message/AbstractHeader.java?rev=1147109&r1=1147108&r2=1147109&view=diff
==============================================================================
--- james/mime4j/trunk/dom/src/main/java/org/apache/james/mime4j/message/AbstractHeader.java
(original)
+++ james/mime4j/trunk/dom/src/main/java/org/apache/james/mime4j/message/AbstractHeader.java
Fri Jul 15 11:57:09 2011
@@ -30,7 +30,7 @@ import org.apache.james.mime4j.dom.Heade
 import org.apache.james.mime4j.stream.Field;
 
 /**
- * The header of an entity (see RFC 2045).
+ * Abstract MIME header.
  */
 public abstract class AbstractHeader implements Header {
 

Modified: james/mime4j/trunk/dom/src/main/java/org/apache/james/mime4j/message/AbstractMessage.java
URL: http://svn.apache.org/viewvc/james/mime4j/trunk/dom/src/main/java/org/apache/james/mime4j/message/AbstractMessage.java?rev=1147109&r1=1147108&r2=1147109&view=diff
==============================================================================
--- james/mime4j/trunk/dom/src/main/java/org/apache/james/mime4j/message/AbstractMessage.java
(original)
+++ james/mime4j/trunk/dom/src/main/java/org/apache/james/mime4j/message/AbstractMessage.java
Fri Jul 15 11:57:09 2011
@@ -40,6 +40,9 @@ import org.apache.james.mime4j.dom.field
 import org.apache.james.mime4j.dom.field.UnstructuredField;
 import org.apache.james.mime4j.stream.Field;
 
+/**
+ * Abstract MIME message.
+ */
 public abstract class AbstractMessage extends AbstractEntity implements Message {
 
     /**

Modified: james/mime4j/trunk/dom/src/main/java/org/apache/james/mime4j/message/AbstractMultipart.java
URL: http://svn.apache.org/viewvc/james/mime4j/trunk/dom/src/main/java/org/apache/james/mime4j/message/AbstractMultipart.java?rev=1147109&r1=1147108&r2=1147109&view=diff
==============================================================================
--- james/mime4j/trunk/dom/src/main/java/org/apache/james/mime4j/message/AbstractMultipart.java
(original)
+++ james/mime4j/trunk/dom/src/main/java/org/apache/james/mime4j/message/AbstractMultipart.java
Fri Jul 15 11:57:09 2011
@@ -27,11 +27,7 @@ import org.apache.james.mime4j.dom.Entit
 import org.apache.james.mime4j.dom.Multipart;
 
 /**
- * Represents a MIME multipart body (see RFC 2045).A multipart body has a
- * ordered list of body parts. The multipart body also has a preamble and
- * epilogue. The preamble consists of whatever characters appear before the
- * first body part while the epilogue consists of whatever characters come after
- * the last body part.
+ * Abstract MIME multipart body.
  */
 public abstract class AbstractMultipart implements Multipart {
 

Modified: james/mime4j/trunk/dom/src/main/java/org/apache/james/mime4j/message/BodyPart.java
URL: http://svn.apache.org/viewvc/james/mime4j/trunk/dom/src/main/java/org/apache/james/mime4j/message/BodyPart.java?rev=1147109&r1=1147108&r2=1147109&view=diff
==============================================================================
--- james/mime4j/trunk/dom/src/main/java/org/apache/james/mime4j/message/BodyPart.java (original)
+++ james/mime4j/trunk/dom/src/main/java/org/apache/james/mime4j/message/BodyPart.java Fri
Jul 15 11:57:09 2011
@@ -31,7 +31,7 @@ import org.apache.james.mime4j.field.Fie
 import org.apache.james.mime4j.util.MimeUtil;
 
 /**
- * Represents a MIME body part  (see RFC 2045).
+ * A MIME body part (as defined in RFC 2045).
  */
 public class BodyPart extends AbstractEntity {
 

Modified: james/mime4j/trunk/dom/src/main/java/org/apache/james/mime4j/message/DefaultBodyDescriptorBuilder.java
URL: http://svn.apache.org/viewvc/james/mime4j/trunk/dom/src/main/java/org/apache/james/mime4j/message/DefaultBodyDescriptorBuilder.java?rev=1147109&r1=1147108&r2=1147109&view=diff
==============================================================================
--- james/mime4j/trunk/dom/src/main/java/org/apache/james/mime4j/message/DefaultBodyDescriptorBuilder.java
(original)
+++ james/mime4j/trunk/dom/src/main/java/org/apache/james/mime4j/message/DefaultBodyDescriptorBuilder.java
Fri Jul 15 11:57:09 2011
@@ -36,6 +36,9 @@ import org.apache.james.mime4j.stream.Fi
 import org.apache.james.mime4j.stream.RawField;
 import org.apache.james.mime4j.util.MimeUtil;
 
+/**
+ * Default {@link BodyDescriptorBuilder} implementation.
+ */
 public class DefaultBodyDescriptorBuilder implements BodyDescriptorBuilder {
 
     private static final String CONTENT_TYPE = FieldName.CONTENT_TYPE.toLowerCase(Locale.US);
@@ -67,9 +70,6 @@ public class DefaultBodyDescriptorBuilde
 
     /**
      * Creates a new <code>BodyDescriptor</code> instance.
-     *
-     * @param parent the descriptor of the parent or <code>null</code> if this
-     *        is the root descriptor.
      */
     public DefaultBodyDescriptorBuilder(
             final String parentMimeType,

Modified: james/mime4j/trunk/dom/src/main/java/org/apache/james/mime4j/message/DefaultMessageBuilder.java
URL: http://svn.apache.org/viewvc/james/mime4j/trunk/dom/src/main/java/org/apache/james/mime4j/message/DefaultMessageBuilder.java?rev=1147109&r1=1147108&r2=1147109&view=diff
==============================================================================
--- james/mime4j/trunk/dom/src/main/java/org/apache/james/mime4j/message/DefaultMessageBuilder.java
(original)
+++ james/mime4j/trunk/dom/src/main/java/org/apache/james/mime4j/message/DefaultMessageBuilder.java
Fri Jul 15 11:57:09 2011
@@ -44,7 +44,7 @@ import org.apache.james.mime4j.stream.Fi
 import org.apache.james.mime4j.stream.MimeEntityConfig;
 
 /**
- * Utility class for copying message and parsing message elements.
+ * Default implementation of {@link MessageBuilder}.
  */
 public class DefaultMessageBuilder implements MessageBuilder {
 

Modified: james/mime4j/trunk/dom/src/main/java/org/apache/james/mime4j/message/DefaultMessageWriter.java
URL: http://svn.apache.org/viewvc/james/mime4j/trunk/dom/src/main/java/org/apache/james/mime4j/message/DefaultMessageWriter.java?rev=1147109&r1=1147108&r2=1147109&view=diff
==============================================================================
--- james/mime4j/trunk/dom/src/main/java/org/apache/james/mime4j/message/DefaultMessageWriter.java
(original)
+++ james/mime4j/trunk/dom/src/main/java/org/apache/james/mime4j/message/DefaultMessageWriter.java
Fri Jul 15 11:57:09 2011
@@ -40,7 +40,7 @@ import org.apache.james.mime4j.util.Cont
 import org.apache.james.mime4j.util.MimeUtil;
 
 /**
- * Writes a message (or a part of a message) to an output stream.
+ * Default implementation of {@link MessageWriter}.
  */
 public class DefaultMessageWriter implements MessageWriter {
 
@@ -112,7 +112,7 @@ public class DefaultMessageWriter implem
      * Write the specified <code>Message</code> to the specified
      * <code>OutputStream</code>.
      *
-     * @param entity
+     * @param message
      *            the <code>Message</code> to write.
      * @param out
      *            the OutputStream to write to.

Modified: james/mime4j/trunk/dom/src/main/java/org/apache/james/mime4j/message/HeaderImpl.java
URL: http://svn.apache.org/viewvc/james/mime4j/trunk/dom/src/main/java/org/apache/james/mime4j/message/HeaderImpl.java?rev=1147109&r1=1147108&r2=1147109&view=diff
==============================================================================
--- james/mime4j/trunk/dom/src/main/java/org/apache/james/mime4j/message/HeaderImpl.java (original)
+++ james/mime4j/trunk/dom/src/main/java/org/apache/james/mime4j/message/HeaderImpl.java Fri
Jul 15 11:57:09 2011
@@ -19,8 +19,10 @@
 
 package org.apache.james.mime4j.message;
 
+import org.apache.james.mime4j.dom.Header;
+
 /**
- * The header of an entity (see RFC 2045).
+ * Default implementation of {@link Header}.
  */
 public class HeaderImpl extends AbstractHeader {
 

Modified: james/mime4j/trunk/dom/src/main/java/org/apache/james/mime4j/message/MaximalBodyDescriptor.java
URL: http://svn.apache.org/viewvc/james/mime4j/trunk/dom/src/main/java/org/apache/james/mime4j/message/MaximalBodyDescriptor.java?rev=1147109&r1=1147108&r2=1147109&view=diff
==============================================================================
--- james/mime4j/trunk/dom/src/main/java/org/apache/james/mime4j/message/MaximalBodyDescriptor.java
(original)
+++ james/mime4j/trunk/dom/src/main/java/org/apache/james/mime4j/message/MaximalBodyDescriptor.java
Fri Jul 15 11:57:09 2011
@@ -43,8 +43,7 @@ import org.apache.james.mime4j.stream.Bo
 import org.apache.james.mime4j.util.MimeUtil;
 
 /**
- * Parses and stores values for standard MIME header values.
- *
+ * Extended {@link BodyDescriptor} implementation with complete content details.
  */
 public class MaximalBodyDescriptor implements BodyDescriptor {
 

Modified: james/mime4j/trunk/dom/src/main/java/org/apache/james/mime4j/message/MessageImpl.java
URL: http://svn.apache.org/viewvc/james/mime4j/trunk/dom/src/main/java/org/apache/james/mime4j/message/MessageImpl.java?rev=1147109&r1=1147108&r2=1147109&view=diff
==============================================================================
--- james/mime4j/trunk/dom/src/main/java/org/apache/james/mime4j/message/MessageImpl.java
(original)
+++ james/mime4j/trunk/dom/src/main/java/org/apache/james/mime4j/message/MessageImpl.java
Fri Jul 15 11:57:09 2011
@@ -24,6 +24,7 @@ import java.util.Date;
 import java.util.Map;
 import java.util.TimeZone;
 
+import org.apache.james.mime4j.dom.Message;
 import org.apache.james.mime4j.dom.address.Address;
 import org.apache.james.mime4j.dom.address.Mailbox;
 import org.apache.james.mime4j.dom.field.AddressListField;
@@ -41,7 +42,7 @@ import org.apache.james.mime4j.field.Fie
 import org.apache.james.mime4j.util.MimeUtil;
 
 /**
- * Represents a MIME message.
+ * Default implementation of {@link Message}.
  */
 public class MessageImpl extends AbstractMessage {
 

Modified: james/mime4j/trunk/dom/src/main/java/org/apache/james/mime4j/message/MultipartImpl.java
URL: http://svn.apache.org/viewvc/james/mime4j/trunk/dom/src/main/java/org/apache/james/mime4j/message/MultipartImpl.java?rev=1147109&r1=1147108&r2=1147109&view=diff
==============================================================================
--- james/mime4j/trunk/dom/src/main/java/org/apache/james/mime4j/message/MultipartImpl.java
(original)
+++ james/mime4j/trunk/dom/src/main/java/org/apache/james/mime4j/message/MultipartImpl.java
Fri Jul 15 11:57:09 2011
@@ -19,15 +19,12 @@
 
 package org.apache.james.mime4j.message;
 
+import org.apache.james.mime4j.dom.Multipart;
 import org.apache.james.mime4j.util.ByteSequence;
 import org.apache.james.mime4j.util.ContentUtil;
 
 /**
- * Represents a MIME multipart body (see RFC 2045).A multipart body has a
- * ordered list of body parts. The multipart body also has a preamble and
- * epilogue. The preamble consists of whatever characters appear before the
- * first body part while the epilogue consists of whatever characters come after
- * the last body part.
+ * Default implementation of {@link Multipart}.
  */
 public class MultipartImpl extends AbstractMultipart {
 

Modified: james/mime4j/trunk/dom/src/main/java/org/apache/james/mime4j/message/SimpleContentHandler.java
URL: http://svn.apache.org/viewvc/james/mime4j/trunk/dom/src/main/java/org/apache/james/mime4j/message/SimpleContentHandler.java?rev=1147109&r1=1147108&r2=1147109&view=diff
==============================================================================
--- james/mime4j/trunk/dom/src/main/java/org/apache/james/mime4j/message/SimpleContentHandler.java
(original)
+++ james/mime4j/trunk/dom/src/main/java/org/apache/james/mime4j/message/SimpleContentHandler.java
Fri Jul 15 11:57:09 2011
@@ -27,7 +27,6 @@ import org.apache.james.mime4j.dom.field
 import org.apache.james.mime4j.field.LenientFieldParser;
 import org.apache.james.mime4j.parser.AbstractContentHandler;
 import org.apache.james.mime4j.stream.Field;
-import org.apache.james.mime4j.stream.RawField;
 
 /**
  * Abstract implementation of ContentHandler that automates common
@@ -71,7 +70,7 @@ public abstract class SimpleContentHandl
     }
 
     /**
-     * @see org.apache.james.mime4j.parser.AbstractContentHandler#field(RawField)
+     * @see org.apache.james.mime4j.parser.AbstractContentHandler#field(Field)
      */
     @Override
     public final void field(Field field) throws MimeException {



Mime
View raw message