[mina] branch 2.0.X updated: Fixed some javadoc issues
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 808354534 Fixed some javadoc issues
808354534 is described below
commit 808354534741ba2e57f84b11997677b7447744b3
Author: emmanuel lecharny
AuthorDate: Wed Sep 6 15:46:06 2023 +0200
Fixed some javadoc issues
---
.../src/main/java/org/apache/mina/core/.IoUtil.java.swp | Bin 0 -> 20480 bytes
.../src/main/java/org/apache/mina/core/IoUtil.java | 8
.../org/apache/mina/core/buffer/AbstractIoBuffer.java | 4 ++--
.../main/java/org/apache/mina/core/buffer/IoBuffer.java | 12 ++--
.../org/apache/mina/core/filterchain/IoFilterChain.java | 2 +-
.../mina/core/polling/AbstractPollingIoConnector.java | 2 +-
.../mina/core/polling/AbstractPollingIoProcessor.java | 8
.../java/org/apache/mina/core/service/IoAcceptor.java | 2 +-
.../java/org/apache/mina/core/service/IoService.java| 2 +-
.../java/org/apache/mina/core/session/DummySession.java | 2 +-
.../java/org/apache/mina/core/session/IoSession.java| 8
.../apache/mina/core/session/IoSessionAttributeMap.java | 4 ++--
.../org/apache/mina/core/session/IoSessionConfig.java | 2 +-
.../mina/filter/codec/CumulativeProtocolDecoder.java| 4 ++--
.../org/apache/mina/filter/executor/ExecutorFilter.java | 4 ++--
.../mina/filter/executor/IoEventQueueHandler.java | 2 +-
.../apache/mina/filter/keepalive/KeepAliveFilter.java | 4 ++--
.../org/apache/mina/filter/ssl/SslContextFactory.java | 4 ++--
.../main/java/org/apache/mina/filter/ssl/SslFilter.java | 10 +-
.../java/org/apache/mina/filter/ssl/SslHandler.java | 2 +-
.../apache/mina/handler/demux/DemuxingIoHandler.java| 6 +++---
.../org/apache/mina/handler/demux/MessageHandler.java | 2 +-
.../transport/socket/AbstractDatagramSessionConfig.java | 10 +-
.../transport/socket/AbstractSocketSessionConfig.java | 16
.../apache/mina/transport/socket/SocketAcceptor.java| 2 +-
.../mina/transport/socket/SocketSessionConfig.java | 10 +-
.../util/byteaccess/CompositeByteArrayRelativeBase.java | 2 +-
.../java/org/apache/mina/filter/compression/Zlib.java | 8
.../context/AbstractStateContextLookup.java | 2 +-
.../mina/statemachine/transition/SelfTransition.java| 2 +-
30 files changed, 73 insertions(+), 73 deletions(-)
diff --git a/mina-core/src/main/java/org/apache/mina/core/.IoUtil.java.swp
b/mina-core/src/main/java/org/apache/mina/core/.IoUtil.java.swp
new file mode 100644
index 0..0806e0c2b
Binary files /dev/null and
b/mina-core/src/main/java/org/apache/mina/core/.IoUtil.java.swp differ
diff --git a/mina-core/src/main/java/org/apache/mina/core/IoUtil.java
b/mina-core/src/main/java/org/apache/mina/core/IoUtil.java
index 72510e4d9..533ac3b1a 100644
--- a/mina-core/src/main/java/org/apache/mina/core/IoUtil.java
+++ b/mina-core/src/main/java/org/apache/mina/core/IoUtil.java
@@ -158,7 +158,7 @@ public final class IoUtil {
* @param futures The {@link IoFuture}s we are waiting on
* @param timeout The maximum time we wait for the {@link IoFuture}s to
complete
* @param unit The Time unit to use for the timeout
- * @return {@code TRUE if all the {@link IoFuture} have been
completed, FALSE} if
+ * @return {@code TRUE} if all the {@link IoFuture} have been completed,
{@code FALSE} if
* at least one {@link IoFuture} haas been interrupted
* @throws InterruptedException If one of the {@link IoFuture} is
interrupted
*/
@@ -172,7 +172,7 @@ public final class IoUtil {
*
* @param futures The {@link IoFuture}s we are waiting on
* @param timeoutMillis The maximum milliseconds we wait for the {@link
IoFuture}s to complete
- * @return {@code TRUE if all the {@link IoFuture} have been
completed, FALSE} if
+ * @return {@code TRUE} if all the {@link IoFuture} have been completed,
{@code FALSE} if
* at least one {@link IoFuture} has been interrupted
* @throws InterruptedException If one of the {@link IoFuture} is
interrupted
*/
@@ -186,7 +186,7 @@ public final class IoUtil {
* @param futures The {@link IoFuture}s we are waiting on
* @param timeout The maximum time we wait for the {@link IoFuture}s to
complete
* @param unit The Time unit to use for the timeout
- * @return {@code TRUE if all the {@link IoFuture} have been
completed, FALSE} if
+ * @return {@code TRUE} if all the {@link IoFuture} have been completed,
{@code FALSE} if
* at least one {@link IoFuture} has been interrupted
*/
public static boolean awaitUninterruptibly(Iterable
futures, long timeout, TimeUnit unit) {
@@ -198,7 +198,7 @@ public final class IoUtil {
*
[mina] branch 2.0.X updated: Fixed some javadoc issues. Bumped up some maven plugin dependencies
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 6d4f0ef9f Fixed some javadoc issues. Bumped up some maven plugin
dependencies
6d4f0ef9f is described below
commit 6d4f0ef9f92afd678d0f670de93577ce26ab30e2
Author: emmanuel lecharny
AuthorDate: Sat Sep 2 13:47:51 2023 +0200
Fixed some javadoc issues. Bumped up some maven plugin dependencies
---
.../java/org/apache/mina/core/buffer/IoBuffer.java | 3 +-
.../executor/PriorityThreadPoolExecutor.java | 184 +++--
pom.xml| 64 +++
3 files changed, 128 insertions(+), 123 deletions(-)
diff --git a/mina-core/src/main/java/org/apache/mina/core/buffer/IoBuffer.java
b/mina-core/src/main/java/org/apache/mina/core/buffer/IoBuffer.java
index 4383e9e02..cca2635fa 100644
--- a/mina-core/src/main/java/org/apache/mina/core/buffer/IoBuffer.java
+++ b/mina-core/src/main/java/org/apache/mina/core/buffer/IoBuffer.java
@@ -1544,7 +1544,8 @@ public abstract class IoBuffer implements
Comparable {
*
* @param length The maximum number of bytes to dump from the current
buffer
* position.
- * @return hexidecimal representation of this buffer
+ * @param pretty If we should do a pretty dump
+ * @return hexadecimal representation of this buffer
*/
public String getHexDump(int length, boolean pretty) {
return (pretty) ? IoBufferHexDumper.getPrettyHexDumpSlice(this,
position(), Math.min(remaining(), length))
diff --git
a/mina-core/src/main/java/org/apache/mina/filter/executor/PriorityThreadPoolExecutor.java
b/mina-core/src/main/java/org/apache/mina/filter/executor/PriorityThreadPoolExecutor.java
index 43ace103a..aa009afb1 100644
---
a/mina-core/src/main/java/org/apache/mina/filter/executor/PriorityThreadPoolExecutor.java
+++
b/mina-core/src/main/java/org/apache/mina/filter/executor/PriorityThreadPoolExecutor.java
@@ -101,12 +101,18 @@ public class PriorityThreadPoolExecutor extends
ThreadPoolExecutor {
private final IoEventQueueHandler eventQueueHandler;
+/** The session comparator */
private final Comparator comparator;
/**
- * Creates a default ThreadPool, with default values : - minimum pool size
is 0
- * - maximum pool size is 16 - keepAlive set to 30 seconds - A default
- * ThreadFactory - All events are accepted
+ * Creates a default ThreadPool, with default values :
+ *
+ * minimum pool size is 0
+ * maximum pool size is 16
+ * keepAlive set to 30 seconds
+ * A default ThreadFactory
+ * All events are accepted
+ *
*/
public PriorityThreadPoolExecutor() {
this(DEFAULT_INITIAL_THREAD_POOL_SIZE, DEFAULT_MAX_THREAD_POOL,
DEFAULT_KEEP_ALIVE, TimeUnit.SECONDS,
@@ -114,9 +120,15 @@ public class PriorityThreadPoolExecutor extends
ThreadPoolExecutor {
}
/**
- * Creates a default ThreadPool, with default values : - minimum pool size
is 0
- * - maximum pool size is 16 - keepAlive set to 30 seconds - A default
- * ThreadFactory - All events are accepted
+ * Creates a default ThreadPool, with default values :
+ *
+ * minimum pool size is 0
+ * maximum pool size is 16
+ * keepAlive set to 30 seconds
+ * A default ThreadFactory
+ * All events are accepted
+ *
+ * @param comparator A session comparator
*/
public PriorityThreadPoolExecutor(Comparator comparator) {
this(DEFAULT_INITIAL_THREAD_POOL_SIZE, DEFAULT_MAX_THREAD_POOL,
DEFAULT_KEEP_ALIVE, TimeUnit.SECONDS,
@@ -124,12 +136,14 @@ public class PriorityThreadPoolExecutor extends
ThreadPoolExecutor {
}
/**
- * Creates a default ThreadPool, with default values : - minimum pool size
is 0
- * - keepAlive set to 30 seconds - A default ThreadFactory - All events are
- * accepted
- *
- * @param maximumPoolSize
- *The maximum pool size
+ * Creates a default ThreadPool, with default values :
+ *
+ * minimum pool size is 0
+ * keepAlive set to 30 seconds
+ * A default ThreadFactory
+ * All events are accepted
+ *
+ * @param maximumPoolSize The maximum pool size
*/
public PriorityThreadPoolExecutor(int maximumPoolSize) {
this(DEFAULT_INITIAL_THREAD_POOL_SIZE, maximumPoolSize,
DEFAULT_KEEP_ALIVE, TimeUnit.SECONDS,
@@ -137,12 +151,16 @@ public class PriorityThreadPoolExecutor extends
ThreadPoolExecutor {
}
/**
- * Creates a default ThreadPool, with default values : - minimum pool size
is 0
- * - keepAlive set to 30 seconds - A default ThreadFactory - All events are
- * accepted
+ * Creates a default ThreadPool, with default values :
+ *
+ * maximum pool size is
[mina] branch 2.0.X updated: Fixed some javadoc issues
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 89d6c8c Fixed some javadoc issues
89d6c8c is described below
commit 89d6c8c77158d382a4657b73d4ea28a113d1f319
Author: emmanuel lecharny
AuthorDate: Wed Feb 9 09:22:36 2022 +0100
Fixed some javadoc issues
---
.../apache/mina/filter/executor/OrderedThreadPoolExecutorTest.java| 2 ++
.../apache/mina/filter/executor/PriorityThreadPoolExecutorTest.java | 4 ++--
2 files changed, 4 insertions(+), 2 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 f0c34e9..b35d9cb 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
@@ -53,6 +53,7 @@ public class OrderedThreadPoolExecutorTest
*
* @see org.apache.mina.handler.DIRMINA1156Test
* @see https://issues.apache.org/jira/browse/DIRMINA-1132";>Issue
DIRMINA-1156: Inconsistent worker / idleWorker in ThreadPoolExecutors
+ * @throws Excveption an exception
*/
@Test
public void testRuntimeExceptionInWorkerRun() throws Throwable
@@ -105,6 +106,7 @@ public class OrderedThreadPoolExecutorTest
*
* @see org.apache.mina.handler.DIRMINA1156Test
* @see https://issues.apache.org/jira/browse/DIRMINA-1132";>Issue
DIRMINA-1156: Inconsistent worker / idleWorker in ThreadPoolExecutors
+ * @throws Excveption an exception
*/
@Test
public void testErrorInWorkerRun() throws Throwable
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 66f092f..8a8ba82 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
@@ -272,8 +272,8 @@ public class PriorityThreadPoolExecutorTest {
}
/**
- * Tests the state of {@link PriorityThreadPoolExecutor#idleWorkers} and
{@link PriorityThreadPoolExecutor#workers}
- * after an Error is thrown when the {@link
PriorityThreadPoolExecutor.Worker} is running.
+ * Tests the state of PriorityThreadPoolExecutor workers
+ * after an Error is thrown when the PriorityThreadPoolExecutor worker is
running.
*
* Note that the implementation of this test is not
representative of how tasks are normally executed, as
* tasks would ordinarily be 'wrapped' in a FilterChain. Most FilterChain
implementations would catch the Error that
