Author: rdonkin
Date: Thu Nov 29 01:28:54 2007
New Revision: 599355
URL: http://svn.apache.org/viewvc?rev=599355&view=rev
Log:
Corrected javadocs
Modified:
james/server/trunk/core-library/src/main/java/org/apache/james/mailboxmanager/MailboxNotFoundException.java
james/server/trunk/core-library/src/main/java/org/apache/james/mailboxmanager/MessageResult.java
james/server/trunk/core-library/src/main/java/org/apache/james/mailboxmanager/MessageResultUtils.java
james/server/trunk/core-library/src/main/java/org/apache/james/mailboxmanager/tracking/UidChangeTracker.java
james/server/trunk/core-library/src/main/java/org/apache/james/util/SqlResources.java
Modified:
james/server/trunk/core-library/src/main/java/org/apache/james/mailboxmanager/MailboxNotFoundException.java
URL:
http://svn.apache.org/viewvc/james/server/trunk/core-library/src/main/java/org/apache/james/mailboxmanager/MailboxNotFoundException.java?rev=599355&r1=599354&r2=599355&view=diff
==============================================================================
---
james/server/trunk/core-library/src/main/java/org/apache/james/mailboxmanager/MailboxNotFoundException.java
(original)
+++
james/server/trunk/core-library/src/main/java/org/apache/james/mailboxmanager/MailboxNotFoundException.java
Thu Nov 29 01:28:54 2007
@@ -50,7 +50,7 @@
/**
* Gets the name of the mailbox which cannot be found.
- * @return
+ * @return name
*/
public final String getMailboxName() {
return mailboxName;
Modified:
james/server/trunk/core-library/src/main/java/org/apache/james/mailboxmanager/MessageResult.java
URL:
http://svn.apache.org/viewvc/james/server/trunk/core-library/src/main/java/org/apache/james/mailboxmanager/MessageResult.java?rev=599355&r1=599354&r2=599355&view=diff
==============================================================================
---
james/server/trunk/core-library/src/main/java/org/apache/james/mailboxmanager/MessageResult.java
(original)
+++
james/server/trunk/core-library/src/main/java/org/apache/james/mailboxmanager/MessageResult.java
Thu Nov 29 01:28:54 2007
@@ -98,7 +98,7 @@
/**
* Gets the results set.
* @return bitwise indication of result set
- * @see [EMAIL PROTECTED] MessageResultUtils#isIncluded(MessageResult,
int)}
+ * @see MessageResultUtils#isIncluded(MessageResult, int)
*/
int getIncludedResults();
Modified:
james/server/trunk/core-library/src/main/java/org/apache/james/mailboxmanager/MessageResultUtils.java
URL:
http://svn.apache.org/viewvc/james/server/trunk/core-library/src/main/java/org/apache/james/mailboxmanager/MessageResultUtils.java?rev=599355&r1=599354&r2=599355&view=diff
==============================================================================
---
james/server/trunk/core-library/src/main/java/org/apache/james/mailboxmanager/MessageResultUtils.java
(original)
+++
james/server/trunk/core-library/src/main/java/org/apache/james/mailboxmanager/MessageResultUtils.java
Thu Nov 29 01:28:54 2007
@@ -108,7 +108,7 @@
/**
* Is the given datum included in these results?
- * @param result <code>MessageResult</code>, possibly null
+ * @param message <code>MessageResult</code>, possibly null
* @param datum [EMAIL PROTECTED] MessageResult} datum constant
* @return true if <code>MessageResult</code> includes
* the given datum, false if <code>MessageResult</code> is null
@@ -129,11 +129,11 @@
/**
* Is [EMAIL PROTECTED] MessageResult#BODY_CONTENT} included in these
results?
- * @param result <code>MessageResult</code>, possibly null
+ * @param message <code>MessageResult</code>, possibly null
* @return true if <code>MessageResult</code> includes
* BODY_CONTENT, false if <code>MessageResult</code> is null
* or does not contain BODY_CONTENT
- * @see [EMAIL PROTECTED] #isIncluded(MessageResult, int)}
+ * @see #isIncluded(MessageResult, int)
*/
public static boolean isBodyContentIncluded(final MessageResult message) {
return isIncluded(message, MessageResult.BODY_CONTENT);
@@ -141,11 +141,11 @@
/**
* Is [EMAIL PROTECTED] MessageResult#FLAGS} included in these results?
- * @param result <code>MessageResult</code>, possibly null
+ * @param message <code>MessageResult</code>, possibly null
* @return true if <code>MessageResult</code> includes
* FLAGS, false if <code>MessageResult</code> is null
* or does not contain FLAGS
- * @see [EMAIL PROTECTED] #isIncluded(MessageResult, int)}
+ * @see #isIncluded(MessageResult, int)
*/
public static boolean isFlagsIncluded(final MessageResult message) {
return isIncluded(message, MessageResult.FLAGS);
@@ -153,11 +153,11 @@
/**
* Is [EMAIL PROTECTED] MessageResult#FULL_CONTENT} included in these
results?
- * @param result <code>MessageResult</code>, possibly null
+ * @param message <code>MessageResult</code>, possibly null
* @return true if <code>MessageResult</code> includes
* FULL_CONTENT, false if <code>MessageResult</code> is null
* or does not contain FULL_CONTENT
- * @see [EMAIL PROTECTED] #isIncluded(MessageResult, int)}
+ * @see #isIncluded(MessageResult, int)
*/
public static boolean isFullContentIncluded(final MessageResult message) {
return isIncluded(message, MessageResult.FULL_CONTENT);
@@ -165,11 +165,11 @@
/**
* Is [EMAIL PROTECTED] MessageResult#HEADERS} included in these results?
- * @param result <code>MessageResult</code>, possibly null
+ * @param message <code>MessageResult</code>, possibly null
* @return true if <code>MessageResult</code> includes
* HEADERS, false if <code>MessageResult</code> is null
* or does not contain HEADERS
- * @see [EMAIL PROTECTED] #isIncluded(MessageResult, int)}
+ * @see #isIncluded(MessageResult, int)
*/
public static boolean isHeadersIncluded(final MessageResult message) {
return isIncluded(message, MessageResult.HEADERS);
@@ -177,11 +177,11 @@
/**
* Is [EMAIL PROTECTED] MessageResult#KEY} included in these results?
- * @param result <code>MessageResult</code>, possibly null
+ * @param message <code>MessageResult</code>, possibly null
* @return true if <code>MessageResult</code> includes
* KEY, false if <code>MessageResult</code> is null
* or does not contain KEY
- * @see [EMAIL PROTECTED] #isIncluded(MessageResult, int)}
+ * @see #isIncluded(MessageResult, int)
*/
public static boolean isKeyIncluded(final MessageResult message) {
return isIncluded(message, MessageResult.KEY);
@@ -189,11 +189,11 @@
/**
* Is [EMAIL PROTECTED] MessageResult#INTERNAL_DATE} included in these
results?
- * @param result <code>MessageResult</code>, possibly null
+ * @param message <code>MessageResult</code>, possibly null
* @return true if <code>MessageResult</code> includes
* INTERNAL_DATE, false if <code>MessageResult</code> is null
* or does not contain INTERNAL_DATE
- * @see [EMAIL PROTECTED] #isIncluded(MessageResult, int)}
+ * @see #isIncluded(MessageResult, int)
*/
public static boolean isInternalDateIncluded(final MessageResult message) {
return isIncluded(message, MessageResult.INTERNAL_DATE);
@@ -201,11 +201,11 @@
/**
* Is [EMAIL PROTECTED] MessageResult#MIME_MESSAGE} included in these
results?
- * @param result <code>MessageResult</code>, possibly null
+ * @param message <code>MessageResult</code>, possibly null
* @return true if <code>MessageResult</code> includes
* MIME_MESSAGE, false if <code>MessageResult</code> is null
* or does not contain MIME_MESSAGE
- * @see [EMAIL PROTECTED] #isIncluded(MessageResult, int)}
+ * @see #isIncluded(MessageResult, int)
*/
public static boolean isMimeMessageIncluded(final MessageResult message) {
return isIncluded(message, MessageResult.MIME_MESSAGE);
@@ -213,11 +213,11 @@
/**
* Is [EMAIL PROTECTED] MessageResult#SIZE} included in these results?
- * @param result <code>MessageResult</code>, possibly null
+ * @param message <code>MessageResult</code>, possibly null
* @return true if <code>MessageResult</code> includes
* SIZE, false if <code>MessageResult</code> is null
* or does not contain SIZE
- * @see [EMAIL PROTECTED] #isIncluded(MessageResult, int)}
+ * @see #isIncluded(MessageResult, int)
*/
public static boolean isSizeIncluded(final MessageResult message) {
return isIncluded(message, MessageResult.SIZE);
@@ -226,11 +226,11 @@
/**
* Is [EMAIL PROTECTED] MessageResult#UID} included in these results?
- * @param result <code>MessageResult</code>, possibly null
+ * @param message <code>MessageResult</code>, possibly null
* @return true if <code>MessageResult</code> includes
* UID, false if <code>MessageResult</code> is null
* or does not contain UID
- * @see [EMAIL PROTECTED] #isIncluded(MessageResult, int)}
+ * @see #isIncluded(MessageResult, int)
*/
public static boolean isUidIncluded(final MessageResult message) {
return isIncluded(message, MessageResult.UID);
@@ -238,11 +238,11 @@
/**
* Is [EMAIL PROTECTED] MessageResult#MSN} included in these results?
- * @param result <code>MessageResult</code>, possibly null
+ * @param message <code>MessageResult</code>, possibly null
* @return true if <code>MessageResult</code> includes
* MSN, false if <code>MessageResult</code> is null
* or does not contain MSN
- * @see [EMAIL PROTECTED] #isIncluded(MessageResult, int)}
+ * @see #isIncluded(MessageResult, int)
*/
public static boolean isMsnIncluded(final MessageResult message) {
return isIncluded(message, MessageResult.MSN);
Modified:
james/server/trunk/core-library/src/main/java/org/apache/james/mailboxmanager/tracking/UidChangeTracker.java
URL:
http://svn.apache.org/viewvc/james/server/trunk/core-library/src/main/java/org/apache/james/mailboxmanager/tracking/UidChangeTracker.java?rev=599355&r1=599354&r2=599355&view=diff
==============================================================================
---
james/server/trunk/core-library/src/main/java/org/apache/james/mailboxmanager/tracking/UidChangeTracker.java
(original)
+++
james/server/trunk/core-library/src/main/java/org/apache/james/mailboxmanager/tracking/UidChangeTracker.java
Thu Nov 29 01:28:54 2007
@@ -67,7 +67,7 @@
/**
* Indicates that the flags on the given messages may have been updated.
- * @param messageResults results
+ * @param messageFlags flags
* @param sessionId id of the session upating the flags
* @see #flagsUpdated(MessageResult, long)
*/
Modified:
james/server/trunk/core-library/src/main/java/org/apache/james/util/SqlResources.java
URL:
http://svn.apache.org/viewvc/james/server/trunk/core-library/src/main/java/org/apache/james/util/SqlResources.java?rev=599355&r1=599354&r2=599355&view=diff
==============================================================================
---
james/server/trunk/core-library/src/main/java/org/apache/james/util/SqlResources.java
(original)
+++
james/server/trunk/core-library/src/main/java/org/apache/james/util/SqlResources.java
Thu Nov 29 01:28:54 2007
@@ -108,7 +108,7 @@
* replace by values from the parameters Map, if the named parameter
exists.
* Parameter values may also be specified in the resourceSection element.
*
- * @param sqlFile the input stream containing the xml
+ * @param input the input stream containing the xml
* @param sqlDefsSection
* the xml element containing the strings to be used
* @param conn the Jdbc DatabaseMetaData, taken from a database connection
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
