Repository: james-mime4j Updated Branches: refs/heads/master d384c4073 -> 64b332b33
MIME4J-279 Fixed JavaDoc errors to comply with Java8. Project: http://git-wip-us.apache.org/repos/asf/james-mime4j/repo Commit: http://git-wip-us.apache.org/repos/asf/james-mime4j/commit/64b332b3 Tree: http://git-wip-us.apache.org/repos/asf/james-mime4j/tree/64b332b3 Diff: http://git-wip-us.apache.org/repos/asf/james-mime4j/diff/64b332b3 Branch: refs/heads/master Commit: 64b332b337d58f1475e7874acc2e946cbb20ad27 Parents: d384c40 Author: Dmitry Katsubo <[email protected]> Authored: Tue May 22 12:17:11 2018 +0200 Committer: benwa <[email protected]> Committed: Wed May 23 16:59:52 2018 +0700 ---------------------------------------------------------------------- .../apache/james/mime4j/codec/EncoderUtil.java | 8 ++++---- .../james/mime4j/parser/ContentHandler.java | 2 ++ .../james/mime4j/parser/MimeStreamParser.java | 2 +- .../mime4j/stream/BodyDescriptorBuilder.java | 10 +++++++--- .../org/apache/james/mime4j/stream/Field.java | 5 ++++- .../james/mime4j/stream/FieldBuilder.java | 8 ++++++-- .../apache/james/mime4j/stream/MimeConfig.java | 12 ++++++------ .../james/mime4j/stream/MimeTokenStream.java | 12 +++++++++--- .../james/mime4j/stream/ParserCursor.java | 5 ++++- .../apache/james/mime4j/stream/RawField.java | 7 +++++-- .../james/mime4j/stream/RawFieldParser.java | 5 ++++- .../apache/james/mime4j/util/ByteSequence.java | 2 +- .../apache/james/mime4j/util/CharsetUtil.java | 5 ++++- .../java/org/apache/james/mime4j/dom/Body.java | 5 ++++- .../james/mime4j/field/DefaultFieldParser.java | 5 +++-- .../org/apache/james/mime4j/field/Fields.java | 2 +- .../james/mime4j/field/LenientFieldParser.java | 5 +++-- .../mime4j/field/address/AddressFormatter.java | 17 ++++++++++------- .../mime4j/internal/AbstractEntityBuilder.java | 16 ++++++++-------- .../james/mime4j/message/BasicBodyFactory.java | 20 ++++++++++++-------- .../james/mime4j/message/BodyPartBuilder.java | 2 +- .../contentdisposition/ParseException.java | 3 ++- .../field/contenttype/ParseException.java | 3 ++- .../mime4j/field/datetime/ParseException.java | 3 ++- .../mime4j/field/language/ParseException.java | 3 ++- .../field/mimeversion/ParseException.java | 3 ++- .../mime4j/field/structured/ParseException.java | 3 ++- .../mime4j/field/address/ParseException.java | 3 ++- .../james/mime4j/mboxiterator/MboxIterator.java | 1 - 29 files changed, 113 insertions(+), 64 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/james-mime4j/blob/64b332b3/core/src/main/java/org/apache/james/mime4j/codec/EncoderUtil.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/james/mime4j/codec/EncoderUtil.java b/core/src/main/java/org/apache/james/mime4j/codec/EncoderUtil.java index c9b2753..f29a04f 100644 --- a/core/src/main/java/org/apache/james/mime4j/codec/EncoderUtil.java +++ b/core/src/main/java/org/apache/james/mime4j/codec/EncoderUtil.java @@ -175,7 +175,7 @@ public class EncoderUtil { * whether the encoded-word is to be used to replace a text token * or a word entity (see RFC 822). * @param usedCharacters - * number of characters already used up (<code>0 <= usedCharacters <= 50</code>). + * number of characters already used up (<code>0 <= usedCharacters <= 50</code>). * @return the specified text if encoding is not necessary or an encoded * word or a sequence of encoded words otherwise. */ @@ -197,7 +197,7 @@ public class EncoderUtil { * @param text * text to analyze. * @param usedCharacters - * number of characters already used up (<code>0 <= usedCharacters <= 50</code>). + * number of characters already used up (<code>0 <= usedCharacters <= 50</code>). * @return <code>true</code> if the specified text has to be encoded into * an encoded-word, <code>false</code> otherwise. */ @@ -271,7 +271,7 @@ public class EncoderUtil { * whether the encoded-word is to be used to replace a text token * or a word entity (see RFC 822). * @param usedCharacters - * number of characters already used up (<code>0 <= usedCharacters <= 50</code>). + * number of characters already used up (<code>0 <= usedCharacters <= 50</code>). * @return the encoded word (or sequence of encoded words if the given text * does not fit in a single encoded word). * @see #hasToBeEncoded(String, int) @@ -292,7 +292,7 @@ public class EncoderUtil { * whether the encoded-word is to be used to replace a text token * or a word entity (see RFC 822). * @param usedCharacters - * number of characters already used up (<code>0 <= usedCharacters <= 50</code>). + * number of characters already used up (<code>0 <= usedCharacters <= 50</code>). * @param charset * the Java charset that should be used to encode the specified * string into a byte array. A suitable charset is detected http://git-wip-us.apache.org/repos/asf/james-mime4j/blob/64b332b3/core/src/main/java/org/apache/james/mime4j/parser/ContentHandler.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/james/mime4j/parser/ContentHandler.java b/core/src/main/java/org/apache/james/mime4j/parser/ContentHandler.java index c3fb923..668e47e 100644 --- a/core/src/main/java/org/apache/james/mime4j/parser/ContentHandler.java +++ b/core/src/main/java/org/apache/james/mime4j/parser/ContentHandler.java @@ -42,6 +42,7 @@ import java.io.InputStream; * <p> * Events will be generated in the order the corresponding elements occur in * the message stream parsed by the parser. E.g.: + * </p> * <pre> * startMessage() * startHeader() @@ -71,6 +72,7 @@ import java.io.InputStream; * endMultipart() * endMessage() * </pre> + * <p> * The above shows an example of a MIME message consisting of a multipart * body containing two body parts. * </p> http://git-wip-us.apache.org/repos/asf/james-mime4j/blob/64b332b3/core/src/main/java/org/apache/james/mime4j/parser/MimeStreamParser.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/james/mime4j/parser/MimeStreamParser.java b/core/src/main/java/org/apache/james/mime4j/parser/MimeStreamParser.java index 57d290d..11223d6 100644 --- a/core/src/main/java/org/apache/james/mime4j/parser/MimeStreamParser.java +++ b/core/src/main/java/org/apache/james/mime4j/parser/MimeStreamParser.java @@ -38,7 +38,7 @@ import org.apache.james.mime4j.stream.RecursionMode; * parsing events to a {@link ContentHandler} instance. * </p> * <p> - * Typical usage:<br/> + * Typical usage:<br> * <pre> * ContentHandler handler = new MyHandler(); * MimeConfig config = new MimeConfig(); http://git-wip-us.apache.org/repos/asf/james-mime4j/blob/64b332b3/core/src/main/java/org/apache/james/mime4j/stream/BodyDescriptorBuilder.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/james/mime4j/stream/BodyDescriptorBuilder.java b/core/src/main/java/org/apache/james/mime4j/stream/BodyDescriptorBuilder.java index 2637e61..ec06de8 100644 --- a/core/src/main/java/org/apache/james/mime4j/stream/BodyDescriptorBuilder.java +++ b/core/src/main/java/org/apache/james/mime4j/stream/BodyDescriptorBuilder.java @@ -22,14 +22,18 @@ package org.apache.james.mime4j.stream; import org.apache.james.mime4j.MimeException; /** + * <p> * Body descriptor builders are intended to construct {@link BodyDescriptor} instances from * multiple unstructured {@link RawField}s. - * <p/> + * </p> + * <p> * Body descriptor builders are stateful and modal as they have to store intermediate results * between method invocations and also rely on a particular sequence of method invocations * (the mode of operation). - * <p/> + * </p> + * <p> * Consumers are expected to interact with body descriptor builders in the following way: + * </p> * <ul> * <li>Invoke {@link #reset()} method in order to reset builder's internal state and make it * ready to start the process of building a new {@link BodyDescriptor}.</li> @@ -42,7 +46,7 @@ import org.apache.james.mime4j.MimeException; * <li>Optionally invoke {@link #newChild()} for each embedded body of content. Please note that * the resultant {@link BodyDescriptorBuilder}} child instance can inherit some its parent * properties such as MIME type.</li> - * <li>Invoke {@link #build()()} method in order to generate a {@link BodyDescriptor}} instance + * <li>Invoke {@link #build()} method in order to generate a {@link BodyDescriptor}} instance * based on the internal state of the builder.</li> * </ul> */ http://git-wip-us.apache.org/repos/asf/james-mime4j/blob/64b332b3/core/src/main/java/org/apache/james/mime4j/stream/Field.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/james/mime4j/stream/Field.java b/core/src/main/java/org/apache/james/mime4j/stream/Field.java index 44761b3..6c58dec 100644 --- a/core/src/main/java/org/apache/james/mime4j/stream/Field.java +++ b/core/src/main/java/org/apache/james/mime4j/stream/Field.java @@ -22,12 +22,15 @@ package org.apache.james.mime4j.stream; import org.apache.james.mime4j.util.ByteSequence; /** + * <p> * This interface represents an abstract MIME field. A MIME field must have a non <code>null</code> * name and a content body (unfolded but unparsed and possibly encoded). Optionally implementing * classes may also retain the original (raw) representation in a form of {@link ByteSequence}. - * <p/> + * </p> + * <p> * Specific implementations of this interface may also use a richer model to represent the field * if its body can be parsed into a set of constituent elements. + * </p> */ public interface Field { http://git-wip-us.apache.org/repos/asf/james-mime4j/blob/64b332b3/core/src/main/java/org/apache/james/mime4j/stream/FieldBuilder.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/james/mime4j/stream/FieldBuilder.java b/core/src/main/java/org/apache/james/mime4j/stream/FieldBuilder.java index f923694..a7a5815 100644 --- a/core/src/main/java/org/apache/james/mime4j/stream/FieldBuilder.java +++ b/core/src/main/java/org/apache/james/mime4j/stream/FieldBuilder.java @@ -23,14 +23,18 @@ import org.apache.james.mime4j.MimeException; import org.apache.james.mime4j.util.ByteArrayBuffer; /** + * <p> * Field builders are intended to construct {@link RawField} instances from multiple lines * contained in {@link ByteArrayBuffer}s. - * <p/> + * </p> + * <p> * Field builders are stateful and modal as they have to store intermediate results between * method invocations and also rely on a particular sequence of method invocations * (the mode of operation). - * <p/> + * </p> + * <p> * Consumers are expected to interact with field builder in the following way: + * </p> * <ul> * <li>Invoke {@link #reset()} method in order to reset builder's internal state and make it * ready to start the process of building a new {@link RawField}.</li> http://git-wip-us.apache.org/repos/asf/james-mime4j/blob/64b332b3/core/src/main/java/org/apache/james/mime4j/stream/MimeConfig.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/james/mime4j/stream/MimeConfig.java b/core/src/main/java/org/apache/james/mime4j/stream/MimeConfig.java index e58d063..77ad152 100644 --- a/core/src/main/java/org/apache/james/mime4j/stream/MimeConfig.java +++ b/core/src/main/java/org/apache/james/mime4j/stream/MimeConfig.java @@ -67,7 +67,7 @@ public final class MimeConfig { } /** - * @see #setMalformedHeaderStartsBody(boolean) + * @see Builder#setMalformedHeaderStartsBody(boolean) * * @return true if malformed header should "end" the headers and be part of * the body @@ -79,7 +79,7 @@ public final class MimeConfig { /** * Returns the value of the strict parsing mode * - * @see #setStrictParsing(boolean) + * @see Builder#setStrictParsing(boolean) * * @return value of the strict parsing mode */ @@ -90,7 +90,7 @@ public final class MimeConfig { /** * Returns the maximum line length limit * - * @see #setMaxLineLen(int) + * @see Builder#setMaxLineLen(int) * * @return value of the the maximum line length limit */ @@ -101,7 +101,7 @@ public final class MimeConfig { /** * Returns the maximum header limit * - * @see #setMaxHeaderCount(int) + * @see Builder#setMaxHeaderCount(int) * * @return value of the the maximum header limit */ @@ -112,7 +112,7 @@ public final class MimeConfig { /** * Returns the maximum header length limit * - * @see #setMaxHeaderLen(int) + * @see Builder#setMaxHeaderLen(int) * * @return value of the maximum header length limit */ @@ -123,7 +123,7 @@ public final class MimeConfig { /** * Returns the maximum content length limit * - * @see #setMaxContentLen(long) + * @see Builder#setMaxContentLen(long) * * @return value of the the maximum content length limit */ http://git-wip-us.apache.org/repos/asf/james-mime4j/blob/64b332b3/core/src/main/java/org/apache/james/mime4j/stream/MimeTokenStream.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/james/mime4j/stream/MimeTokenStream.java b/core/src/main/java/org/apache/james/mime4j/stream/MimeTokenStream.java index a578af6..2efc8a5 100644 --- a/core/src/main/java/org/apache/james/mime4j/stream/MimeTokenStream.java +++ b/core/src/main/java/org/apache/james/mime4j/stream/MimeTokenStream.java @@ -92,7 +92,7 @@ public class MimeTokenStream { /** * Constructs a standard (lax) stream. * Optional validation events will be logged only. - * Use {@link MimeConfig#setStrictParsing(boolean)} to turn on strict + * Use {@link MimeConfig.Builder#setStrictParsing(boolean)} to turn on strict * parsing mode and pass the config object to * {@link MimeTokenStream#MimeTokenStream(MimeConfig)} to create * a stream that strictly validates the input. @@ -269,11 +269,14 @@ public class MimeTokenStream { } /** + * <p> * This method returns the raw entity, preamble, or epilogue contents. - * <p/> + * </p> + * <p> * This method is valid, if {@link #getState()} returns either of * {@link EntityState#T_RAW_ENTITY}, {@link EntityState#T_PREAMBLE}, or * {@link EntityState#T_EPILOGUE}. + * </p> * * @return Data stream, depending on the current state. * @throws IllegalStateException {@link #getState()} returns an @@ -284,12 +287,15 @@ public class MimeTokenStream { } /** + * <p> * This method returns a transfer decoded stream based on the MIME * fields with the standard defaults. - * <p/> + * </p> + * <p> * This method is valid, if {@link #getState()} returns either of * {@link EntityState#T_RAW_ENTITY}, {@link EntityState#T_PREAMBLE}, or * {@link EntityState#T_EPILOGUE}. + * </p> * * @return Data stream, depending on the current state. * @throws IllegalStateException {@link #getState()} returns an http://git-wip-us.apache.org/repos/asf/james-mime4j/blob/64b332b3/core/src/main/java/org/apache/james/mime4j/stream/ParserCursor.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/james/mime4j/stream/ParserCursor.java b/core/src/main/java/org/apache/james/mime4j/stream/ParserCursor.java index 53891a6..edb475e 100644 --- a/core/src/main/java/org/apache/james/mime4j/stream/ParserCursor.java +++ b/core/src/main/java/org/apache/james/mime4j/stream/ParserCursor.java @@ -20,13 +20,16 @@ package org.apache.james.mime4j.stream; /** + * <p> * This class represents a context of a parsing operation: + * </p> * <ul> * <li>the current position the parsing operation is expected to start at</li> * <li>the bounds limiting the scope of the parsing operation</li> * </ul> - * <p/> + * <p> * Copied from Apache HttpCore project + * </p> */ public class ParserCursor { http://git-wip-us.apache.org/repos/asf/james-mime4j/blob/64b332b3/core/src/main/java/org/apache/james/mime4j/stream/RawField.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/james/mime4j/stream/RawField.java b/core/src/main/java/org/apache/james/mime4j/stream/RawField.java index e4c49e4..f263b99 100644 --- a/core/src/main/java/org/apache/james/mime4j/stream/RawField.java +++ b/core/src/main/java/org/apache/james/mime4j/stream/RawField.java @@ -25,10 +25,13 @@ import org.apache.james.mime4j.util.ContentUtil; import org.apache.james.mime4j.util.MimeUtil; /** + * <p> * Raw (unstructured) MIME field. The field's body is unparsed and possibly encoded. - * <p/> - * Instances of this class can be created by using + * </p> + * <p> + * Instances of this class can be created by using * {@link RawFieldParser#parseField(ByteSequence)} method. + * </p> */ public final class RawField implements Field { http://git-wip-us.apache.org/repos/asf/james-mime4j/blob/64b332b3/core/src/main/java/org/apache/james/mime4j/stream/RawFieldParser.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/james/mime4j/stream/RawFieldParser.java b/core/src/main/java/org/apache/james/mime4j/stream/RawFieldParser.java index c26cf39..bb6448b 100644 --- a/core/src/main/java/org/apache/james/mime4j/stream/RawFieldParser.java +++ b/core/src/main/java/org/apache/james/mime4j/stream/RawFieldParser.java @@ -29,10 +29,13 @@ import org.apache.james.mime4j.util.CharsetUtil; import org.apache.james.mime4j.util.ContentUtil; /** + * <p> * Low level parser for header field elements. The parsing routines of this class are designed * to produce near zero intermediate garbage and make no intermediate copies of input data. - * <p/> + * </p> + * <p> * This class is immutable and thread safe. + * </p> */ public class RawFieldParser { http://git-wip-us.apache.org/repos/asf/james-mime4j/blob/64b332b3/core/src/main/java/org/apache/james/mime4j/util/ByteSequence.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/james/mime4j/util/ByteSequence.java b/core/src/main/java/org/apache/james/mime4j/util/ByteSequence.java index edcf046..a7b4897 100644 --- a/core/src/main/java/org/apache/james/mime4j/util/ByteSequence.java +++ b/core/src/main/java/org/apache/james/mime4j/util/ByteSequence.java @@ -43,7 +43,7 @@ public interface ByteSequence { * the index of the <code>byte</code> value to be returned. * @return the corresponding <code>byte</code> value * @throws IndexOutOfBoundsException - * if <code>index < 0 || index >= length()</code>. + * if <code>index < 0 || index >= length()</code>. */ byte byteAt(int index); http://git-wip-us.apache.org/repos/asf/james-mime4j/blob/64b332b3/core/src/main/java/org/apache/james/mime4j/util/CharsetUtil.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/james/mime4j/util/CharsetUtil.java b/core/src/main/java/org/apache/james/mime4j/util/CharsetUtil.java index 868145e..3504d29 100644 --- a/core/src/main/java/org/apache/james/mime4j/util/CharsetUtil.java +++ b/core/src/main/java/org/apache/james/mime4j/util/CharsetUtil.java @@ -114,13 +114,16 @@ public class CharsetUtil { } /** + * <p> * Returns a {@link Charset} instance if character set with the given name * is recognized and supported by Java runtime. Returns <code>null</code> * otherwise. - * <p/> + * </p> + * <p> * This method is a wrapper around {@link Charset#forName(String)} method * that catches {@link IllegalCharsetNameException} and * {@link UnsupportedCharsetException} and returns <code>null</code>. + * </p> */ public static Charset lookup(final String name) { if (name == null) { http://git-wip-us.apache.org/repos/asf/james-mime4j/blob/64b332b3/dom/src/main/java/org/apache/james/mime4j/dom/Body.java ---------------------------------------------------------------------- diff --git a/dom/src/main/java/org/apache/james/mime4j/dom/Body.java b/dom/src/main/java/org/apache/james/mime4j/dom/Body.java index 1b94c0e..a043f11 100644 --- a/dom/src/main/java/org/apache/james/mime4j/dom/Body.java +++ b/dom/src/main/java/org/apache/james/mime4j/dom/Body.java @@ -20,11 +20,14 @@ package org.apache.james.mime4j.dom; /** + * <p> * A body of an MIME entity (as defined in RFC 2045). - * <p/> + * </p> + * <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. + * </p> */ public interface Body extends Disposable { http://git-wip-us.apache.org/repos/asf/james-mime4j/blob/64b332b3/dom/src/main/java/org/apache/james/mime4j/field/DefaultFieldParser.java ---------------------------------------------------------------------- diff --git a/dom/src/main/java/org/apache/james/mime4j/field/DefaultFieldParser.java b/dom/src/main/java/org/apache/james/mime4j/field/DefaultFieldParser.java index 52147d0..047ae4b 100644 --- a/dom/src/main/java/org/apache/james/mime4j/field/DefaultFieldParser.java +++ b/dom/src/main/java/org/apache/james/mime4j/field/DefaultFieldParser.java @@ -79,10 +79,11 @@ public class DefaultFieldParser extends DelegatingFieldParser { } /** + * <p> * 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> + * </p> + * <table summary="Field names and corresponding classes"> * <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> http://git-wip-us.apache.org/repos/asf/james-mime4j/blob/64b332b3/dom/src/main/java/org/apache/james/mime4j/field/Fields.java ---------------------------------------------------------------------- diff --git a/dom/src/main/java/org/apache/james/mime4j/field/Fields.java b/dom/src/main/java/org/apache/james/mime4j/field/Fields.java index 95cf83f..72722a1 100644 --- a/dom/src/main/java/org/apache/james/mime4j/field/Fields.java +++ b/dom/src/main/java/org/apache/james/mime4j/field/Fields.java @@ -402,7 +402,7 @@ public class Fields { /** * Creates a <i>Message-ID</i> field with the given message ID. * - * @param message ID + * @param messageId * message ID value. */ public static UnstructuredField messageId(String messageId) { http://git-wip-us.apache.org/repos/asf/james-mime4j/blob/64b332b3/dom/src/main/java/org/apache/james/mime4j/field/LenientFieldParser.java ---------------------------------------------------------------------- diff --git a/dom/src/main/java/org/apache/james/mime4j/field/LenientFieldParser.java b/dom/src/main/java/org/apache/james/mime4j/field/LenientFieldParser.java index 03262d2..e5e7500 100644 --- a/dom/src/main/java/org/apache/james/mime4j/field/LenientFieldParser.java +++ b/dom/src/main/java/org/apache/james/mime4j/field/LenientFieldParser.java @@ -99,10 +99,11 @@ public class LenientFieldParser extends DelegatingFieldParser { } /** + * <p> * 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> + * </p> + * <table summary="Field names and corresponding classes"> * <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> http://git-wip-us.apache.org/repos/asf/james-mime4j/blob/64b332b3/dom/src/main/java/org/apache/james/mime4j/field/address/AddressFormatter.java ---------------------------------------------------------------------- diff --git a/dom/src/main/java/org/apache/james/mime4j/field/address/AddressFormatter.java b/dom/src/main/java/org/apache/james/mime4j/field/address/AddressFormatter.java index d8c096c..ce969c2 100644 --- a/dom/src/main/java/org/apache/james/mime4j/field/address/AddressFormatter.java +++ b/dom/src/main/java/org/apache/james/mime4j/field/address/AddressFormatter.java @@ -36,20 +36,23 @@ public class AddressFormatter { } /** + * <p> * Formats the address as a human readable string, not including the route. * The resulting string is intended for display purposes only and cannot be * used for transport purposes. - * + * </p> + * <p> * For example, if the unparsed address was - * - * <"Joe Cheng"@joecheng.com> - * + * <br> + * <code><"Joe Cheng"@joecheng.com></code> + * <br> * this method would return - * - * <Joe [email protected]> - * + * <br> + * <code><Joe [email protected]></code> + * <br> * which is not valid for transport; the local part would need to be * re-quoted. + * </p> * * @param includeRoute * <code>true</code> if the route should be included if it http://git-wip-us.apache.org/repos/asf/james-mime4j/blob/64b332b3/dom/src/main/java/org/apache/james/mime4j/internal/AbstractEntityBuilder.java ---------------------------------------------------------------------- diff --git a/dom/src/main/java/org/apache/james/mime4j/internal/AbstractEntityBuilder.java b/dom/src/main/java/org/apache/james/mime4j/internal/AbstractEntityBuilder.java index 0ab3765..e5e12b2 100644 --- a/dom/src/main/java/org/apache/james/mime4j/internal/AbstractEntityBuilder.java +++ b/dom/src/main/java/org/apache/james/mime4j/internal/AbstractEntityBuilder.java @@ -122,12 +122,12 @@ public abstract class AbstractEntityBuilder { } /** - * Returns <code>true<code/> if there is at least one explicitly + * Returns <code>true</code> if there is at least one explicitly * set field with the given name. * * @param name the field name (e.g. From, Subject). - * @return <code>true<code/> if there is at least one explicitly - * set field with the given name, <code>false<code/> otherwise. + * @return <code>true</code> if there is at least one explicitly + * set field with the given name, <code>false</code> otherwise. */ public boolean containsField(String name) { List<Field> l = fieldMap.get(name.toLowerCase(Locale.US)); @@ -499,7 +499,7 @@ public abstract class AbstractEntityBuilder { * Sets body of this message. Also sets the content type based on properties of * the given {@link org.apache.james.mime4j.dom.Body}. * - * @param body + * @param textBody * the body. */ public AbstractEntityBuilder setBody(TextBody textBody) { @@ -539,9 +539,9 @@ public abstract class AbstractEntityBuilder { /** * Sets body of this message. Also sets the content type based on properties of - * the given {@link org.apache.james.mime4j.dom.Body}. + * the given {@link org.apache.james.mime4j.dom.Message}. * - * @param body + * @param message * the body. */ public AbstractEntityBuilder setBody(Message message) { @@ -560,9 +560,9 @@ public abstract class AbstractEntityBuilder { /** * Sets body of this message. Also sets the content type based on properties of - * the given {@link org.apache.james.mime4j.dom.Body}. + * the given {@link org.apache.james.mime4j.dom.Multipart}. * - * @param body + * @param multipart * the body. */ public AbstractEntityBuilder setBody(Multipart multipart) { http://git-wip-us.apache.org/repos/asf/james-mime4j/blob/64b332b3/dom/src/main/java/org/apache/james/mime4j/message/BasicBodyFactory.java ---------------------------------------------------------------------- diff --git a/dom/src/main/java/org/apache/james/mime4j/message/BasicBodyFactory.java b/dom/src/main/java/org/apache/james/mime4j/message/BasicBodyFactory.java index 5107be5..d4d0571 100644 --- a/dom/src/main/java/org/apache/james/mime4j/message/BasicBodyFactory.java +++ b/dom/src/main/java/org/apache/james/mime4j/message/BasicBodyFactory.java @@ -65,14 +65,18 @@ public class BasicBodyFactory implements BodyFactory { } /** - * select the Charset for the given mimeCharset string - * <p/> - * if you need support for non standard or invalid mimeCharset specifications you might want to - * create your own derived BodyFactory extending BasicBodyFactory and overriding this method as - * suggested by: https://issues.apache.org/jira/browse/MIME4J-218 - * <p/> - * the default behavior is lenient, invalid mimeCharset specifications will return the - * defaultCharset + * <p> + * Select the Charset for the given <code>mimeCharset</code> string. + * </p> + * <p> + * If you need support for non standard or invalid <code>mimeCharset</code> specifications you might want to + * create your own derived {@link BodyFactory} extending {@link BasicBodyFactory} and overriding this method as + * suggested by <a href="https://issues.apache.org/jira/browse/MIME4J-218";>MIME4J-218</a> + * </p> + * <p> + * The default behavior is lenient, invalid <code>mimeCharset</code> specifications will return the + * <code>defaultCharset</code>. + * </p> * * @param mimeCharset - the string specification for a Charset e.g. "UTF-8" * @throws UnsupportedEncodingException if the mimeCharset is invalid http://git-wip-us.apache.org/repos/asf/james-mime4j/blob/64b332b3/dom/src/main/java/org/apache/james/mime4j/message/BodyPartBuilder.java ---------------------------------------------------------------------- diff --git a/dom/src/main/java/org/apache/james/mime4j/message/BodyPartBuilder.java b/dom/src/main/java/org/apache/james/mime4j/message/BodyPartBuilder.java index 837592f..3ded0e9 100644 --- a/dom/src/main/java/org/apache/james/mime4j/message/BodyPartBuilder.java +++ b/dom/src/main/java/org/apache/james/mime4j/message/BodyPartBuilder.java @@ -189,7 +189,7 @@ public class BodyPartBuilder extends AbstractEntityBuilder { /** * Sets binary content of this message with the given MIME type. * - * @param body + * @param bin * the body. * @param mimeType * the MIME media type of the specified body http://git-wip-us.apache.org/repos/asf/james-mime4j/blob/64b332b3/dom/src/main/javacc/org/apache/james/mime4j/field/contentdisposition/ParseException.java ---------------------------------------------------------------------- diff --git a/dom/src/main/javacc/org/apache/james/mime4j/field/contentdisposition/ParseException.java b/dom/src/main/javacc/org/apache/james/mime4j/field/contentdisposition/ParseException.java index 5af758c..e332ffd 100644 --- a/dom/src/main/javacc/org/apache/james/mime4j/field/contentdisposition/ParseException.java +++ b/dom/src/main/javacc/org/apache/james/mime4j/field/contentdisposition/ParseException.java @@ -45,7 +45,8 @@ public class ParseException extends org.apache.james.mime4j.dom.field.ParseExcep * This constructor calls its super class with the empty string * to force the "toString" method of parent class "Throwable" to * print the error message in the form: - * ParseException: <result of getMessage> + * <br> + * ParseException: <result of getMessage> */ public ParseException(Token currentTokenVal, int[][] expectedTokenSequencesVal, http://git-wip-us.apache.org/repos/asf/james-mime4j/blob/64b332b3/dom/src/main/javacc/org/apache/james/mime4j/field/contenttype/ParseException.java ---------------------------------------------------------------------- diff --git a/dom/src/main/javacc/org/apache/james/mime4j/field/contenttype/ParseException.java b/dom/src/main/javacc/org/apache/james/mime4j/field/contenttype/ParseException.java index 3a4c670..fdeacde 100644 --- a/dom/src/main/javacc/org/apache/james/mime4j/field/contenttype/ParseException.java +++ b/dom/src/main/javacc/org/apache/james/mime4j/field/contenttype/ParseException.java @@ -45,7 +45,8 @@ public class ParseException extends org.apache.james.mime4j.dom.field.ParseExcep * This constructor calls its super class with the empty string * to force the "toString" method of parent class "Throwable" to * print the error message in the form: - * ParseException: <result of getMessage> + * <br> + * ParseException: <result of getMessage> */ public ParseException(Token currentTokenVal, int[][] expectedTokenSequencesVal, http://git-wip-us.apache.org/repos/asf/james-mime4j/blob/64b332b3/dom/src/main/javacc/org/apache/james/mime4j/field/datetime/ParseException.java ---------------------------------------------------------------------- diff --git a/dom/src/main/javacc/org/apache/james/mime4j/field/datetime/ParseException.java b/dom/src/main/javacc/org/apache/james/mime4j/field/datetime/ParseException.java index ee78a79..269ed23 100644 --- a/dom/src/main/javacc/org/apache/james/mime4j/field/datetime/ParseException.java +++ b/dom/src/main/javacc/org/apache/james/mime4j/field/datetime/ParseException.java @@ -45,7 +45,8 @@ public class ParseException extends org.apache.james.mime4j.dom.field.ParseExcep * This constructor calls its super class with the empty string * to force the "toString" method of parent class "Throwable" to * print the error message in the form: - * ParseException: <result of getMessage> + * <br> + * ParseException: <result of getMessage> */ public ParseException(Token currentTokenVal, int[][] expectedTokenSequencesVal, http://git-wip-us.apache.org/repos/asf/james-mime4j/blob/64b332b3/dom/src/main/javacc/org/apache/james/mime4j/field/language/ParseException.java ---------------------------------------------------------------------- diff --git a/dom/src/main/javacc/org/apache/james/mime4j/field/language/ParseException.java b/dom/src/main/javacc/org/apache/james/mime4j/field/language/ParseException.java index efdb862..073518f 100644 --- a/dom/src/main/javacc/org/apache/james/mime4j/field/language/ParseException.java +++ b/dom/src/main/javacc/org/apache/james/mime4j/field/language/ParseException.java @@ -45,7 +45,8 @@ public class ParseException extends org.apache.james.mime4j.dom.field.ParseExcep * This constructor calls its super class with the empty string * to force the "toString" method of parent class "Throwable" to * print the error message in the form: - * ParseException: <result of getMessage> + * <br> + * ParseException: <result of getMessage> */ public ParseException(Token currentTokenVal, int[][] expectedTokenSequencesVal, http://git-wip-us.apache.org/repos/asf/james-mime4j/blob/64b332b3/dom/src/main/javacc/org/apache/james/mime4j/field/mimeversion/ParseException.java ---------------------------------------------------------------------- diff --git a/dom/src/main/javacc/org/apache/james/mime4j/field/mimeversion/ParseException.java b/dom/src/main/javacc/org/apache/james/mime4j/field/mimeversion/ParseException.java index 89f667d..538e836 100644 --- a/dom/src/main/javacc/org/apache/james/mime4j/field/mimeversion/ParseException.java +++ b/dom/src/main/javacc/org/apache/james/mime4j/field/mimeversion/ParseException.java @@ -45,7 +45,8 @@ public class ParseException extends org.apache.james.mime4j.dom.field.ParseExcep * This constructor calls its super class with the empty string * to force the "toString" method of parent class "Throwable" to * print the error message in the form: - * ParseException: <result of getMessage> + * <br> + * ParseException: <result of getMessage> */ public ParseException(Token currentTokenVal, int[][] expectedTokenSequencesVal, http://git-wip-us.apache.org/repos/asf/james-mime4j/blob/64b332b3/dom/src/main/javacc/org/apache/james/mime4j/field/structured/ParseException.java ---------------------------------------------------------------------- diff --git a/dom/src/main/javacc/org/apache/james/mime4j/field/structured/ParseException.java b/dom/src/main/javacc/org/apache/james/mime4j/field/structured/ParseException.java index 11e3eec..357fce9 100644 --- a/dom/src/main/javacc/org/apache/james/mime4j/field/structured/ParseException.java +++ b/dom/src/main/javacc/org/apache/james/mime4j/field/structured/ParseException.java @@ -45,7 +45,8 @@ public class ParseException extends org.apache.james.mime4j.dom.field.ParseExcep * This constructor calls its super class with the empty string * to force the "toString" method of parent class "Throwable" to * print the error message in the form: - * ParseException: <result of getMessage> + * <br> + * ParseException: <result of getMessage> */ public ParseException(Token currentTokenVal, int[][] expectedTokenSequencesVal, http://git-wip-us.apache.org/repos/asf/james-mime4j/blob/64b332b3/dom/src/main/jjtree/org/apache/james/mime4j/field/address/ParseException.java ---------------------------------------------------------------------- diff --git a/dom/src/main/jjtree/org/apache/james/mime4j/field/address/ParseException.java b/dom/src/main/jjtree/org/apache/james/mime4j/field/address/ParseException.java index 8b314f9..850ef1c 100644 --- a/dom/src/main/jjtree/org/apache/james/mime4j/field/address/ParseException.java +++ b/dom/src/main/jjtree/org/apache/james/mime4j/field/address/ParseException.java @@ -45,7 +45,8 @@ public class ParseException extends org.apache.james.mime4j.dom.field.ParseExcep * This constructor calls its super class with the empty string * to force the "toString" method of parent class "Throwable" to * print the error message in the form: - * ParseException: <result of getMessage> + * <br> + * ParseException: <result of getMessage> */ public ParseException(Token currentTokenVal, int[][] expectedTokenSequencesVal, http://git-wip-us.apache.org/repos/asf/james-mime4j/blob/64b332b3/mbox/src/main/java/org/apache/james/mime4j/mboxiterator/MboxIterator.java ---------------------------------------------------------------------- diff --git a/mbox/src/main/java/org/apache/james/mime4j/mboxiterator/MboxIterator.java b/mbox/src/main/java/org/apache/james/mime4j/mboxiterator/MboxIterator.java index da63e26..f7a2f20 100644 --- a/mbox/src/main/java/org/apache/james/mime4j/mboxiterator/MboxIterator.java +++ b/mbox/src/main/java/org/apache/james/mime4j/mboxiterator/MboxIterator.java @@ -40,7 +40,6 @@ import java.util.regex.Pattern; * Class that provides an iterator over email messages inside an mbox file. An mbox file is a sequence of * email messages separated by From_ lines. * </p> - * <p/> * <p>Description ot the file format:</p> * <ul> * <li>http://tools.ietf.org/html/rfc4155</li> --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
