svn commit: r190261 - /directory/network/trunk/src/java/org/apache/mina/common/IoFilter.java

[tr...@apache.org]

Author: trustin
Date: Sun Jun 12 05:19:07 2005
New Revision: 190261

URL: http://svn.apache.org/viewcvs?rev=190261&view=rev
Log:
Added JavaDoc

Modified:
    directory/network/trunk/src/java/org/apache/mina/common/IoFilter.java

Modified: directory/network/trunk/src/java/org/apache/mina/common/IoFilter.java
URL: http://svn.apache.org/viewcvs/directory/network/trunk/src/java/org/apache/mina/common/IoFilter.java?rev=190261&r1=190260&r2=190261&view=diff
==============================================================================
--- directory/network/trunk/src/java/org/apache/mina/common/IoFilter.java (original)
+++ directory/network/trunk/src/java/org/apache/mina/common/IoFilter.java Sun Jun 12 05:19:07 2005
@@ -86,19 +86,49 @@
      */
     void filterWrite( NextFilter nextFilter, IoSession session, WriteRequest writeRequest ) throws Exception;
     
+    /**
+     * Represents the next {@link IoFilter} in {@link IoFilterChain}.
+     */
     public interface NextFilter
     {
+        /**
+         * Forwards <tt>sessionOpened</tt> event to next filter.
+         */
         void sessionOpened( IoSession session );
+
+        /**
+         * Forwards <tt>sessionClosed</tt> event to next filter.
+         */
         void sessionClosed( IoSession session );
+
+        /**
+         * Forwards <tt>sessionIdle</tt> event to next filter.
+         */
         void sessionIdle( IoSession session, IdleStatus status );
+
+        /**
+         * Forwards <tt>exceptionCaught</tt> event to next filter.
+         */
         void exceptionCaught( IoSession session, Throwable cause );
+
+        /**
+         * Forwards <tt>messageReceived</tt> event to next filter.
+         */
         void messageReceived( IoSession session, Object message );
+
+        /**
+         * Forwards <tt>messageSent</tt> event to next filter.
+         */
         void messageSent( IoSession session, Object message );
+
+        /**
+         * Forwards <tt>filterWrite</tt> event to next filter.
+         */
         void filterWrite( IoSession session, WriteRequest writeRequest );
     }
     
     /**
-     * TODO doeument me
+     * Represents write request fired by {@link IoSession#write(Object)}.
      */
     public static class WriteRequest
     {
@@ -107,11 +137,19 @@
         private final Object message;
         private final WriteFuture future;
         
+        /**
+         * Creates a new instance without {@link WriteFuture}.  You'll get
+         * an instance of {@link WriteFuture} even if you called this constructor
+         * because {@link #getFuture()} will return a bogus future.
+         */
         public WriteRequest( Object message )
         {
             this( message, null );
         }
 
+        /**
+         * Creates a new instance with {@link WriteFuture}.
+         */
         public WriteRequest( Object message, WriteFuture future )
         {
             if( message == null )
@@ -128,11 +166,17 @@
             this.future = future;
         }
 
+        /**
+         * Returns {@link WriteFuture} that is associated with this write request.
+         */
         public WriteFuture getFuture()
         {
             return future;
         }
 
+        /**
+         * Returns a message object to be written.
+         */
         public Object getMessage()
         {
             return message;