Author: trustin
Date: Thu Nov 8 22:22:24 2007
New Revision: 593426
URL: http://svn.apache.org/viewvc?rev=593426&view=rev
Log:
More JavaDoc
Modified:
mina/trunk/core/src/main/java/org/apache/mina/filter/executor/ExecutorFilter.java
mina/trunk/core/src/main/java/org/apache/mina/filter/executor/IoEventQueueHandler.java
mina/trunk/core/src/main/java/org/apache/mina/filter/executor/IoEventQueueThrottle.java
mina/trunk/core/src/main/java/org/apache/mina/filter/executor/OrderedThreadPoolExecutor.java
Modified:
mina/trunk/core/src/main/java/org/apache/mina/filter/executor/ExecutorFilter.java
URL:
http://svn.apache.org/viewvc/mina/trunk/core/src/main/java/org/apache/mina/filter/executor/ExecutorFilter.java?rev=593426&r1=593425&r2=593426&view=diff
==============================================================================
---
mina/trunk/core/src/main/java/org/apache/mina/filter/executor/ExecutorFilter.java
(original)
+++
mina/trunk/core/src/main/java/org/apache/mina/filter/executor/ExecutorFilter.java
Thu Nov 8 22:22:24 2007
@@ -103,10 +103,14 @@
*
* <h2>Preventing [EMAIL PROTECTED] OutOfMemoryError}</h2>
*
- * Please refer to [EMAIL PROTECTED] OrderedThreadPoolExecutor} and [EMAIL
PROTECTED] IoEventQueueHandler}.
+ * Please refer to [EMAIL PROTECTED] IoEventQueueThrottle}, which is specified
as
+ * a parameter of the convenience constructors.
*
* @author The Apache MINA Project ([EMAIL PROTECTED])
* @version $Rev$, $Date$
+ *
+ * @see OrderedThreadPoolExecutor
+ * @see UnorderedThreadPoolExecutor
*/
public class ExecutorFilter extends IoFilterAdapter {
Modified:
mina/trunk/core/src/main/java/org/apache/mina/filter/executor/IoEventQueueHandler.java
URL:
http://svn.apache.org/viewvc/mina/trunk/core/src/main/java/org/apache/mina/filter/executor/IoEventQueueHandler.java?rev=593426&r1=593425&r2=593426&view=diff
==============================================================================
---
mina/trunk/core/src/main/java/org/apache/mina/filter/executor/IoEventQueueHandler.java
(original)
+++
mina/trunk/core/src/main/java/org/apache/mina/filter/executor/IoEventQueueHandler.java
Thu Nov 8 22:22:24 2007
@@ -25,7 +25,8 @@
import org.apache.mina.common.IoEvent;
/**
- * Listens to all event queue operations occurring in [EMAIL PROTECTED]
IoThreadPoolExecutor}.
+ * Listenes and filters all event queue operations occurring in
+ * [EMAIL PROTECTED] OrderedThreadPoolExecutor} and [EMAIL PROTECTED]
UnorderedThreadPoolExecutor}.
*
* @author The Apache MINA Project ([EMAIL PROTECTED])
* @version $Rev$, $Date$
Modified:
mina/trunk/core/src/main/java/org/apache/mina/filter/executor/IoEventQueueThrottle.java
URL:
http://svn.apache.org/viewvc/mina/trunk/core/src/main/java/org/apache/mina/filter/executor/IoEventQueueThrottle.java?rev=593426&r1=593425&r2=593426&view=diff
==============================================================================
---
mina/trunk/core/src/main/java/org/apache/mina/filter/executor/IoEventQueueThrottle.java
(original)
+++
mina/trunk/core/src/main/java/org/apache/mina/filter/executor/IoEventQueueThrottle.java
Thu Nov 8 22:22:24 2007
@@ -27,7 +27,8 @@
import org.slf4j.LoggerFactory;
/**
- * Throttles incoming events into [EMAIL PROTECTED] OrderedThreadPoolExecutor}.
+ * Throttles incoming events into [EMAIL PROTECTED] OrderedThreadPoolExecutor}
or
+ * [EMAIL PROTECTED] UnorderedThreadPoolExecutor}.
*
* @author The Apache MINA Project ([EMAIL PROTECTED])
* @version $Rev$, $Date$
Modified:
mina/trunk/core/src/main/java/org/apache/mina/filter/executor/OrderedThreadPoolExecutor.java
URL:
http://svn.apache.org/viewvc/mina/trunk/core/src/main/java/org/apache/mina/filter/executor/OrderedThreadPoolExecutor.java?rev=593426&r1=593425&r2=593426&view=diff
==============================================================================
---
mina/trunk/core/src/main/java/org/apache/mina/filter/executor/OrderedThreadPoolExecutor.java
(original)
+++
mina/trunk/core/src/main/java/org/apache/mina/filter/executor/OrderedThreadPoolExecutor.java
Thu Nov 8 22:22:24 2007
@@ -42,7 +42,10 @@
/**
* A [EMAIL PROTECTED] ThreadPoolExecutor} that maintains the order of [EMAIL
PROTECTED] IoEvent}s.
- *
+ * <p>
+ * If you don't need to maintain the order of events per session, please use
+ * [EMAIL PROTECTED] UnorderedThreadPoolExecutor}.
+
* @author The Apache MINA Project ([EMAIL PROTECTED])
* @version $Rev$, $Date$
*/
