Author: rdonkin
Date: Sun Feb 15 17:10:52 2009
New Revision: 744699
URL: http://svn.apache.org/viewvc?rev=744699&view=rev
Log:
Fix warnings in javadocs in Java 1.4. MAILETBASE-4
Modified:
james/mailet/base/trunk/src/main/java/org/apache/mailet/base/FlowedMessageUtils.java
james/mailet/base/trunk/src/main/java/org/apache/mailet/base/GenericMailet.java
james/mailet/base/trunk/src/main/java/org/apache/mailet/base/StringUtils.java
Modified:
james/mailet/base/trunk/src/main/java/org/apache/mailet/base/FlowedMessageUtils.java
URL:
http://svn.apache.org/viewvc/james/mailet/base/trunk/src/main/java/org/apache/mailet/base/FlowedMessageUtils.java?rev=744699&r1=744698&r2=744699&view=diff
==============================================================================
---
james/mailet/base/trunk/src/main/java/org/apache/mailet/base/FlowedMessageUtils.java
(original)
+++
james/mailet/base/trunk/src/main/java/org/apache/mailet/base/FlowedMessageUtils.java
Sun Feb 15 17:10:52 2009
@@ -60,7 +60,7 @@
}
/**
- * Decodes a text previously wrapped using "format=flowed"
+ * Decodes a text previously wrapped using "format=flowed".
*/
public static String deflow(String text, boolean delSp) {
String[] lines = text.split("\r\n|\n", -1);
@@ -129,7 +129,7 @@
}
/**
- * Obtains the content of the encoded message, if previously encoded as
format=flowed.
+ * Obtains the content of the encoded message, if previously encoded as
<code>format=flowed</code>.
*/
public static String deflow(Message m) throws IOException,
MessagingException {
ContentType ct = new ContentType(m.getContentType());
@@ -144,7 +144,8 @@
}
/**
- * If the message is formad=flowed set the encoded version as message
content
+ * If the message is <code>format=flowed</code>
+ * set the encoded version as message content.
*/
public static void deflowMessage(Message m) throws MessagingException,
IOException {
ContentType ct = new ContentType(m.getContentType());
@@ -166,14 +167,14 @@
/**
- * Encode a text (using standard with)
+ * Encodes a text (using standard with).
*/
public static String flow(String text, boolean delSp) {
return flow(text, delSp, RFC2646_WIDTH);
}
/**
- * Decode a text
+ * Decodes a text.
*/
public static String flow(String text, boolean delSp, int width) {
StringBuffer result = new StringBuffer();
@@ -235,14 +236,14 @@
}
/**
- * Encode the input text and sets it as the new message content
+ * Encodes the input text and sets it as the new message content.
*/
public static void setFlowedContent(Message m, String text, boolean delSp)
throws MessagingException {
setFlowedContent(m, text, delSp, RFC2646_WIDTH, true, null);
}
/**
- * Encode the input text and sets it as the new message content
+ * Encodes the input text and sets it as the new message content.
*/
public static void setFlowedContent(Message m, String text, boolean delSp,
int width, boolean preserveCharset, String charset) throws MessagingException {
String coded = flow(text, delSp, width);
@@ -261,14 +262,14 @@
}
/**
- * Encode the message content (if text/plain).
+ * Encodes the message content (if text/plain).
*/
public static void flowMessage(Message m, boolean delSp) throws
MessagingException, IOException {
flowMessage(m, delSp, RFC2646_WIDTH);
}
/**
- * Encode the message content (if text/plain).
+ * Encodes the message content (if text/plain).
*/
public static void flowMessage(Message m, boolean delSp, int width) throws
MessagingException, IOException {
ContentType ct = new ContentType(m.getContentType());
@@ -283,8 +284,8 @@
}
/**
- * Check wether the char is part of a word
- * <p>RFC assert a word cannot be splitted (even if the length is greater
than the maximum length)
+ * Checks whether the char is part of a word.
+ * <p>RFC assert a word cannot be splitted (even if the length is greater
than the maximum length).
*/
public static boolean isAlphaChar(String text, int index) {
// Note: a list of chars is available here:
@@ -294,7 +295,7 @@
}
/**
- * Check wether the input message is formad=flowed
+ * Checks whether the input message is <code>format=flowed</code>.
*/
public static boolean isFlowedTextMessage(Message m) throws
MessagingException {
ContentType ct = new ContentType(m.getContentType());
Modified:
james/mailet/base/trunk/src/main/java/org/apache/mailet/base/GenericMailet.java
URL:
http://svn.apache.org/viewvc/james/mailet/base/trunk/src/main/java/org/apache/mailet/base/GenericMailet.java?rev=744699&r1=744698&r2=744699&view=diff
==============================================================================
---
james/mailet/base/trunk/src/main/java/org/apache/mailet/base/GenericMailet.java
(original)
+++
james/mailet/base/trunk/src/main/java/org/apache/mailet/base/GenericMailet.java
Sun Feb 15 17:10:52 2009
@@ -64,7 +64,7 @@
* @return true when the init parameter is <code>true</code> (ignoring
case);
* false when the init parameter is <code>false</code> (ignoring case);
* otherwise the default value
- * @throws NullPointerException when {...@link #config} is unset
+ * @throws NullPointerException before {...@link #init(MailetConfig)}
*/
public boolean getInitParameter(String name, boolean defaultValue) {
if (config == null) {
Modified:
james/mailet/base/trunk/src/main/java/org/apache/mailet/base/StringUtils.java
URL:
http://svn.apache.org/viewvc/james/mailet/base/trunk/src/main/java/org/apache/mailet/base/StringUtils.java?rev=744699&r1=744698&r2=744699&view=diff
==============================================================================
---
james/mailet/base/trunk/src/main/java/org/apache/mailet/base/StringUtils.java
(original)
+++
james/mailet/base/trunk/src/main/java/org/apache/mailet/base/StringUtils.java
Sun Feb 15 17:10:52 2009
@@ -33,11 +33,11 @@
}
/**
- * Split a string given a pattern (regex), considering escapes
- * <p> E.g: considering a pattern "," we have:
+ * Splits a string given a pattern (regex), considering escapes.
+ * <p> For example considering a pattern "," we have:
* one,two,three => {one},{two},{three}
* one\,two\\,three => {one,two\\},{three}
- *
+ * <p>
* NOTE: Untested with pattern regex as pattern and untested for escape
chars in text or pattern.
*/
public static String[] split(String text, String pattern) {
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
