Author: norman
Date: Sun May 15 13:05:00 2011
New Revision: 1103362

URL: http://svn.apache.org/viewvc?rev=1103362&view=rev
Log:
Add some more javadocs and allow to check if compression is active

Modified:
    
james/imap/trunk/api/src/main/java/org/apache/james/imap/api/process/ImapSession.java
    
james/imap/trunk/message/src/test/java/org/apache/james/imap/encode/FakeImapSession.java
    
james/imap/trunk/processor/src/test/java/org/apache/james/imap/processor/base/MailboxEventAnalyserTest.java

Modified: 
james/imap/trunk/api/src/main/java/org/apache/james/imap/api/process/ImapSession.java
URL: 
http://svn.apache.org/viewvc/james/imap/trunk/api/src/main/java/org/apache/james/imap/api/process/ImapSession.java?rev=1103362&r1=1103361&r2=1103362&view=diff
==============================================================================
--- 
james/imap/trunk/api/src/main/java/org/apache/james/imap/api/process/ImapSession.java
 (original)
+++ 
james/imap/trunk/api/src/main/java/org/apache/james/imap/api/process/ImapSession.java
 Sun May 15 13:05:00 2011
@@ -129,12 +129,39 @@ public interface ImapSession {
      */
     public boolean supportStartTLS();
 
+    /**
+     * Return true if compression is active
+     * 
+     * @return compActive
+     */
+    public boolean isCompressionActive();
+
+    /**
+     * Return true if compression is supported. This is related to COMPRESS 
extension.
+     * See http://www.ietf.org/rfc/rfc4978.txt
+     * 
+     * @return compressSupport
+     */
     public boolean isCompressionSupported();
 
+    /**
+     * Start the compression
+     * 
+     * @return success
+     */
     public boolean startCompression();
 
+    /**
+     * Push in a new {@link ImapLineHandler} which is called for the next line 
received
+     * 
+     * @param lineHandler
+     */
     public void pushLineHandler(ImapLineHandler lineHandler);
 
+    /**
+     * Pop the current {@link ImapLineHandler}
+     * 
+     */
     public void popLineHandler();
     
     /**

Modified: 
james/imap/trunk/message/src/test/java/org/apache/james/imap/encode/FakeImapSession.java
URL: 
http://svn.apache.org/viewvc/james/imap/trunk/message/src/test/java/org/apache/james/imap/encode/FakeImapSession.java?rev=1103362&r1=1103361&r2=1103362&view=diff
==============================================================================
--- 
james/imap/trunk/message/src/test/java/org/apache/james/imap/encode/FakeImapSession.java
 (original)
+++ 
james/imap/trunk/message/src/test/java/org/apache/james/imap/encode/FakeImapSession.java
 Sun May 15 13:05:00 2011
@@ -130,4 +130,8 @@ public class FakeImapSession implements 
         return false;
     }
 
+    public boolean isCompressionActive() {
+        return false;
+    }
+
 }

Modified: 
james/imap/trunk/processor/src/test/java/org/apache/james/imap/processor/base/MailboxEventAnalyserTest.java
URL: 
http://svn.apache.org/viewvc/james/imap/trunk/processor/src/test/java/org/apache/james/imap/processor/base/MailboxEventAnalyserTest.java?rev=1103362&r1=1103361&r2=1103362&view=diff
==============================================================================
--- 
james/imap/trunk/processor/src/test/java/org/apache/james/imap/processor/base/MailboxEventAnalyserTest.java
 (original)
+++ 
james/imap/trunk/processor/src/test/java/org/apache/james/imap/processor/base/MailboxEventAnalyserTest.java
 Sun May 15 13:05:00 2011
@@ -181,13 +181,16 @@ public class MailboxEventAnalyserTest {
         }
 
         public boolean isTLSActive() {
-            // TODO Auto-generated method stub
             return false;
         }
 
         public boolean supportMultipleNamespaces() {
             return false;
         }
+
+        public boolean isCompressionActive() {
+            return false;
+        }
     };
     
 



---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]

Reply via email to