This is an automated email from the ASF dual-hosted git repository. elecharny pushed a commit to branch 2.0.X in repository https://gitbox.apache.org/repos/asf/mina.git
The following commit(s) were added to refs/heads/2.0.X by this push: new 923c5b7 Fixed javadoc 923c5b7 is described below commit 923c5b774dec5d5448ddaad1ffb1fd28e7e27fc1 Author: emmanuel lecharny <elecha...@apache.org> AuthorDate: Wed Feb 9 08:04:12 2022 +0100 Fixed javadoc --- .../executor/OrderedThreadPoolExecutorTest.java | 16 ++++++++-------- .../executor/PriorityThreadPoolExecutorTest.java | 19 +++++++++++++------ .../executor/UnorderedThreadPoolExecutorTest.java | 18 ++++++++++-------- .../java/org/apache/mina/handler/DIRMINA1156Test.java | 18 ++++++++++++++++++ 4 files changed, 49 insertions(+), 22 deletions(-) diff --git a/mina-core/src/test/java/org/apache/mina/filter/executor/OrderedThreadPoolExecutorTest.java b/mina-core/src/test/java/org/apache/mina/filter/executor/OrderedThreadPoolExecutorTest.java index de6c9d9..f0c34e9 100644 --- a/mina-core/src/test/java/org/apache/mina/filter/executor/OrderedThreadPoolExecutorTest.java +++ b/mina-core/src/test/java/org/apache/mina/filter/executor/OrderedThreadPoolExecutorTest.java @@ -41,17 +41,17 @@ import org.junit.Test; public class OrderedThreadPoolExecutorTest { /** - * Tests the state of {@link OrderedThreadPoolExecutor#idleWorkers} and {@link OrderedThreadPoolExecutor#workers} - * after a RuntimeException is thrown when the {@link OrderedThreadPoolExecutor.Worker} is running. + * Tests the state of OrderedThreadPoolExecutor Workers + * after a RuntimeException is thrown when the OrderedThreadPoolExecutor Worker is running. * * Note that the implementation of this test is <em>not representative</em> of how tasks are normally executed, as * tasks would ordinarily be 'wrapped' in a FilterChain. Most FilterChain implementations would catch the * RuntimeException that is being used in the implementation of this test. The purpose of this test is to verify * Worker's behavior when a RuntimeException is thrown during execution occurs (even if that RuntimeException cannot * occur in the way that this test simulates it). A test that implements the execution in a more realistic manner is - * provided in {@link org.apache.mina.transport.socket.nio.DIRMINA1156Test}. + * provided in {@link org.apache.mina.handler.DIRMINA1156Test}. * - * @see org.apache.mina.transport.socket.nio.DIRMINA1156Test + * @see org.apache.mina.handler.DIRMINA1156Test * @see <a href="https://issues.apache.org/jira/browse/DIRMINA-1132">Issue DIRMINA-1156: Inconsistent worker / idleWorker in ThreadPoolExecutors</a> */ @Test @@ -93,17 +93,17 @@ public class OrderedThreadPoolExecutorTest } /** - * Tests the state of {@link OrderedThreadPoolExecutor#idleWorkers} and {@link OrderedThreadPoolExecutor#workers} - * after an Error is thrown when the {@link OrderedThreadPoolExecutor.Worker} is running. + * Tests the state of OrderedThreadPoolExecutor workers + * after an Error is thrown when the OrderedThreadPoolExecutor Worker is running. * * Note that the implementation of this test is <em>not representative</em> of how tasks are normally executed, as * tasks would ordinarily be 'wrapped' in a FilterChain. Most FilterChain implementations would catch the Error that * is being used in the implementation of this test. The purpose of this test is to verify Worker's behavior when an * Error is thrown during execution occurs (even if that Error cannot occur in the way that this test simulates it). * A test that implements the execution in a more realistic manner is provided in - * {@link org.apache.mina.transport.socket.nio.DIRMINA1156Test}. + * {@link org.apache.mina.handler.DIRMINA1156Test}. * - * @see org.apache.mina.transport.socket.nio.DIRMINA1156Test + * @see org.apache.mina.handler.DIRMINA1156Test * @see <a href="https://issues.apache.org/jira/browse/DIRMINA-1132">Issue DIRMINA-1156: Inconsistent worker / idleWorker in ThreadPoolExecutors</a> */ @Test diff --git a/mina-core/src/test/java/org/apache/mina/filter/executor/PriorityThreadPoolExecutorTest.java b/mina-core/src/test/java/org/apache/mina/filter/executor/PriorityThreadPoolExecutorTest.java index 97c97cd..66f092f 100644 --- a/mina-core/src/test/java/org/apache/mina/filter/executor/PriorityThreadPoolExecutorTest.java +++ b/mina-core/src/test/java/org/apache/mina/filter/executor/PriorityThreadPoolExecutorTest.java @@ -52,6 +52,7 @@ public class PriorityThreadPoolExecutorTest { * * This test asserts that, without a provided comparator, entries are * considered equal, when they reference the same session. + * @throws Exception an exception */ @Test public void fifoEntryTestNoComparatorSameSession() throws Exception { @@ -74,6 +75,7 @@ public class PriorityThreadPoolExecutorTest { * * This test asserts that, without a provided comparator, the first entry * created is 'less than' an entry that is created later. + * @throws Exception an exception */ @Test public void fifoEntryTestNoComparatorDifferentSession() throws Exception { @@ -97,6 +99,7 @@ public class PriorityThreadPoolExecutorTest { * This test asserts that, with a provided comparator, entries are * considered equal, when they reference the same session (the provided * comparator is ignored). + * @throws Exception an exception */ @Test public void fifoEntryTestWithComparatorSameSession() throws Exception { @@ -129,6 +132,7 @@ public class PriorityThreadPoolExecutorTest { * This test asserts that a provided comparator is used instead of the * (fallback) default behavior (when entries are referring different * sessions). + * @throws Exception an exception */ @Test public void fifoEntryTestComparatorDifferentSession() throws Exception { @@ -166,6 +170,7 @@ public class PriorityThreadPoolExecutorTest { * Each session records the timestamp of its last activity. After all work * has been processed, the test asserts that the last activity of all * sessions was later than the last activity of the preferred session. + * @throws Exception an exception */ @Test @Ignore("This test faiuls randomly") @@ -214,18 +219,19 @@ public class PriorityThreadPoolExecutorTest { } /** - * Tests the state of {@link PriorityThreadPoolExecutor#idleWorkers} and {@link PriorityThreadPoolExecutor#workers} - * after a RuntimeException is thrown when the {@link PriorityThreadPoolExecutor.Worker} is running. + * Tests the state of PriorityThreadPoolExecutor workers + * after a RuntimeException is thrown when the PriorityThreadPoolExecutor Worker is running. * * Note that the implementation of this test is <em>not representative</em> of how tasks are normally executed, as * tasks would ordinarily be 'wrapped' in a FilterChain. Most FilterChain implementations would catch the * RuntimeException that is being used in the implementation of this test. The purpose of this test is to verify * Worker's behavior when a RuntimeException is thrown during execution occurs (even if that RuntimeException cannot * occur in the way that this test simulates it). A test that implements the execution in a more realistic manner is - * provided in {@link org.apache.mina.transport.socket.nio.DIRMINA1156Test}. + * provided in {@link org.apache.mina.handler.DIRMINA1156Test}. * - * @see org.apache.mina.transport.socket.nio.DIRMINA1156Test + * @see org.apache.mina.handler.DIRMINA1156Test * @see <a href="https://issues.apache.org/jira/browse/DIRMINA-1132">Issue DIRMINA-1156: Inconsistent worker / idleWorker in ThreadPoolExecutors</a> + * @throws Exception an exception */ @Test public void testRuntimeExceptionInWorkerRun() throws Throwable @@ -274,10 +280,11 @@ public class PriorityThreadPoolExecutorTest { * is being used in the implementation of this test. The purpose of this test is to verify Worker's behavior when an * Error is thrown during execution occurs (even if that Error cannot occur in the way that this test simulates it). * A test that implements the execution in a more realistic manner is provided in - * {@link org.apache.mina.transport.socket.nio.DIRMINA1156Test}. + * {@link org.apache.mina.handler.DIRMINA1156Test}. * - * @see org.apache.mina.transport.socket.nio.DIRMINA1156Test + * @see org.apache.mina.handler.DIRMINA1156Test * @see <a href="https://issues.apache.org/jira/browse/DIRMINA-1132">Issue DIRMINA-1156: Inconsistent worker / idleWorker in ThreadPoolExecutors</a> + * @throws Exception an exception */ @Test public void testErrorInWorkerRun() throws Throwable diff --git a/mina-core/src/test/java/org/apache/mina/filter/executor/UnorderedThreadPoolExecutorTest.java b/mina-core/src/test/java/org/apache/mina/filter/executor/UnorderedThreadPoolExecutorTest.java index 22adcea..8991bed 100644 --- a/mina-core/src/test/java/org/apache/mina/filter/executor/UnorderedThreadPoolExecutorTest.java +++ b/mina-core/src/test/java/org/apache/mina/filter/executor/UnorderedThreadPoolExecutorTest.java @@ -41,18 +41,19 @@ import org.junit.Test; public class UnorderedThreadPoolExecutorTest { /** - * Tests the state of {@link UnorderedThreadPoolExecutor#idleWorkers} and {@link UnorderedThreadPoolExecutor#workers} - * after a RuntimeException is thrown when the {@link UnorderedThreadPoolExecutor.Worker} is running. + * Tests the state of UnorderedThreadPoolExecutor workers + * after a RuntimeException is thrown when the UnorderedThreadPoolExecutor Worker is running. * * Note that the implementation of this test is <em>not representative</em> of how tasks are normally executed, as * tasks would ordinarily be 'wrapped' in a FilterChain. Most FilterChain implementations would catch the * RuntimeException that is being used in the implementation of this test. The purpose of this test is to verify * Worker's behavior when a RuntimeException is thrown during execution occurs (even if that RuntimeException cannot * occur in the way that this test simulates it). A test that implements the execution in a more realistic manner is - * provided in {@link org.apache.mina.transport.socket.nio.DIRMINA1156Test}. + * provided in {@link org.apache.mina.handler.DIRMINA1156Test}. * - * @see org.apache.mina.transport.socket.nio.DIRMINA1156Test + * @see org.apache.mina.handler.DIRMINA1156Test * @see <a href="https://issues.apache.org/jira/browse/DIRMINA-1132">Issue DIRMINA-1156: Inconsistent worker / idleWorker in ThreadPoolExecutors</a> + * @throws Exception an exception */ @Test public void testRuntimeExceptionInWorkerRun() throws Throwable @@ -93,18 +94,19 @@ public class UnorderedThreadPoolExecutorTest } /** - * Tests the state of {@link UnorderedThreadPoolExecutor#idleWorkers} and {@link UnorderedThreadPoolExecutor#workers} - * after an Error is thrown when the {@link UnorderedThreadPoolExecutor.Worker} is running. + * Tests the state of UnorderedThreadPoolExecutor workers + * after an Error is thrown when the UnorderedThreadPoolExecutor Worker is running. * * Note that the implementation of this test is <em>not representative</em> of how tasks are normally executed, as * tasks would ordinarily be 'wrapped' in a FilterChain. Most FilterChain implementations would catch the Error that * is being used in the implementation of this test. The purpose of this test is to verify Worker's behavior when an * Error is thrown during execution occurs (even if that Error cannot occur in the way that this test simulates it). * A test that implements the execution in a more realistic manner is provided in - * {@link org.apache.mina.transport.socket.nio.DIRMINA1156Test}. + * {@link org.apache.mina.handler.DIRMINA1156Test}. * - * @see org.apache.mina.transport.socket.nio.DIRMINA1156Test + * @see org.apache.mina.handler.DIRMINA1156Test * @see <a href="https://issues.apache.org/jira/browse/DIRMINA-1132">Issue DIRMINA-1156: Inconsistent worker / idleWorker in ThreadPoolExecutors</a> + * @throws Exception an exception */ @Test public void testErrorInWorkerRun() throws Throwable diff --git a/mina-core/src/test/java/org/apache/mina/handler/DIRMINA1156Test.java b/mina-core/src/test/java/org/apache/mina/handler/DIRMINA1156Test.java index 40b7073..5965fb1 100644 --- a/mina-core/src/test/java/org/apache/mina/handler/DIRMINA1156Test.java +++ b/mina-core/src/test/java/org/apache/mina/handler/DIRMINA1156Test.java @@ -46,6 +46,8 @@ public class DIRMINA1156Test /** * Tests the state of {@link OrderedThreadPoolExecutor#idleWorkers} and {@link OrderedThreadPoolExecutor#workers} * after an {@link Error} is thrown by a session's handler that was invoked through an OrderedThreadPoolExecutor. + * + * @throws Exception exception */ @Test public void testOrderedThreadPoolExecutorSessionHandlerThrowingError() throws Exception @@ -93,6 +95,8 @@ public class DIRMINA1156Test * Tests the state of {@link OrderedThreadPoolExecutor#idleWorkers} and {@link OrderedThreadPoolExecutor#workers} * after a {@link RuntimeException} is thrown by a session's handler that was invoked through an * OrderedThreadPoolExecutor. + * + * @throws Exception exception */ @Test public void testOrderedThreadPoolExecutorSessionHandlerThrowingRuntimeException() throws Exception @@ -140,6 +144,8 @@ public class DIRMINA1156Test * Tests the state of {@link OrderedThreadPoolExecutor#idleWorkers} and {@link OrderedThreadPoolExecutor#workers} * after a (checked) {@link Exception} is thrown by a session's handler that was invoked through an * OrderedThreadPoolExecutor. + * + * @throws Exception exception */ @Test public void testOrderedThreadPoolExecutorSessionHandlerThrowingCheckedException() throws Exception @@ -186,6 +192,8 @@ public class DIRMINA1156Test /** * Tests the state of {@link UnorderedThreadPoolExecutor#idleWorkers} and {@link UnorderedThreadPoolExecutor#workers} * after an {@link Error} is thrown by a session's handler that was invoked through an UnorderedThreadPoolExecutor. + * + * @throws Exception exception */ @Test public void testUnorderedThreadPoolExecutorSessionHandlerThrowingError() throws Exception @@ -233,6 +241,8 @@ public class DIRMINA1156Test * Tests the state of {@link UnorderedThreadPoolExecutor#idleWorkers} and {@link UnorderedThreadPoolExecutor#workers} * after a {@link RuntimeException} is thrown by a session's handler that was invoked through an * UnorderedThreadPoolExecutor. + * + * @throws Exception exception */ @Test public void testUnorderedThreadPoolExecutorSessionHandlerThrowingRuntimeException() throws Exception @@ -280,6 +290,8 @@ public class DIRMINA1156Test * Tests the state of {@link UnorderedThreadPoolExecutor#idleWorkers} and {@link UnorderedThreadPoolExecutor#workers} * after a (checked) {@link Exception} is thrown by a session's handler that was invoked through an * UnorderedThreadPoolExecutor. + * + * @throws Exception exception */ @Test public void testUnorderedThreadPoolExecutorSessionHandlerThrowingCheckedException() throws Exception @@ -326,6 +338,8 @@ public class DIRMINA1156Test /** * Tests the state of {@link PriorityThreadPoolExecutor#idleWorkers} and {@link PriorityThreadPoolExecutor#workers} * after an {@link Error} is thrown by a session's handler that was invoked through an PriorityThreadPoolExecutor. + * + * @throws Exception exception */ @Test public void testPriorityThreadPoolExecutorSessionHandlerThrowingError() throws Exception @@ -373,6 +387,8 @@ public class DIRMINA1156Test * Tests the state of {@link PriorityThreadPoolExecutor#idleWorkers} and {@link PriorityThreadPoolExecutor#workers} * after a {@link RuntimeException} is thrown by a session's handler that was invoked through an * PriorityThreadPoolExecutor. + * + * @throws Exception exception */ @Test public void testPriorityThreadPoolExecutorSessionHandlerThrowingRuntimeException() throws Exception @@ -420,6 +436,8 @@ public class DIRMINA1156Test * Tests the state of {@link PriorityThreadPoolExecutor#idleWorkers} and {@link PriorityThreadPoolExecutor#workers} * after a (checked) {@link Exception} is thrown by a session's handler that was invoked through an * PriorityThreadPoolExecutor. + * + * @throws Exception exception */ @Test public void testPriorityThreadPoolExecutorSessionHandlerThrowingCheckedException() throws Exception