Author: norman
Date: Sat Sep 23 09:25:34 2006
New Revision: 449269
URL: http://svn.apache.org/viewvc?view=rev&rev=449269
Log:
Fix/Add javadocs. See JAMES-628
Remove some unused imports and code
Change some Exception to be more specific
Modified:
james/server/trunk/src/java/org/apache/james/mailrepository/MBoxMailRepository.java
james/server/trunk/src/java/org/apache/james/mailrepository/javamail/HashJavamailStoreMailRepository.java
james/server/trunk/src/java/org/apache/james/mailrepository/javamail/UIDPlusFolderMailRepository.java
james/server/trunk/src/java/org/apache/james/mailrepository/javamail/UidToKeyBidiMap.java
james/server/trunk/src/java/org/apache/james/nntpserver/NNTPHandler.java
james/server/trunk/src/java/org/apache/james/pop3server/POP3Handler.java
james/server/trunk/src/java/org/apache/james/pop3server/POP3Session.java
james/server/trunk/src/java/org/apache/james/services/MailServer.java
james/server/trunk/src/java/org/apache/james/services/MailetLoader.java
james/server/trunk/src/java/org/apache/james/services/MatcherLoader.java
james/server/trunk/src/java/org/apache/james/services/SpoolManagementService.java
james/server/trunk/src/java/org/apache/james/util/Base64.java
james/server/trunk/src/java/org/apache/james/util/BayesianAnalyzer.java
james/server/trunk/src/java/org/apache/james/util/CRLFTerminatedReader.java
james/server/trunk/src/java/org/apache/james/util/DebugInputStream.java
james/server/trunk/src/java/org/apache/james/util/JDBCBayesianAnalyzer.java
james/server/trunk/src/java/org/apache/james/util/MatcherInverter.java
james/server/trunk/src/java/org/apache/james/util/POP3BeforeSMTPHelper.java
james/server/trunk/src/java/org/apache/james/util/XMLResources.java
james/server/trunk/src/java/org/apache/james/util/dbcp/JdbcDataSource.java
Modified:
james/server/trunk/src/java/org/apache/james/mailrepository/MBoxMailRepository.java
URL:
http://svn.apache.org/viewvc/james/server/trunk/src/java/org/apache/james/mailrepository/MBoxMailRepository.java?view=diff&rev=449269&r1=449268&r2=449269
==============================================================================
---
james/server/trunk/src/java/org/apache/james/mailrepository/MBoxMailRepository.java
(original)
+++
james/server/trunk/src/java/org/apache/james/mailrepository/MBoxMailRepository.java
Sat Sep 23 09:25:34 2006
@@ -47,9 +47,6 @@
package org.apache.james.mailrepository;
-import org.apache.avalon.framework.service.ServiceException;
-import org.apache.avalon.framework.service.ServiceManager;
-import org.apache.avalon.framework.service.Serviceable;
import org.apache.avalon.framework.configuration.Configurable;
import org.apache.avalon.framework.configuration.Configuration;
import org.apache.avalon.framework.configuration.ConfigurationException;
@@ -116,7 +113,7 @@
public class MBoxMailRepository
extends AbstractLogEnabled
- implements MailRepository, Serviceable, Configurable {
+ implements MailRepository, Configurable {
static final SimpleDateFormat dy = new SimpleDateFormat("EE MMM dd
HH:mm:ss yyyy", Locale.US);
@@ -770,15 +767,6 @@
public boolean unlock(String key) {
return false;
}
-
-
- /**
- * @see
org.apache.avalon.framework.service.Serviceable#compose(ServiceManager )
- */
- public void service( final ServiceManager componentManager )
- throws ServiceException {
- }
-
/**
* @see
org.apache.avalon.framework.configuration.Configurable#configure(Configuration)
Modified:
james/server/trunk/src/java/org/apache/james/mailrepository/javamail/HashJavamailStoreMailRepository.java
URL:
http://svn.apache.org/viewvc/james/server/trunk/src/java/org/apache/james/mailrepository/javamail/HashJavamailStoreMailRepository.java?view=diff&rev=449269&r1=449268&r2=449269
==============================================================================
---
james/server/trunk/src/java/org/apache/james/mailrepository/javamail/HashJavamailStoreMailRepository.java
(original)
+++
james/server/trunk/src/java/org/apache/james/mailrepository/javamail/HashJavamailStoreMailRepository.java
Sat Sep 23 09:25:34 2006
@@ -462,7 +462,7 @@
*
* @param key
* key of message
- * @param decrease
+ * @param decrement
* if true, all message number greater than this are
* decremented
*/
Modified:
james/server/trunk/src/java/org/apache/james/mailrepository/javamail/UIDPlusFolderMailRepository.java
URL:
http://svn.apache.org/viewvc/james/server/trunk/src/java/org/apache/james/mailrepository/javamail/UIDPlusFolderMailRepository.java?view=diff&rev=449269&r1=449268&r2=449269
==============================================================================
---
james/server/trunk/src/java/org/apache/james/mailrepository/javamail/UIDPlusFolderMailRepository.java
(original)
+++
james/server/trunk/src/java/org/apache/james/mailrepository/javamail/UIDPlusFolderMailRepository.java
Sat Sep 23 09:25:34 2006
@@ -374,7 +374,7 @@
/**
* returns a UIDPlusFolderAdapter wrapper
*
- * @see org.apache.james.Mailrepository.javamail.UIDPlusFolderAdapter
+ * @see
org.apache.james.mailrepository.javamail.UIDPlusFolderAdapter#UIDPlusFolderAdapter(Folder)
*/
protected FolderInterface createAdapter(Folder folder) throws
NoSuchMethodException {
return new UIDPlusFolderAdapter(folder);
Modified:
james/server/trunk/src/java/org/apache/james/mailrepository/javamail/UidToKeyBidiMap.java
URL:
http://svn.apache.org/viewvc/james/server/trunk/src/java/org/apache/james/mailrepository/javamail/UidToKeyBidiMap.java?view=diff&rev=449269&r1=449268&r2=449269
==============================================================================
---
james/server/trunk/src/java/org/apache/james/mailrepository/javamail/UidToKeyBidiMap.java
(original)
+++
james/server/trunk/src/java/org/apache/james/mailrepository/javamail/UidToKeyBidiMap.java
Sat Sep 23 09:25:34 2006
@@ -77,7 +77,7 @@
/**
* Get uid for the given key
*
- * @param the key
+ * @param key the key
* @return uid the uid for the given key
*/
long getByKey(String key);
Modified:
james/server/trunk/src/java/org/apache/james/nntpserver/NNTPHandler.java
URL:
http://svn.apache.org/viewvc/james/server/trunk/src/java/org/apache/james/nntpserver/NNTPHandler.java?view=diff&rev=449269&r1=449268&r2=449269
==============================================================================
--- james/server/trunk/src/java/org/apache/james/nntpserver/NNTPHandler.java
(original)
+++ james/server/trunk/src/java/org/apache/james/nntpserver/NNTPHandler.java
Sat Sep 23 09:25:34 2006
@@ -291,7 +291,7 @@
}
/**
- * @see
org.apache.james.core.AbstractJamesHandler#erorHandler(RuntimeException e);
+ * @see
org.apache.james.core.AbstractJamesHandler#errorHandler(java.lang.RuntimeException)
*/
protected void errorHandler(RuntimeException e) {
super.errorHandler(e);
Modified:
james/server/trunk/src/java/org/apache/james/pop3server/POP3Handler.java
URL:
http://svn.apache.org/viewvc/james/server/trunk/src/java/org/apache/james/pop3server/POP3Handler.java?view=diff&rev=449269&r1=449268&r2=449269
==============================================================================
--- james/server/trunk/src/java/org/apache/james/pop3server/POP3Handler.java
(original)
+++ james/server/trunk/src/java/org/apache/james/pop3server/POP3Handler.java
Sat Sep 23 09:25:34 2006
@@ -488,7 +488,7 @@
}
/**
- * @see
org.apache.james.pop3server.POP3Session#setUserMailbox(java.util.ArrayList)
+ * @see
org.apache.james.pop3server.POP3Session#setUserMailbox(java.util.List)
*/
public void setUserMailbox(List userMailbox) {
this.userMailbox = userMailbox;
Modified:
james/server/trunk/src/java/org/apache/james/pop3server/POP3Session.java
URL:
http://svn.apache.org/viewvc/james/server/trunk/src/java/org/apache/james/pop3server/POP3Session.java?view=diff&rev=449269&r1=449268&r2=449269
==============================================================================
--- james/server/trunk/src/java/org/apache/james/pop3server/POP3Session.java
(original)
+++ james/server/trunk/src/java/org/apache/james/pop3server/POP3Session.java
Sat Sep 23 09:25:34 2006
@@ -139,7 +139,7 @@
/**
* Sets the user name associated with this POP3 interaction.
*
- * @param userID the user name
+ * @param user the user name
*/
void setUser(String user);
Modified: james/server/trunk/src/java/org/apache/james/services/MailServer.java
URL:
http://svn.apache.org/viewvc/james/server/trunk/src/java/org/apache/james/services/MailServer.java?view=diff&rev=449269&r1=449268&r2=449269
==============================================================================
--- james/server/trunk/src/java/org/apache/james/services/MailServer.java
(original)
+++ james/server/trunk/src/java/org/apache/james/services/MailServer.java Sat
Sep 23 09:25:34 2006
@@ -82,6 +82,7 @@
/**
* Pass a Mail to this MailServer for processing
+ *
* @param mail the Mail to be processed
* @throws MessagingException
*/
@@ -90,6 +91,7 @@
/**
* Pass a MimeMessage to this MailServer for processing
+ *
* @param message the message
* @throws MessagingException
*
@@ -102,7 +104,7 @@
* Retrieve the primary mailbox for userName. For POP3 style stores this
* is their (sole) mailbox.
*
- * @param sender - the name of the user
+ * @param userName - the name of the user
* @return a reference to an initialised mailbox
*/
MailRepository getUserInbox(String userName);
@@ -118,7 +120,7 @@
* Adds a new user to the mail system with userName. For POP3 style stores
* this may only involve adding the user to the UsersStore.
*
- * @param sender - the name of the user
+ * @param userName - the name of the user
* @return a reference to an initialised mailbox
*
* @deprecated addUser should not be considered a property of a MailServer
Modified:
james/server/trunk/src/java/org/apache/james/services/MailetLoader.java
URL:
http://svn.apache.org/viewvc/james/server/trunk/src/java/org/apache/james/services/MailetLoader.java?view=diff&rev=449269&r1=449268&r2=449269
==============================================================================
--- james/server/trunk/src/java/org/apache/james/services/MailetLoader.java
(original)
+++ james/server/trunk/src/java/org/apache/james/services/MailetLoader.java Sat
Sep 23 09:25:34 2006
@@ -37,8 +37,8 @@
* Get a new Mailet with the specified name acting
* in the specified context.
*
- * @param matchName the name of the mailet to be loaded
- * @param context the MailetContext to be passed to the new
+ * @param mailetName the name of the mailet to be loaded
+ * @param configuration the Configuration to be passed to the new
* mailet
* @throws MessagingException if an error occurs
*/
Modified:
james/server/trunk/src/java/org/apache/james/services/MatcherLoader.java
URL:
http://svn.apache.org/viewvc/james/server/trunk/src/java/org/apache/james/services/MatcherLoader.java?view=diff&rev=449269&r1=449268&r2=449269
==============================================================================
--- james/server/trunk/src/java/org/apache/james/services/MatcherLoader.java
(original)
+++ james/server/trunk/src/java/org/apache/james/services/MatcherLoader.java
Sat Sep 23 09:25:34 2006
@@ -37,8 +37,6 @@
* in the specified context.
*
* @param matchName the name of the matcher to be loaded
- * @param context the MailetContext to be passed to the new
- * matcher
* @throws MessagingException if an error occurs
*/
public Matcher getMatcher(String matchName) throws MessagingException;
Modified:
james/server/trunk/src/java/org/apache/james/services/SpoolManagementService.java
URL:
http://svn.apache.org/viewvc/james/server/trunk/src/java/org/apache/james/services/SpoolManagementService.java?view=diff&rev=449269&r1=449268&r2=449269
==============================================================================
---
james/server/trunk/src/java/org/apache/james/services/SpoolManagementService.java
(original)
+++
james/server/trunk/src/java/org/apache/james/services/SpoolManagementService.java
Sat Sep 23 09:25:34 2006
@@ -42,7 +42,7 @@
* @param filter the criteria against which all mails are matched. only
applied if key is NULL.
* @return number of removed mails
* @throws ServiceException
- * @trhows MessagingException
+ * @throws MessagingException
*/
public int removeSpoolItems(String spoolRepositoryURL, String key, List
lockingFailures, SpoolFilter filter)
throws ServiceException, MessagingException;
Modified: james/server/trunk/src/java/org/apache/james/util/Base64.java
URL:
http://svn.apache.org/viewvc/james/server/trunk/src/java/org/apache/james/util/Base64.java?view=diff&rev=449269&r1=449268&r2=449269
==============================================================================
--- james/server/trunk/src/java/org/apache/james/util/Base64.java (original)
+++ james/server/trunk/src/java/org/apache/james/util/Base64.java Sat Sep 23
09:25:34 2006
@@ -21,30 +21,44 @@
package org.apache.james.util;
+import javax.mail.MessagingException;
import javax.mail.internet.MimeUtility;
import java.io.BufferedReader;
import java.io.ByteArrayInputStream;
import java.io.ByteArrayOutputStream;
+import java.io.IOException;
import java.io.InputStreamReader;
/**
- * Simple Base64 string decoding function
+ * Simple Base64 string decoding and encoding function
*
* @version This is $Revision$
*/
public class Base64 {
- public static BufferedReader decode(String b64string) throws Exception {
- return new BufferedReader(
- new InputStreamReader(
- MimeUtility.decode(
- new ByteArrayInputStream(
- b64string.getBytes()), "base64")));
+ /**
+ * Decode base64 encoded String
+ *
+ * @param b64string base64 String
+ * @return reader the BufferedReader which holds the decoded base64 text
+ * @throws MessagingException get thrown when an error was detected while
trying to decode the String
+ */
+ public static BufferedReader decode(String b64string) throws
MessagingException {
+ return new BufferedReader(new InputStreamReader(MimeUtility.decode(
+ new ByteArrayInputStream(b64string.getBytes()),
"base64")));
}
- public static String decodeAsString(String b64string) throws Exception {
+ /**
+ * Decode base64 encoded String
+ *
+ * @param b64string base64 Sting
+ * @return returnString the String which holds the docoded base64 text
+ * @throws MessagingException get thrown when an error was detected while
trying to decode the String
+ * @throws IOException get thrown when I/O error was detected
+ */
+ public static String decodeAsString(String b64string) throws IOException,
MessagingException {
if (b64string == null) {
return b64string;
}
@@ -55,8 +69,15 @@
return returnString.trim();
}
- public static ByteArrayOutputStream encode(String plaintext)
- throws Exception {
+ /**
+ * Encode String to base64
+ *
+ * @param plaintext the plaintext to encode
+ * @return out the ByteArrayOutputStream holding the encoded given text
+ * @throws IOException get thrown when I/O error was detected
+ * @throws MessagingException get thrown when an error was detected while
trying to encode the String
+ */
+ public static ByteArrayOutputStream encode(String plaintext) throws
IOException, MessagingException {
ByteArrayOutputStream out = new ByteArrayOutputStream();
byte[] in = plaintext.getBytes();
ByteArrayOutputStream inStream = new ByteArrayOutputStream();
@@ -72,7 +93,15 @@
return out;
}
- public static String encodeAsString(String plaintext) throws Exception {
+ /**
+ * Encode String to base64
+ *
+ * @param plaintext the plaintext to decode
+ * @return base64String the encoded String
+ * @throws IOException get thrown when I/O error was detected
+ * @throws MessagingException get thrown when an error was detected while
trying to encode the String
+ */
+ public static String encodeAsString(String plaintext) throws IOException,
MessagingException {
return encode(plaintext).toString();
}
Modified:
james/server/trunk/src/java/org/apache/james/util/BayesianAnalyzer.java
URL:
http://svn.apache.org/viewvc/james/server/trunk/src/java/org/apache/james/util/BayesianAnalyzer.java?view=diff&rev=449269&r1=449268&r2=449269
==============================================================================
--- james/server/trunk/src/java/org/apache/james/util/BayesianAnalyzer.java
(original)
+++ james/server/trunk/src/java/org/apache/james/util/BayesianAnalyzer.java Sat
Sep 23 09:25:34 2006
@@ -32,8 +32,6 @@
import java.util.ArrayList;
import java.io.Reader;
-import java.io.StreamTokenizer;
-import java.io.StringReader;
/**
* <P>Determines probability that text contains Spam.</P>
Modified:
james/server/trunk/src/java/org/apache/james/util/CRLFTerminatedReader.java
URL:
http://svn.apache.org/viewvc/james/server/trunk/src/java/org/apache/james/util/CRLFTerminatedReader.java?view=diff&rev=449269&r1=449268&r2=449269
==============================================================================
--- james/server/trunk/src/java/org/apache/james/util/CRLFTerminatedReader.java
(original)
+++ james/server/trunk/src/java/org/apache/james/util/CRLFTerminatedReader.java
Sat Sep 23 09:25:34 2006
@@ -68,7 +68,7 @@
InputStream in;
public CRLFTerminatedReader(InputStream in) {
- this.in = in;
+ this.in = in;
}
public CRLFTerminatedReader(InputStream in, String enc) throws
UnsupportedEncodingException {
@@ -151,22 +151,34 @@
throw new LineLengthExceededException("Exceeded maximum line length");
}//method readLine()
+ /**
+ * @see java.io.Reader#read()
+ */
public int read() throws IOException {
- return in.read();
+ return in.read();
}
+ /**
+ * @see java.io.Reader#ready()
+ */
public boolean ready() throws IOException {
- return in.available() > 0;
+ return in.available() > 0;
}
+ /**
+ * @see java.io.Reader#read(char[], int, int)
+ */
public int read(char cbuf[], int off, int len) throws IOException {
- byte [] temp = new byte[len];
- int result = in.read(temp, 0, len);
- for (int i=0;i<result;i++) cbuf[i] = (char) temp[i];
- return result;
+ byte [] temp = new byte[len];
+ int result = in.read(temp, 0, len);
+ for (int i=0;i<result;i++) cbuf[i] = (char) temp[i];
+ return result;
}
+ /**
+ * @see java.io.Reader#close()
+ */
public void close() throws IOException {
- in.close();
+ in.close();
}
}
Modified:
james/server/trunk/src/java/org/apache/james/util/DebugInputStream.java
URL:
http://svn.apache.org/viewvc/james/server/trunk/src/java/org/apache/james/util/DebugInputStream.java?view=diff&rev=449269&r1=449268&r2=449269
==============================================================================
--- james/server/trunk/src/java/org/apache/james/util/DebugInputStream.java
(original)
+++ james/server/trunk/src/java/org/apache/james/util/DebugInputStream.java Sat
Sep 23 09:25:34 2006
@@ -56,9 +56,7 @@
}
/**
- * Close the stream
- *
- * @throws IOException if an exception is encountered when closing
+ * @see java.io.InputStream#close()
*/
public void close() throws IOException {
in.close();
Modified:
james/server/trunk/src/java/org/apache/james/util/JDBCBayesianAnalyzer.java
URL:
http://svn.apache.org/viewvc/james/server/trunk/src/java/org/apache/james/util/JDBCBayesianAnalyzer.java?view=diff&rev=449269&r1=449268&r2=449269
==============================================================================
--- james/server/trunk/src/java/org/apache/james/util/JDBCBayesianAnalyzer.java
(original)
+++ james/server/trunk/src/java/org/apache/james/util/JDBCBayesianAnalyzer.java
Sat Sep 23 09:25:34 2006
@@ -358,8 +358,7 @@
* Initializes the sql query environment from the SqlResources file.
* Will look for conf/sqlResources.xml.
* @param conn The connection for accessing the database
- * @param mailetContext The current mailet context,
- * for finding the conf/sqlResources.xml file
+ * @param sqlResources.xml file
* @throws Exception If any error occurs
*/
public void initSqlQueries(Connection conn, String file) throws Exception {
Modified: james/server/trunk/src/java/org/apache/james/util/MatcherInverter.java
URL:
http://svn.apache.org/viewvc/james/server/trunk/src/java/org/apache/james/util/MatcherInverter.java?view=diff&rev=449269&r1=449268&r2=449269
==============================================================================
--- james/server/trunk/src/java/org/apache/james/util/MatcherInverter.java
(original)
+++ james/server/trunk/src/java/org/apache/james/util/MatcherInverter.java Sat
Sep 23 09:25:34 2006
@@ -42,28 +42,28 @@
}
/**
- * @see org.apache.Mailet.Matcher#destroy()
+ * @see org.apache.mailet.Matcher#destroy()
*/
public void destroy() {
wrappedMatcher.destroy();
}
/**
- * @see org.apache.Mailet.Matcher#getMatcherConfig()
+ * @see org.apache.mailet.Matcher#getMatcherConfig()
*/
public MatcherConfig getMatcherConfig() {
return wrappedMatcher.getMatcherConfig();
}
/**
- * @see org.apache.Mailet.Matcher#getMatcherInfo()
+ * @see org.apache.mailet.Matcher#getMatcherInfo()
*/
public String getMatcherInfo() {
return wrappedMatcher.getMatcherInfo();
}
/**
- * @see org.apache.Mailet.Matcher#destroy()
+ * @see org.apache.mailet.Matcher#destroy()
*/
public void init(MatcherConfig config) throws MessagingException {
wrappedMatcher.init(config);
@@ -71,6 +71,7 @@
/**
* Return a Collection of "not matched" recipients
+ *
*/
public Collection match(Mail mail) throws MessagingException {
// Create a new recipient Collection cause mail.getRecipients() give a
reference to the internal
Modified:
james/server/trunk/src/java/org/apache/james/util/POP3BeforeSMTPHelper.java
URL:
http://svn.apache.org/viewvc/james/server/trunk/src/java/org/apache/james/util/POP3BeforeSMTPHelper.java?view=diff&rev=449269&r1=449268&r2=449269
==============================================================================
--- james/server/trunk/src/java/org/apache/james/util/POP3BeforeSMTPHelper.java
(original)
+++ james/server/trunk/src/java/org/apache/james/util/POP3BeforeSMTPHelper.java
Sat Sep 23 09:25:34 2006
@@ -66,7 +66,7 @@
}
/**
- * @see #removeExpiredIP(String, long)
+ * @see #removeExpiredIP(long)
*/
public static void removeExpiredIP() {
removeExpiredIP(EXPIRE_TIME);
Modified: james/server/trunk/src/java/org/apache/james/util/XMLResources.java
URL:
http://svn.apache.org/viewvc/james/server/trunk/src/java/org/apache/james/util/XMLResources.java?view=diff&rev=449269&r1=449268&r2=449269
==============================================================================
--- james/server/trunk/src/java/org/apache/james/util/XMLResources.java
(original)
+++ james/server/trunk/src/java/org/apache/james/util/XMLResources.java Sat Sep
23 09:25:34 2006
@@ -361,7 +361,7 @@
/**
* Returns a named string, replacing parameters with the values set.
*
- * @param name the name of the String resource required.
+ * @param str the name of the String resource required.
* @param parameters a map of parameters (name-value string pairs)
which are
* replaced where found in the input strings
* @return the requested resource
Modified:
james/server/trunk/src/java/org/apache/james/util/dbcp/JdbcDataSource.java
URL:
http://svn.apache.org/viewvc/james/server/trunk/src/java/org/apache/james/util/dbcp/JdbcDataSource.java?view=diff&rev=449269&r1=449268&r2=449269
==============================================================================
--- james/server/trunk/src/java/org/apache/james/util/dbcp/JdbcDataSource.java
(original)
+++ james/server/trunk/src/java/org/apache/james/util/dbcp/JdbcDataSource.java
Sat Sep 23 09:25:34 2006
@@ -204,7 +204,7 @@
}
/**
- * @see org.apache.avalon.framework.configuration.Configurable#dispose()
+ * @see org.apache.avalon.framework.activity.Disposable#dispose()
*/
public void dispose() {
//Close all database connections
@@ -216,7 +216,7 @@
}
/**
- *
+ * @see
org.apache.avalon.excalibur.datasource.DataSourceComponent#getConnection()
*/
public Connection getConnection() throws SQLException {
return source.getConnection();
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
