You are viewing a plain text version of this content. The canonical link for it is here.
Posted to mime4j-dev@james.apache.org by ol...@apache.org on 2011/07/18 11:16:05 UTC
svn commit: r1147793 - in
/james/mime4j/trunk/dom/src/main/java/org/apache/james/mime4j/field:
DefaultFieldParser.java LenientFieldParser.java
Author: olegk
Date: Mon Jul 18 09:16:05 2011
New Revision: 1147793
URL: http://svn.apache.org/viewvc?rev=1147793&view=rev
Log:
Javadoc updates
Modified:
james/mime4j/trunk/dom/src/main/java/org/apache/james/mime4j/field/DefaultFieldParser.java
james/mime4j/trunk/dom/src/main/java/org/apache/james/mime4j/field/LenientFieldParser.java
Modified: james/mime4j/trunk/dom/src/main/java/org/apache/james/mime4j/field/DefaultFieldParser.java
URL: http://svn.apache.org/viewvc/james/mime4j/trunk/dom/src/main/java/org/apache/james/mime4j/field/DefaultFieldParser.java?rev=1147793&r1=1147792&r2=1147793&view=diff
==============================================================================
--- james/mime4j/trunk/dom/src/main/java/org/apache/james/mime4j/field/DefaultFieldParser.java (original)
+++ james/mime4j/trunk/dom/src/main/java/org/apache/james/mime4j/field/DefaultFieldParser.java Mon Jul 18 09:16:05 2011
@@ -23,41 +23,52 @@ import org.apache.james.mime4j.MimeExcep
import org.apache.james.mime4j.codec.DecodeMonitor;
import org.apache.james.mime4j.dom.FieldParser;
import org.apache.james.mime4j.dom.field.AddressListField;
+import org.apache.james.mime4j.dom.field.ContentDescriptionField;
+import org.apache.james.mime4j.dom.field.ContentDispositionField;
+import org.apache.james.mime4j.dom.field.ContentIdField;
+import org.apache.james.mime4j.dom.field.ContentLanguageField;
+import org.apache.james.mime4j.dom.field.ContentLengthField;
+import org.apache.james.mime4j.dom.field.ContentLocationField;
+import org.apache.james.mime4j.dom.field.ContentMD5Field;
+import org.apache.james.mime4j.dom.field.ContentTransferEncodingField;
+import org.apache.james.mime4j.dom.field.ContentTypeField;
import org.apache.james.mime4j.dom.field.DateTimeField;
import org.apache.james.mime4j.dom.field.FieldName;
import org.apache.james.mime4j.dom.field.MailboxField;
import org.apache.james.mime4j.dom.field.MailboxListField;
+import org.apache.james.mime4j.dom.field.MimeVersionField;
import org.apache.james.mime4j.dom.field.ParsedField;
+import org.apache.james.mime4j.dom.field.UnstructuredField;
import org.apache.james.mime4j.stream.Field;
import org.apache.james.mime4j.stream.RawField;
import org.apache.james.mime4j.stream.RawFieldParser;
import org.apache.james.mime4j.util.ByteSequence;
import org.apache.james.mime4j.util.ContentUtil;
+/**
+ * Default (strict) implementation of the {@link FieldParser} interface.
+ */
public class DefaultFieldParser extends DelegatingFieldParser {
private static final DefaultFieldParser PARSER = new DefaultFieldParser();
-
/**
- * Gets the default parser used to parse fields.
+ * Gets the default instance of this class.
*
- * @return the default field parser
+ * @return the default instance
*/
public static DefaultFieldParser getParser() {
return PARSER;
}
-
/**
- * Parses the given byte sequence and returns an instance of the
- * <code>Field</code> class. The type of the class returned depends on the
- * field name; see {@link #parse(String)} for a table of field names and
- * their corresponding classes.
+ * Parses the given byte sequence and returns an instance of the {@link ParsedField} class.
+ * The type of the class returned depends on the field name; see {@link #parse(String)} for
+ * a table of field names and their corresponding classes.
*
* @param raw the bytes to parse.
- * @param monitor a DecodeMonitor object used while parsing/decoding.
- * @return a <code>ParsedField</code> instance.
+ * @param monitor decoding monitor used while parsing/decoding.
+ * @return a parsed field.
* @throws MimeException if the raw string cannot be split into field name and body.
*/
public static ParsedField parse(
@@ -68,24 +79,30 @@ public class DefaultFieldParser extends
}
/**
- * Parses the given string and returns an instance of the
- * <code>Field</code> class. The type of the class returned depends on
- * the field name:
+ * Parses the given string and returns an instance of the {@link ParsedField} class.
+ * The type of the class returned depends on the field name:
* <p>
* <table>
* <tr><th>Class returned</th><th>Field names</th></tr>
- * <tr><td>{@link ContentTypeFieldImpl}</td><td>Content-Type</td></tr>
- * <tr><td>{@link ContentTransferEncodingFieldImpl}</td><td>Content-Transfer-Encoding</td></tr>
- * <tr><td>{@link ContentDispositionFieldImpl}</td><td>Content-Disposition</td></tr>
- * <tr><td>{@link DateTimeFieldImpl}</td><td>Date, Resent-Date</td></tr>
- * <tr><td>{@link MailboxFieldImpl}</td><td>Sender, Resent-Sender</td></tr>
- * <tr><td>{@link MailboxListFieldImpl}</td><td>From, Resent-From</td></tr>
- * <tr><td>{@link AddressListFieldImpl}</td><td>To, Cc, Bcc, Reply-To, Resent-To, Resent-Cc, Resent-Bcc</td></tr>
- * <tr><td>{@link UnstructuredFieldImpl}</td><td>Subject and others</td></tr>
+ * <tr><td>{@link ContentTypeField}</td><td>Content-Type</td></tr>
+ * <tr><td>{@link ContentLengthField}</td><td>Content-Length</td></tr>
+ * <tr><td>{@link ContentTransferEncodingField}</td><td>Content-Transfer-Encoding</td></tr>
+ * <tr><td>{@link ContentDispositionField}</td><td>Content-Disposition</td></tr>
+ * <tr><td>{@link ContentDescriptionField}</td><td>Content-Description</td></tr>
+ * <tr><td>{@link ContentIdField}</td><td>Content-ID</td></tr>
+ * <tr><td>{@link ContentMD5Field}</td><td>Content-MD5</td></tr>
+ * <tr><td>{@link ContentLanguageField}</td><td>Content-Language</td></tr>
+ * <tr><td>{@link ContentLocationField}</td><td>Content-Location</td></tr>
+ * <tr><td>{@link MimeVersionField}</td><td>MIME-Version</td></tr>
+ * <tr><td>{@link DateTimeField}</td><td>Date, Resent-Date</td></tr>
+ * <tr><td>{@link MailboxField}</td><td>Sender, Resent-Sender</td></tr>
+ * <tr><td>{@link MailboxListField}</td><td>From, Resent-From</td></tr>
+ * <tr><td>{@link AddressListField}</td><td>To, Cc, Bcc, Reply-To, Resent-To, Resent-Cc, Resent-Bcc</td></tr>
+ * <tr><td>{@link UnstructuredField}</td><td>Subject and others</td></tr>
* </table>
*
* @param rawStr the string to parse.
- * @return a <code>ParsedField</code> instance.
+ * @return a parsed field.
* @throws MimeException if the raw string cannot be split into field name and body.
*/
public static ParsedField parse(
Modified: james/mime4j/trunk/dom/src/main/java/org/apache/james/mime4j/field/LenientFieldParser.java
URL: http://svn.apache.org/viewvc/james/mime4j/trunk/dom/src/main/java/org/apache/james/mime4j/field/LenientFieldParser.java?rev=1147793&r1=1147792&r2=1147793&view=diff
==============================================================================
--- james/mime4j/trunk/dom/src/main/java/org/apache/james/mime4j/field/LenientFieldParser.java (original)
+++ james/mime4j/trunk/dom/src/main/java/org/apache/james/mime4j/field/LenientFieldParser.java Mon Jul 18 09:16:05 2011
@@ -23,38 +23,53 @@ import org.apache.james.mime4j.MimeExcep
import org.apache.james.mime4j.codec.DecodeMonitor;
import org.apache.james.mime4j.dom.FieldParser;
import org.apache.james.mime4j.dom.field.AddressListField;
+import org.apache.james.mime4j.dom.field.ContentDescriptionField;
+import org.apache.james.mime4j.dom.field.ContentDispositionField;
+import org.apache.james.mime4j.dom.field.ContentIdField;
+import org.apache.james.mime4j.dom.field.ContentLanguageField;
+import org.apache.james.mime4j.dom.field.ContentLengthField;
+import org.apache.james.mime4j.dom.field.ContentLocationField;
+import org.apache.james.mime4j.dom.field.ContentMD5Field;
+import org.apache.james.mime4j.dom.field.ContentTransferEncodingField;
+import org.apache.james.mime4j.dom.field.ContentTypeField;
import org.apache.james.mime4j.dom.field.DateTimeField;
import org.apache.james.mime4j.dom.field.FieldName;
import org.apache.james.mime4j.dom.field.MailboxField;
import org.apache.james.mime4j.dom.field.MailboxListField;
+import org.apache.james.mime4j.dom.field.MimeVersionField;
import org.apache.james.mime4j.dom.field.ParsedField;
+import org.apache.james.mime4j.dom.field.UnstructuredField;
import org.apache.james.mime4j.stream.Field;
import org.apache.james.mime4j.stream.RawField;
import org.apache.james.mime4j.stream.RawFieldParser;
import org.apache.james.mime4j.util.ByteSequence;
import org.apache.james.mime4j.util.ContentUtil;
+/**
+ * Lenient implementation of the {@link FieldParser} interface with a high degree of tolerance
+ * to non-severe MIME field format violations.
+ */
public class LenientFieldParser extends DelegatingFieldParser {
private static final LenientFieldParser PARSER = new LenientFieldParser();
/**
- * Gets the default parser used to parse fields.
+ * Gets the default instance of this class.
*
- * @return the default field parser
+ * @return the default instance
*/
public static LenientFieldParser getParser() {
return PARSER;
}
/**
- * Parses the given byte sequence and returns an instance of the
- * <code>Field</code> class. The type of the class returned depends on the
- * field name.
+ * Parses the given byte sequence and returns an instance of the {@link ParsedField} class.
+ * The type of the class returned depends on the field name; see {@link #parse(String)} for
+ * a table of field names and their corresponding classes.
*
* @param raw the bytes to parse.
- * @param monitor a DecodeMonitor object used while parsing/decoding.
- * @return a <code>ParsedField</code> instance.
+ * @param monitor decoding monitor used while parsing/decoding.
+ * @return a parsed field.
* @throws MimeException if the raw string cannot be split into field name and body.
*/
public static ParsedField parse(
@@ -83,6 +98,33 @@ public class LenientFieldParser extends
return PARSER.parse(rawField, monitor);
}
+ /**
+ * Parses the given string and returns an instance of the {@link ParsedField} class.
+ * The type of the class returned depends on the field name:
+ * <p>
+ * <table>
+ * <tr><th>Class returned</th><th>Field names</th></tr>
+ * <tr><td>{@link ContentTypeField}</td><td>Content-Type</td></tr>
+ * <tr><td>{@link ContentLengthField}</td><td>Content-Length</td></tr>
+ * <tr><td>{@link ContentTransferEncodingField}</td><td>Content-Transfer-Encoding</td></tr>
+ * <tr><td>{@link ContentDispositionField}</td><td>Content-Disposition</td></tr>
+ * <tr><td>{@link ContentDescriptionField}</td><td>Content-Description</td></tr>
+ * <tr><td>{@link ContentIdField}</td><td>Content-ID</td></tr>
+ * <tr><td>{@link ContentMD5Field}</td><td>Content-MD5</td></tr>
+ * <tr><td>{@link ContentLanguageField}</td><td>Content-Language</td></tr>
+ * <tr><td>{@link ContentLocationField}</td><td>Content-Location</td></tr>
+ * <tr><td>{@link MimeVersionField}</td><td>MIME-Version</td></tr>
+ * <tr><td>{@link DateTimeField}</td><td>Date, Resent-Date</td></tr>
+ * <tr><td>{@link MailboxField}</td><td>Sender, Resent-Sender</td></tr>
+ * <tr><td>{@link MailboxListField}</td><td>From, Resent-From</td></tr>
+ * <tr><td>{@link AddressListField}</td><td>To, Cc, Bcc, Reply-To, Resent-To, Resent-Cc, Resent-Bcc</td></tr>
+ * <tr><td>{@link UnstructuredField}</td><td>Subject and others</td></tr>
+ * </table>
+ *
+ * @param rawStr the string to parse.
+ * @return a parsed field.
+ * @throws MimeException if the raw string cannot be split into field name and body.
+ */
public static ParsedField parse(final String rawStr) throws MimeException {
return parse(rawStr, DecodeMonitor.SILENT);
}