You are viewing a plain text version of this content. The canonical link for it is here.
Posted to server-dev@james.apache.org by ol...@apache.org on 2008/09/21 23:12:14 UTC
svn commit: r697609 - in
/james/mime4j/trunk/src/main/java/org/apache/james/mime4j: descriptor/
field/ io/ message/ parser/
Author: olegk
Date: Sun Sep 21 14:12:13 2008
New Revision: 697609
URL: http://svn.apache.org/viewvc?rev=697609&view=rev
Log:
Fixed javadoc warnings
Modified:
james/mime4j/trunk/src/main/java/org/apache/james/mime4j/descriptor/RFC2183ContentDispositionDescriptor.java
james/mime4j/trunk/src/main/java/org/apache/james/mime4j/descriptor/RFC2557ContentLocationDescriptor.java
james/mime4j/trunk/src/main/java/org/apache/james/mime4j/field/Field.java
james/mime4j/trunk/src/main/java/org/apache/james/mime4j/io/MimeBoundaryInputStream.java
james/mime4j/trunk/src/main/java/org/apache/james/mime4j/io/RootInputStream.java
james/mime4j/trunk/src/main/java/org/apache/james/mime4j/message/Body.java
james/mime4j/trunk/src/main/java/org/apache/james/mime4j/message/Entity.java
james/mime4j/trunk/src/main/java/org/apache/james/mime4j/message/Header.java
james/mime4j/trunk/src/main/java/org/apache/james/mime4j/message/Message.java
james/mime4j/trunk/src/main/java/org/apache/james/mime4j/parser/AbstractEntity.java
james/mime4j/trunk/src/main/java/org/apache/james/mime4j/parser/EntityStates.java
james/mime4j/trunk/src/main/java/org/apache/james/mime4j/parser/MimeEntityConfig.java
james/mime4j/trunk/src/main/java/org/apache/james/mime4j/parser/MimeTokenStream.java
james/mime4j/trunk/src/main/java/org/apache/james/mime4j/parser/RecursionMode.java
Modified: james/mime4j/trunk/src/main/java/org/apache/james/mime4j/descriptor/RFC2183ContentDispositionDescriptor.java
URL: http://svn.apache.org/viewvc/james/mime4j/trunk/src/main/java/org/apache/james/mime4j/descriptor/RFC2183ContentDispositionDescriptor.java?rev=697609&r1=697608&r2=697609&view=diff
==============================================================================
--- james/mime4j/trunk/src/main/java/org/apache/james/mime4j/descriptor/RFC2183ContentDispositionDescriptor.java (original)
+++ james/mime4j/trunk/src/main/java/org/apache/james/mime4j/descriptor/RFC2183ContentDispositionDescriptor.java Sun Sep 21 14:12:13 2008
@@ -78,7 +78,7 @@
public abstract DateTime getContentDispositionCreationDate();
/**
- * Gets any exception thrown during the parsing of {@link #getContentCreationModificationDate()}
+ * Gets any exception thrown during the parsing of {@link #getContentDispositionCreationDate()}
* @return <code>ParseException</code> when the creation-date parse fails,
* null otherwise
*/
@@ -93,7 +93,7 @@
public abstract DateTime getContentDispositionReadDate();
/**
- * Gets any exception thrown during the parsing of {@link #getContentReadModificationDate()}
+ * Gets any exception thrown during the parsing of {@link #getContentDispositionReadDate()}
* @return <code>ParseException</code> when the read-date parse fails,
* null otherwise
*/
@@ -108,7 +108,7 @@
public abstract long getContentDispositionSize();
/**
- * Gets any exception thrown during the parsing of {@link #getContentReadModificationDate()}
+ * Gets any exception thrown during the parsing of {@link #getContentDispositionSize()}
* @return <code>ParseException</code> when the read-date parse fails,
* null otherwise
*/
Modified: james/mime4j/trunk/src/main/java/org/apache/james/mime4j/descriptor/RFC2557ContentLocationDescriptor.java
URL: http://svn.apache.org/viewvc/james/mime4j/trunk/src/main/java/org/apache/james/mime4j/descriptor/RFC2557ContentLocationDescriptor.java?rev=697609&r1=697608&r2=697609&view=diff
==============================================================================
--- james/mime4j/trunk/src/main/java/org/apache/james/mime4j/descriptor/RFC2557ContentLocationDescriptor.java (original)
+++ james/mime4j/trunk/src/main/java/org/apache/james/mime4j/descriptor/RFC2557ContentLocationDescriptor.java Sun Sep 21 14:12:13 2008
@@ -35,7 +35,7 @@
public abstract String getContentLocation();
/**
- * Gets any exception thrown during the parsing of {@link #getContentLanguage()}
+ * Gets any exception thrown during the parsing of {@link #getContentLocation()}
* @return <code>ParseException</code> when the content-language parse fails,
* null otherwise
*/
Modified: james/mime4j/trunk/src/main/java/org/apache/james/mime4j/field/Field.java
URL: http://svn.apache.org/viewvc/james/mime4j/trunk/src/main/java/org/apache/james/mime4j/field/Field.java?rev=697609&r1=697608&r2=697609&view=diff
==============================================================================
--- james/mime4j/trunk/src/main/java/org/apache/james/mime4j/field/Field.java (original)
+++ james/mime4j/trunk/src/main/java/org/apache/james/mime4j/field/Field.java Sun Sep 21 14:12:13 2008
@@ -80,7 +80,7 @@
* </tr>
* </table>
*
- * @param s the string to parse.
+ * @param raw the string to parse.
* @return a <code>Field</code> instance.
* @throws IllegalArgumentException on parse errors.
*/
Modified: james/mime4j/trunk/src/main/java/org/apache/james/mime4j/io/MimeBoundaryInputStream.java
URL: http://svn.apache.org/viewvc/james/mime4j/trunk/src/main/java/org/apache/james/mime4j/io/MimeBoundaryInputStream.java?rev=697609&r1=697608&r2=697609&view=diff
==============================================================================
--- james/mime4j/trunk/src/main/java/org/apache/james/mime4j/io/MimeBoundaryInputStream.java (original)
+++ james/mime4j/trunk/src/main/java/org/apache/james/mime4j/io/MimeBoundaryInputStream.java Sun Sep 21 14:12:13 2008
@@ -45,7 +45,8 @@
/**
* Creates a new MimeBoundaryInputStream.
- * @param s The underlying stream.
+ *
+ * @param inbuffer The underlying stream.
* @param boundary Boundary string (not including leading hyphens).
* @throws IllegalArgumentException when boundary is too long
*/
Modified: james/mime4j/trunk/src/main/java/org/apache/james/mime4j/io/RootInputStream.java
URL: http://svn.apache.org/viewvc/james/mime4j/trunk/src/main/java/org/apache/james/mime4j/io/RootInputStream.java?rev=697609&r1=697608&r2=697609&view=diff
==============================================================================
--- james/mime4j/trunk/src/main/java/org/apache/james/mime4j/io/RootInputStream.java (original)
+++ james/mime4j/trunk/src/main/java/org/apache/james/mime4j/io/RootInputStream.java Sun Sep 21 14:12:13 2008
@@ -38,7 +38,7 @@
/**
* Creates a new <code>RootInputStream</code>.
*
- * @param in the stream to read from.
+ * @param is the stream to read from.
*/
public RootInputStream(InputStream is) {
super(is);
Modified: james/mime4j/trunk/src/main/java/org/apache/james/mime4j/message/Body.java
URL: http://svn.apache.org/viewvc/james/mime4j/trunk/src/main/java/org/apache/james/mime4j/message/Body.java?rev=697609&r1=697608&r2=697609&view=diff
==============================================================================
--- james/mime4j/trunk/src/main/java/org/apache/james/mime4j/message/Body.java (original)
+++ james/mime4j/trunk/src/main/java/org/apache/james/mime4j/message/Body.java Sun Sep 21 14:12:13 2008
@@ -23,6 +23,7 @@
import java.io.OutputStream;
import org.apache.james.mime4j.MimeException;
+import org.apache.james.mime4j.util.MessageUtils;
/**
* Encapsulates the body of an entity (see RFC 2045).
@@ -50,7 +51,8 @@
* Writes this body to the given stream in MIME message format.
*
* @param out the stream to write to.
- * @param mode output mode {@link MessageUtils}
+ * @param mode compatibility mode:
+ * {@link MessageUtils#LENIENT}, {@link MessageUtils#STRICT_ERROR}, {@link MessageUtils#STRICT_IGNORE}
* @throws IOException on I/O errors.
*/
void writeTo(OutputStream out, int mode) throws IOException, MimeException;
Modified: james/mime4j/trunk/src/main/java/org/apache/james/mime4j/message/Entity.java
URL: http://svn.apache.org/viewvc/james/mime4j/trunk/src/main/java/org/apache/james/mime4j/message/Entity.java?rev=697609&r1=697608&r2=697609&view=diff
==============================================================================
--- james/mime4j/trunk/src/main/java/org/apache/james/mime4j/message/Entity.java (original)
+++ james/mime4j/trunk/src/main/java/org/apache/james/mime4j/message/Entity.java Sun Sep 21 14:12:13 2008
@@ -168,7 +168,8 @@
* Write the content to the given outputstream
*
* @param out the outputstream to write to
- * @param mode output mode {@link MessageUtils}
+ * @param mode compatibility mode:
+ * {@link MessageUtils#LENIENT}, {@link MessageUtils#STRICT_ERROR}, {@link MessageUtils#STRICT_IGNORE}
* @throws IOException
*/
public void writeTo(OutputStream out, int mode) throws IOException, MimeException {
Modified: james/mime4j/trunk/src/main/java/org/apache/james/mime4j/message/Header.java
URL: http://svn.apache.org/viewvc/james/mime4j/trunk/src/main/java/org/apache/james/mime4j/message/Header.java?rev=697609&r1=697608&r2=697609&view=diff
==============================================================================
--- james/mime4j/trunk/src/main/java/org/apache/james/mime4j/message/Header.java (original)
+++ james/mime4j/trunk/src/main/java/org/apache/james/mime4j/message/Header.java Sun Sep 21 14:12:13 2008
@@ -151,9 +151,23 @@
/**
* Write the Header to the given OutputStream.
- *
+ * <p>
+ * Compatibility mode:
+ * <ul>
+ * <li>
+ * {@link MessageUtils#LENIENT}: use charset of the Content-Type header
+ * </li>
+ * <li>
+ * {@link MessageUtils#STRICT_ERROR}: use US-ASCII and throw {@link MimeException}
+ * if a non ASCII character is encountered
+ * </li>
+ * <li>
+ * {@link MessageUtils#STRICT_ERROR}: ignore non ASCII characters if encountered
+ * </li>
+ * </ul>
* @param out the OutputStream to write to
- * @param mode compatibility mode
+ * @param mode compatibility mode:
+ * {@link MessageUtils#LENIENT}, {@link MessageUtils#STRICT_ERROR}, {@link MessageUtils#STRICT_IGNORE}
*
* @throws IOException if case of an I/O error
* @throws MimeException if case of a MIME protocol violation
Modified: james/mime4j/trunk/src/main/java/org/apache/james/mime4j/message/Message.java
URL: http://svn.apache.org/viewvc/james/mime4j/trunk/src/main/java/org/apache/james/mime4j/message/Message.java?rev=697609&r1=697608&r2=697609&view=diff
==============================================================================
--- james/mime4j/trunk/src/main/java/org/apache/james/mime4j/message/Message.java (original)
+++ james/mime4j/trunk/src/main/java/org/apache/james/mime4j/message/Message.java Sun Sep 21 14:12:13 2008
@@ -34,8 +34,7 @@
* <code>Message</code> object.
*
* <pre>
- * Message msg = new Message(new BufferedInputStream(
- * new FileInputStream("mime.msg")));
+ * Message msg = new Message(new FileInputStream("mime.msg"));
* </pre>
*
*
Modified: james/mime4j/trunk/src/main/java/org/apache/james/mime4j/parser/AbstractEntity.java
URL: http://svn.apache.org/viewvc/james/mime4j/trunk/src/main/java/org/apache/james/mime4j/parser/AbstractEntity.java?rev=697609&r1=697608&r2=697609&view=diff
==============================================================================
--- james/mime4j/trunk/src/main/java/org/apache/james/mime4j/parser/AbstractEntity.java (original)
+++ james/mime4j/trunk/src/main/java/org/apache/james/mime4j/parser/AbstractEntity.java Sun Sep 21 14:12:13 2008
@@ -218,10 +218,10 @@
* <p>Gets a descriptor for the current entity.
* This method is valid if {@link #getState()} returns:</p>
* <ul>
- * <li>{@link #T_BODY}</li>
- * <li>{@link #T_START_MULTIPART}</li>
- * <li>{@link #T_EPILOGUE}</li>
- * <li>{@link #T_PREAMBLE}</li>
+ * <li>{@link EntityStates#T_BODY}</li>
+ * <li>{@link EntityStates#T_START_MULTIPART}</li>
+ * <li>{@link EntityStates#T_EPILOGUE}</li>
+ * <li>{@link EntityStates#T_PREAMBLE}</li>
* </ul>
* @return <code>BodyDescriptor</code>, not nulls
*/
@@ -239,10 +239,10 @@
}
/**
- * This method is valid, if {@link #getState()} returns {@link #T_FIELD}.
+ * This method is valid, if {@link #getState()} returns {@link EntityStates#T_FIELD}.
* @return String with the fields raw contents.
* @throws IllegalStateException {@link #getState()} returns another
- * value than {@link #T_FIELD}.
+ * value than {@link EntityStates#T_FIELD}.
*/
public String getField() {
switch (getState()) {
@@ -254,10 +254,10 @@
}
/**
- * This method is valid, if {@link #getState()} returns {@link #T_FIELD}.
+ * This method is valid, if {@link #getState()} returns {@link EntityStates#T_FIELD}.
* @return String with the fields name.
* @throws IllegalStateException {@link #getState()} returns another
- * value than {@link #T_FIELD}.
+ * value than {@link EntityStates#T_FIELD}.
*/
public String getFieldName() {
switch (getState()) {
@@ -269,10 +269,10 @@
}
/**
- * This method is valid, if {@link #getState()} returns {@link #T_FIELD}.
+ * This method is valid, if {@link #getState()} returns {@link EntityStates#T_FIELD}.
* @return String with the fields value.
* @throws IllegalStateException {@link #getState()} returns another
- * value than {@link #T_FIELD}.
+ * value than {@link EntityStates#T_FIELD}.
*/
public String getFieldValue() {
switch (getState()) {
Modified: james/mime4j/trunk/src/main/java/org/apache/james/mime4j/parser/EntityStates.java
URL: http://svn.apache.org/viewvc/james/mime4j/trunk/src/main/java/org/apache/james/mime4j/parser/EntityStates.java?rev=697609&r1=697608&r2=697609&view=diff
==============================================================================
--- james/mime4j/trunk/src/main/java/org/apache/james/mime4j/parser/EntityStates.java (original)
+++ james/mime4j/trunk/src/main/java/org/apache/james/mime4j/parser/EntityStates.java Sun Sep 21 14:12:13 2008
@@ -42,8 +42,6 @@
public static final int T_END_MESSAGE = 1;
/**
* This token indicates, that a raw entity is currently being processed.
- * You may call {@link #getContentStream()} to obtain the raw entity
- * data.
*/
public static final int T_RAW_ENTITY = 2;
/**
@@ -53,8 +51,7 @@
public static final int T_START_HEADER = 3;
/**
* This token indicates, that a message parts field has now
- * been parsed. You may call {@link #getField()} to obtain the
- * raw field contents.
+ * been parsed.
*/
public static final int T_FIELD = 4;
/**
@@ -72,14 +69,12 @@
public static final int T_END_MULTIPART = 7;
/**
* This token indicates, that a multiparts preamble is being
- * parsed. You may call {@link #getContentStream()} to access the
- * preamble contents.
+ * parsed.
*/
public static final int T_PREAMBLE = 8;
/**
* This token indicates, that a multiparts epilogue is being
- * parsed. You may call {@link #getContentStream()} to access the
- * epilogue contents.
+ * parsed.
*/
public static final int T_EPILOGUE = 9;
/**
@@ -94,7 +89,6 @@
public static final int T_END_BODYPART = 11;
/**
* This token indicates, that an atomic entity is being parsed.
- * Use {@link #getContentStream()} to access the entity contents.
*/
public static final int T_BODY = 12;
Modified: james/mime4j/trunk/src/main/java/org/apache/james/mime4j/parser/MimeEntityConfig.java
URL: http://svn.apache.org/viewvc/james/mime4j/trunk/src/main/java/org/apache/james/mime4j/parser/MimeEntityConfig.java?rev=697609&r1=697608&r2=697609&view=diff
==============================================================================
--- james/mime4j/trunk/src/main/java/org/apache/james/mime4j/parser/MimeEntityConfig.java (original)
+++ james/mime4j/trunk/src/main/java/org/apache/james/mime4j/parser/MimeEntityConfig.java Sun Sep 21 14:12:13 2008
@@ -55,7 +55,7 @@
* specification will be enforced, If this parameter is set to <code>false</code>
* minor violations will result in a warning in the log.
*
- * @return value of the strict parsing mode
+ * @param strictParsing value of the strict parsing mode
*/
public void setStrictParsing(boolean strictParsing) {
this.strictParsing = strictParsing;
@@ -77,7 +77,7 @@
* length limit. If this parameter is set to a non positive value the line length
* check will be disabled.
*
- * @param maximum line length limit
+ * @param maxLineLen maximum line length limit
*/
public void setMaxLineLen(int maxLineLen) {
this.maxLineLen = maxLineLen;
@@ -99,7 +99,7 @@
* limit. If this parameter is set to a non positive value the header limit check
* will be disabled.
*
- * @param maximum header limit
+ * @param maxHeaderCount maximum header limit
*/
public void setMaxHeaderCount(int maxHeaderCount) {
this.maxHeaderCount = maxHeaderCount;
Modified: james/mime4j/trunk/src/main/java/org/apache/james/mime4j/parser/MimeTokenStream.java
URL: http://svn.apache.org/viewvc/james/mime4j/trunk/src/main/java/org/apache/james/mime4j/parser/MimeTokenStream.java?rev=697609&r1=697608&r2=697609&view=diff
==============================================================================
--- james/mime4j/trunk/src/main/java/org/apache/james/mime4j/parser/MimeTokenStream.java (original)
+++ james/mime4j/trunk/src/main/java/org/apache/james/mime4j/parser/MimeTokenStream.java Sun Sep 21 14:12:13 2008
@@ -187,7 +187,7 @@
*
* @return <code>true</code> if in raw mode, <code>false</code>
* otherwise.
- * @see #setRaw(boolean)
+ * @see #setRecursionMode(int)
*/
public boolean isRaw() {
return recursionMode == M_RAW;
Modified: james/mime4j/trunk/src/main/java/org/apache/james/mime4j/parser/RecursionMode.java
URL: http://svn.apache.org/viewvc/james/mime4j/trunk/src/main/java/org/apache/james/mime4j/parser/RecursionMode.java?rev=697609&r1=697608&r2=697609&view=diff
==============================================================================
--- james/mime4j/trunk/src/main/java/org/apache/james/mime4j/parser/RecursionMode.java (original)
+++ james/mime4j/trunk/src/main/java/org/apache/james/mime4j/parser/RecursionMode.java Sun Sep 21 14:12:13 2008
@@ -26,23 +26,19 @@
/**
* Recursively parse every <code>message/rfc822</code> part
- * @see #getRecursionMode()
*/
public static final int M_RECURSE = 0;
/**
* Do not recurse <code>message/rfc822</code> parts
- * @see #getRecursionMode()
*/
public static final int M_NO_RECURSE = 1;
/**
* Parse into raw entities
- * @see #getRecursionMode()
*/
public static final int M_RAW = 2;
/**
* Do not recurse <code>message/rfc822</code> parts
* and treat multiparts as a single flat body.
- * @see #getRecursionMode()
*/
public static final int M_FLAT = 3;
---------------------------------------------------------------------
To unsubscribe, e-mail: server-dev-unsubscribe@james.apache.org
For additional commands, e-mail: server-dev-help@james.apache.org