noel 2003/09/21 12:09:36
Modified: src/java/org/apache/mailet Tag: branch_2_1_fcs
GenericMailet.java Mailet.java MailetConfig.java
MailetContext.java
Log:
Javadoc corrections submitted by Oliver Reiter
Revision Changes Path
No revision
No revision
1.4.4.3 +10 -11 james-server/src/java/org/apache/mailet/GenericMailet.java
Index: GenericMailet.java
===================================================================
RCS file: /home/cvs/james-server/src/java/org/apache/mailet/GenericMailet.java,v
retrieving revision 1.4.4.2
retrieving revision 1.4.4.3
diff -u -r1.4.4.2 -r1.4.4.3
--- GenericMailet.java 8 Mar 2003 21:54:13 -0000 1.4.4.2
+++ GenericMailet.java 21 Sep 2003 19:09:36 -0000 1.4.4.3
@@ -95,7 +95,7 @@
* named parameter from the mailet's MailetConfig object.
*
* @param name - a String specifying the name of the initialization parameter
- * @return String a String containing the value of the initalization parameter
+ * @return a String containing the value of the initalization parameter
*/
public String getInitParameter(String name) {
return config.getInitParameter(name);
@@ -109,7 +109,7 @@
* This method is supplied for convenience. It gets the parameter names from
* the mailet's MailetConfig object.
*
- * @return Iterator an iterator of String objects containing the names of
+ * @return an Iterator of String objects containing the names of
* the mailet's initialization parameters
*/
public Iterator getInitParameterNames() {
@@ -117,9 +117,9 @@
}
/**
- * Returns this matcher's MailetConfig object.
+ * Returns this Mailet's MailetConfig object.
*
- * @return MailetConfig the MailetConfig object that initialized this mailet
+ * @return the MailetConfig object that initialized this mailet
*/
public MailetConfig getMailetConfig() {
return config;
@@ -129,7 +129,7 @@
* Returns a reference to the MailetContext in which this mailet is
* running.
*
- * @return MailetContext the MailetContext object passed to this mailet by the
init method
+ * @return the MailetContext object passed to this mailet by the init method
*/
public MailetContext getMailetContext() {
return getMailetConfig().getMailetContext();
@@ -140,7 +140,7 @@
* copyright. By default, this method returns an empty string. Override
* this method to have it return a meaningful value.
*
- * @return String information about this mailet, by default an empty string
+ * @return information about this mailet, by default an empty string
*/
public String getMailetInfo() {
return "";
@@ -161,10 +161,10 @@
* mailet is being placed into service.</p>
*
* <p>This implementation stores the MailetConfig object it receives from
- * the mailet container for alter use. When overriding this form of the
+ * the mailet container for later use. When overriding this form of the
* method, call super.init(config).</p>
*
- * @param MailetConfig config - the MailetConfig object that contains
+ * @param MailetConfig newconfig - the MailetConfig object that contains
* configutation information for this mailet
* @throws MessagingException
* if an exception occurs that interrupts the mailet's normal operation
@@ -193,7 +193,7 @@
* Writes the specified message to a mailet log file, prepended by
* the mailet's name.
*
- * @param msg - a String specifying the message to be written to the log file
+ * @param message - a String specifying the message to be written to the log
file
*/
public void log(String message) {
StringBuffer logBuffer =
@@ -209,7 +209,7 @@
* exception to the mailet log file, prepended by the mailet's name.
*
* @param message - a String that describes the error or exception
- * @param t - the java.lang.Throwable error or exception
+ * @param t - the java.lang.Throwable to be logged
*/
public void log(String message, Throwable t) {
StringBuffer logBuffer =
@@ -229,7 +229,6 @@
* @param mail - the Mail object that contains the MimeMessage and
* routing information
* @throws javax.mail.MessagingException - if an exception occurs that
interferes with the mailet's normal operation
- * occurred
*/
public abstract void service(Mail mail) throws javax.mail.MessagingException;
}
1.1.6.3 +6 -6 james-server/src/java/org/apache/mailet/Mailet.java
Index: Mailet.java
===================================================================
RCS file: /home/cvs/james-server/src/java/org/apache/mailet/Mailet.java,v
retrieving revision 1.1.6.2
retrieving revision 1.1.6.3
diff -u -r1.1.6.2 -r1.1.6.3
--- Mailet.java 8 Mar 2003 21:54:13 -0000 1.1.6.2
+++ Mailet.java 21 Sep 2003 19:09:36 -0000 1.1.6.3
@@ -78,7 +78,7 @@
* <li>The mailet is taken out of service, then destroyed with the destroy method,
* then garbage collected and finalized.</li>
* </ol>
- * In addition to the life-cycle methods, this interface provides the
getMailletConfig
+ * In addition to the life-cycle methods, this interface provides the
getMailetConfig
* method, which the mailet can use to get any startup information, and the
* getMailetInfo method, which allows the mailet to return basic information about
itself,
* such as author, version, and copyright.
@@ -123,7 +123,7 @@
* object so that this method can return it. The GenericMailet class, which
implements
* this interface, already does this.
*
- * @return the MailletConfig object that initializes this mailet
+ * @return the MailetConfig object that initializes this mailet
*/
MailetConfig getMailetConfig();
@@ -137,27 +137,27 @@
*
* @param config - a MailetConfig object containing the mailet's configuration
* and initialization parameters
- * @throws MessagingException - if an exception has occurred that interferes
with
+ * @throws javax.mail.MessagingException - if an exception has occurred that
interferes with
* the mailet's normal operation
*/
void init(MailetConfig config) throws javax.mail.MessagingException;
/**
* Called by the mailet container to allow the mailet to process to
- * a message message.
+ * a message.
* <p>
* This method is only called after the mailet's init() method has completed
* successfully.
* <p>
* Mailets typically run inside multithreaded mailet containers that can handle
* multiple requests concurrently. Developers must be aware to synchronize
access
- * to any shared resources such as files, network connections, and as well as
the
+ * to any shared resources such as files, network connections, as well as the
* mailet's class and instance variables. More information on multithreaded
* programming in Java is available in <a
href="http://java.sun.com/Series/Tutorial/java/threads/multithreaded.html";>the
* Java tutorial on multi-threaded programming</a>.
*
* @param mail - the Mail object that contains the message and routing
information
- * @throws javax.mail.MessagingException - if an message or address parsing
exception occurs or
+ * @throws javax.mail.MessagingException - if a message or address parsing
exception occurs or
* an exception that interferes with the mailet's normal operation
*/
void service(Mail mail) throws javax.mail.MessagingException;
1.2.4.3 +1 -1 james-server/src/java/org/apache/mailet/MailetConfig.java
Index: MailetConfig.java
===================================================================
RCS file: /home/cvs/james-server/src/java/org/apache/mailet/MailetConfig.java,v
retrieving revision 1.2.4.2
retrieving revision 1.2.4.3
diff -u -r1.2.4.2 -r1.2.4.3
--- MailetConfig.java 8 Mar 2003 21:54:13 -0000 1.2.4.2
+++ MailetConfig.java 21 Sep 2003 19:09:36 -0000 1.2.4.3
@@ -61,7 +61,7 @@
import java.util.Iterator;
/**
- * A mailet configuration object used by a mailet container used to pass information
+ * A mailet configuration object used by a mailet container to pass information
* to a mailet during initialization.
* <p>
* The configuration information contains initialization parameters, which are a set
1.5.4.5 +9 -7 james-server/src/java/org/apache/mailet/MailetContext.java
Index: MailetContext.java
===================================================================
RCS file: /home/cvs/james-server/src/java/org/apache/mailet/MailetContext.java,v
retrieving revision 1.5.4.4
retrieving revision 1.5.4.5
diff -u -r1.5.4.4 -r1.5.4.5
--- MailetContext.java 29 May 2003 04:43:24 -0000 1.5.4.4
+++ MailetContext.java 21 Sep 2003 19:09:36 -0000 1.5.4.5
@@ -69,7 +69,7 @@
* deliver a message locally, or write to a log file.
*
* The MailetContext object is contained within the MailetConfig and
- * MatcherConfig objects, which the mailet container provides the
+ * MatcherConfig objects, which the mailet container provides to the
* mailets and matchers when they are initialized.
*
* @version 1.0.0, 24/04/1999
@@ -78,7 +78,7 @@
/**
* Bounces the message using a standard format with the given message.
- * Will be sent back to the sender from the postmaster as specified for
+ * The message will be sent back to the sender from the postmaster as specified
for
* this mailet context, adding message to top of mail server queue using
* sendMail().
*
@@ -119,7 +119,7 @@
* Returns the mailet container attribute with the given name, or null
* if there is no attribute by that name. An attribute allows a mailet
container
* to give the mailet additional information not already provided by this
interface.
- * See * your server documentation for information about its attributes. A list
of
+ * See your server documentation for information about its attributes. A list of
* supported attributes can be retrieved using getAttributeNames.
* <p>
* The attribute is returned as a java.lang.Object or some subclass. Attribute
@@ -142,7 +142,7 @@
Iterator getAttributeNames();
/**
- * Returns the minor version of the Mailet API that this mailet
+ * Returns the major version of the Mailet API that this mailet
* container supports. All implementations that comply with Version 1.2 must
have
* this method return the integer 1.
*
@@ -194,7 +194,7 @@
* log. The name and type of the mailet log file is specific to the mailet
* container.
*
- * @param msg - a String specifying the message to be written to the log file
+ * @param message - a String specifying the message to be written to the log
file
*/
void log(String message);
@@ -229,7 +229,7 @@
/**
* Send an outgoing message to the top of this mailet container's root queue.
- * Is the equivalent of opening an SMTP session to localhost.
+ * This is the equivalent of opening an SMTP session to localhost.
*
* @param sender - the sender of the message
* @param recipients - a Collection of MailAddress objects of recipients
@@ -247,6 +247,7 @@
* @param recipients - a Collection of MailAddress objects of recipients
* @param msg - the MimeMessage of the headers and body content of the outgoing
message
* @param state - the state of the message, indicates which processor to use
+ * This is a String that names a processor for which the message will be queued
* @throws MessagingException - if the message fails to parse
*/
void sendMail(MailAddress sender, Collection recipients, MimeMessage msg,
String state)
@@ -277,7 +278,8 @@
void setAttribute(String name, Object object);
/**
- * Stores mail into local accounts (POP3 by default)
+ * Stores the message is in the local repository associated with
+ * recipient for later retrieval, e.g., by a POP3 or IMAP service.
*
* @param sender - the sender of the incoming message
* @param recipient - the user who is receiving this message (as a complete
email address)
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
