Author: rdonkin
Date: Mon Mar 26 13:30:57 2007
New Revision: 522618
URL: http://svn.apache.org/viewvc?view=rev&rev=522618
Log:
Javadoc qualifications.
Modified:
james/jsieve/trunk/src/main/java/org/apache/jsieve/mail/MailAdapter.java
Modified:
james/jsieve/trunk/src/main/java/org/apache/jsieve/mail/MailAdapter.java
URL:
http://svn.apache.org/viewvc/james/jsieve/trunk/src/main/java/org/apache/jsieve/mail/MailAdapter.java?view=diff&rev=522618&r1=522617&r2=522618
==============================================================================
--- james/jsieve/trunk/src/main/java/org/apache/jsieve/mail/MailAdapter.java
(original)
+++ james/jsieve/trunk/src/main/java/org/apache/jsieve/mail/MailAdapter.java
Mon Mar 26 13:30:57 2007
@@ -40,14 +40,16 @@
{
/**
* Method getActions answers the List of Actions accumulated by the
receiver.
- * @return Action
+ * Implementations may elect to supply an unmodifiable collection.
+ * @return <code>List</code> of [EMAIL PROTECTED] Action}'s, not null,
possibly unmodifiable
*/
public List getActions();
/**
* Method getActionIteraror answers an Iterator over the List of Actions
- * accumulated by the receiver.
- * @return Action
+ * accumulated by the receiver. Implementations may elect to supply
+ * an unmodifiable iterator.
+ * @return <code>ListIterator</code>, not null, possibly unmodifiable
*/
public ListIterator getActionsIterator();
@@ -57,7 +59,7 @@
* returned.
*
* @param name
- * @return List
+ * @return <code>List</code> not null, possibly empty, possible
unmodifiable
* @throws SieveMailException
*/
public List getHeader(String name) throws SieveMailException;
@@ -75,7 +77,7 @@
* </p>
*
* @param name
- * @return List
+ * @return <code>List</code>, not null possibly empty, possible
unmodifiable
* @throws SieveMailException
*/
public List getMatchingHeader(String name)
@@ -84,7 +86,7 @@
/**
* Method getHeaderNames answers a List of all of the headers in the
receiver.
* No duplicates are allowed.
- * @return List
+ * @return <code>List</code>, not null possible empty, possible
unmodifiable
* @throws SieveMailException
*/
public List getHeaderNames() throws SieveMailException;
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
