vincenzo 2003/07/21 03:51:27
Modified: src/java/org/apache/mailet Tag: branch_2_1_fcs Mail.java
Log:
Adding "@since Mailet API v2.1" to the javadoc of all the new mail attributes
related methods.
Revision Changes Path
No revision
No revision
1.3.4.4 +10 -3 james-server/src/java/org/apache/mailet/Mail.java
Index: Mail.java
===================================================================
RCS file: /home/cvs/james-server/src/java/org/apache/mailet/Mail.java,v
retrieving revision 1.3.4.3
retrieving revision 1.3.4.4
diff -u -r1.3.4.3 -r1.3.4.4
--- Mail.java 15 Jul 2003 10:12:45 -0000 1.3.4.3
+++ Mail.java 21 Jul 2003 10:51:26 -0000 1.3.4.4
@@ -164,6 +164,7 @@
* @param name - a String specifying the name of the attribute
* @return an Object containing the value of the attribute, or null if no
attribute
* exists matching the given name
+ * @since Mailet API v2.1
*/
Serializable getAttribute(String name);
@@ -173,11 +174,13 @@
* attribute name to get the value of an attribute.
*
* @return an Iterator of attribute names
+ * @since Mailet API v2.1
*/
Iterator getAttributeNames();
/**
* @return true if this Mail instance has any attributes set.
+ * @since Mailet API v2.1
**/
boolean hasAttributes();
@@ -190,11 +193,13 @@
* @return previous attribute value associated with specified name, or null
* if there was no mapping for name (null can also mean that null
* was bound to the name)
+ * @since Mailet API v2.1
*/
Serializable removeAttribute(String name);
/**
* Removes all the attributes associated with this Mail instance.
+ * @since Mailet API v2.1
**/
void removeAllAttributes();
@@ -205,13 +210,15 @@
* As instances of Mail is Serializable, it is necessary that the attributes
being
* Serializable as well
* <p>
- * Attribute names should follow the same convention as package names. The Java
- * Mailet API specification reserves names matching java.*, javax.*, and sun.*.
+ * Attribute names should follow the same convention as package names.
+ * The Mailet API specification reserves names matching
<I>org.apache.james.*</I>
+ * and <I>org.apache.mailet.*</I>.
*
* @param name - a String specifying the name of the attribute
* @param object - a Serializable Object representing the attribute to be bound
* @return the object previously bound to the name, null if the name was
* not bound (null can also mean that null was bound to the name)
+ * @since Mailet API v2.1
*/
Serializable setAttribute(String name, Serializable object);
}
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
