directory-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From trus...@apache.org
Subject svn commit: r350135 - in /directory/network/branches/chain_refactor/src/java/org/apache/mina: common/DefaultIoFilterChainBuilder.java common/IoAcceptor.java common/IoConnector.java filter/SSLFilter.java
Date Thu, 01 Dec 2005 03:43:33 GMT
Author: trustin
Date: Wed Nov 30 19:43:29 2005
New Revision: 350135

URL: http://svn.apache.org/viewcvs?rev=350135&view=rev
Log:
* Simplified documentation for DefaultIoFilterChainBuilder
* Removed finished TODOs

Modified:
    directory/network/branches/chain_refactor/src/java/org/apache/mina/common/DefaultIoFilterChainBuilder.java
    directory/network/branches/chain_refactor/src/java/org/apache/mina/common/IoAcceptor.java
    directory/network/branches/chain_refactor/src/java/org/apache/mina/common/IoConnector.java
    directory/network/branches/chain_refactor/src/java/org/apache/mina/filter/SSLFilter.java

Modified: directory/network/branches/chain_refactor/src/java/org/apache/mina/common/DefaultIoFilterChainBuilder.java
URL: http://svn.apache.org/viewcvs/directory/network/branches/chain_refactor/src/java/org/apache/mina/common/DefaultIoFilterChainBuilder.java?rev=350135&r1=350134&r2=350135&view=diff
==============================================================================
--- directory/network/branches/chain_refactor/src/java/org/apache/mina/common/DefaultIoFilterChainBuilder.java
(original)
+++ directory/network/branches/chain_refactor/src/java/org/apache/mina/common/DefaultIoFilterChainBuilder.java
Wed Nov 30 19:43:29 2005
@@ -66,16 +66,16 @@
     }
 
     /**
-     * Returns the {@link IoFilter} with the specified <tt>name</tt> in the filter
-     * list.
-     * 
-     * @return <tt>null</tt> if there's no such filter in the filter list
+     * @see IoFilterChain#getEntry(String)
      */
     public synchronized Entry getEntry( String name )
     {
         return ( Entry ) entriesByName.get( name );
     }
-    
+
+    /**
+     * @see IoFilterChain#get(String)
+     */
     public synchronized IoFilter get( String name )
     {
         Entry e = getEntry( name );
@@ -88,7 +88,7 @@
     }
     
     /**
-     * Returns the list of all {@link Entry}s the filter list contains.
+     * @see IoFilterChain#getAll()
      */
     public List getAll()
     {
@@ -96,7 +96,7 @@
     }
     
     /**
-     * Returns the reversed list of all {@link Entry}s the filter list contains.
+     * @see IoFilterChain#getAllReversed()
      */
     public List getAllReversed()
     {
@@ -106,8 +106,7 @@
     }
 
     /**
-     * Returns <tt>true</tt> if this chain contains an {@link IoFilter} with
the
-     * specified <tt>name</tt>.
+     * @see IoFilterChain#contains(String)
      */
     public boolean contains( String name )
     {
@@ -115,7 +114,7 @@
     }
     
     /**
-     * Returns <tt>true</tt> if this chain contains the specified <tt>filter</tt>.
+     * @see IoFilterChain#contains(IoFilter)
      */
     public boolean contains( IoFilter filter )
     {
@@ -132,8 +131,7 @@
     }
     
     /**
-     * Returns <tt>true</tt> if this chain contains an {@link IoFilter} of the
-     * specified <tt>filterType</tt>.
+     * @see IoFilterChain#contains(Class)
      */
     public boolean contains( Class filterType )
     {
@@ -150,8 +148,7 @@
     }
     
     /**
-     * Adds the specified filter with the specified name at the beginning
-     * of the filter list.
+     * @see IoFilterChain#addFirst(String, IoFilter)
      */
     public synchronized void addFirst( String name, IoFilter filter )
     {
@@ -159,8 +156,7 @@
     }
     
     /**
-     * Adds the specified filter with the specified name at the end of
-     * the filter list.
+     * @see IoFilterChain#addLast(String, IoFilter)
      */
     public synchronized void addLast( String name, IoFilter filter )
     {
@@ -168,8 +164,7 @@
     }
 
     /**
-     * Adds the specified filter with the specified name just before the filter whose name
is
-     * <code>baseName</code> in this chain.
+     * @see IoFilterChain#addBefore(String, String, IoFilter)
      */
     public synchronized void addBefore( String baseName, String name, IoFilter filter )
     {
@@ -187,8 +182,7 @@
     }
 
     /**
-     * Adds the specified filter with the specified name just after the filter whose name
is
-     * <code>baseName</code> in this chain.
+     * @see IoFilterChain#addAfter(String, String, IoFilter)
      */
     public synchronized void addAfter( String baseName, String name, IoFilter filter )
     {
@@ -208,7 +202,7 @@
     }
 
     /**
-     * Removes the filter with the specified name from this chain.
+     * @see IoFilterChain#remove(String)
      */
     public synchronized IoFilter remove( String name )
     {
@@ -231,7 +225,7 @@
     }
 
     /**
-     * Removes all filters added to this chain.
+     * @see IoFilterChain#clear()
      */
     public synchronized void clear() throws Exception
     {

Modified: directory/network/branches/chain_refactor/src/java/org/apache/mina/common/IoAcceptor.java
URL: http://svn.apache.org/viewcvs/directory/network/branches/chain_refactor/src/java/org/apache/mina/common/IoAcceptor.java?rev=350135&r1=350134&r2=350135&view=diff
==============================================================================
--- directory/network/branches/chain_refactor/src/java/org/apache/mina/common/IoAcceptor.java
(original)
+++ directory/network/branches/chain_refactor/src/java/org/apache/mina/common/IoAcceptor.java
Wed Nov 30 19:43:29 2005
@@ -51,10 +51,12 @@
     void bind( SocketAddress address, IoHandler handler ) throws IOException;
 
     /**
-     * TODO Revise documentation
      * Binds to the specified <code>address</code> and handles incoming
      * connections with the specified <code>handler</code>.
-     * 
+     *
+     * @param filterChainBuilder
+     *            an {@link IoFilterChainBuilder} that will modify the
+     *            {@link IoFilterChain} of a newly created {@link IoSession}
      * @throws IOException if failed to bind
      */
     void bind( SocketAddress address, IoHandler handler, IoFilterChainBuilder filterChainBuilder
) throws IOException;

Modified: directory/network/branches/chain_refactor/src/java/org/apache/mina/common/IoConnector.java
URL: http://svn.apache.org/viewcvs/directory/network/branches/chain_refactor/src/java/org/apache/mina/common/IoConnector.java?rev=350135&r1=350134&r2=350135&view=diff
==============================================================================
--- directory/network/branches/chain_refactor/src/java/org/apache/mina/common/IoConnector.java
(original)
+++ directory/network/branches/chain_refactor/src/java/org/apache/mina/common/IoConnector.java
Wed Nov 30 19:43:29 2005
@@ -53,11 +53,13 @@
             throws IOException;
     
     /**
-     * TODO revise documentation 
      * Connects to the specified <code>address</code>.  If communication starts
      * successfully, events are fired to the specified
      * <code>handler</code>.
      * 
+     * @param filterChainBuilder
+     *            an {@link IoFilterChainBuilder} that will modify the
+     *            {@link IoFilterChain} of a newly created {@link IoSession}
      * @throws IOException if failed to connect
      */
     ConnectFuture connect( SocketAddress address, IoHandler handler,
@@ -75,11 +77,13 @@
                            IoHandler handler ) throws IOException;
 
     /**
-     * TODO revise documentation
      * Connects to the specified <code>address</code>.  If communication starts
      * successfully, events are fired to the specified
      * <code>handler</code>.
      * 
+     * @param filterChainBuilder
+     *            an {@link IoFilterChainBuilder} that will modify the
+     *            {@link IoFilterChain} of a newly created {@link IoSession}
      * @throws IOException if failed to connect
      */
     ConnectFuture connect( SocketAddress address, SocketAddress localAddress,

Modified: directory/network/branches/chain_refactor/src/java/org/apache/mina/filter/SSLFilter.java
URL: http://svn.apache.org/viewcvs/directory/network/branches/chain_refactor/src/java/org/apache/mina/filter/SSLFilter.java?rev=350135&r1=350134&r2=350135&view=diff
==============================================================================
--- directory/network/branches/chain_refactor/src/java/org/apache/mina/filter/SSLFilter.java
(original)
+++ directory/network/branches/chain_refactor/src/java/org/apache/mina/filter/SSLFilter.java
Wed Nov 30 19:43:29 2005
@@ -337,7 +337,6 @@
             throw new IllegalStateException( "A filter chain cannot contain more than one
SSLFilter." );
         }
 
-        // FIXME This filter should work fine even if it is added more than once to one chain.
         parent.getSession().setAttribute( NEXT_FILTER, nextFilter );
         Object managerOrSession = parent.getSession();
         if( managerOrSession instanceof IoSession )



Mime
View raw message