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 <elecha...@apache.org>
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<IoBuffer> {
*
* @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<IoSession> 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 :
+ * <ul>
+ * <li>minimum pool size is 0</li>
+ * <li>maximum pool size is 16</li>
+ * <li>keepAlive set to 30 seconds</li>
+ * <li>A default ThreadFactory</li>
+ * <li>All events are accepted</li>
+ * </ul>
*/
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 :
+ * <ul>
+ * <li>minimum pool size is 0</li>
+ * <li>maximum pool size is 16</li>
+ * <li>keepAlive set to 30 seconds</li>
+ * <li>A default ThreadFactory</li>
+ * <li>All events are accepted</li>
+ * </ul>
+ * @param comparator A session comparator
*/
public PriorityThreadPoolExecutor(Comparator<IoSession> 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 :
+ * <ul>
+ * <li>minimum pool size is 0</li>
+ * <li>keepAlive set to 30 seconds</li>
+ * <li>A default ThreadFactory</li>
+ * <li>All events are accepted</li>
+ * </ul>
+ * @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 :
+ * <ul>
+ * <li>maximum pool size is 16</li>
+ * <li>keepAlive set to 30 seconds</li>
+ * <li>A default ThreadFactory</li>
+ * <li>All events are accepted</li>
+ * </ul>
*
- * @param maximumPoolSize
- * The maximum pool size
+ * @param maximumPoolSize The maximum pool size
+ * @param comparator A session comparator
*/
public PriorityThreadPoolExecutor(int maximumPoolSize,
Comparator<IoSession> comparator) {
this(DEFAULT_INITIAL_THREAD_POOL_SIZE, maximumPoolSize,
DEFAULT_KEEP_ALIVE, TimeUnit.SECONDS,
@@ -150,92 +168,78 @@ public class PriorityThreadPoolExecutor extends
ThreadPoolExecutor {
}
/**
- * Creates a default ThreadPool, with default values : - keepAlive set to
30
- * seconds - A default ThreadFactory - All events are accepted
+ * Creates a default ThreadPool, with default values :
+ * <ul>
+ * <li>keepAlive set to 30 seconds</li>
+ * <li>A default ThreadFactory</li>
+ * <li>All events are accepted</li>
+ * </ul>
*
- * @param corePoolSize
- * The initial pool sizePoolSize
- * @param maximumPoolSize
- * The maximum pool size
+ * @param minimumPoolSize The initial pool size
+ * @param maximumPoolSize The maximum pool size
*/
- public PriorityThreadPoolExecutor(int corePoolSize, int maximumPoolSize) {
- this(corePoolSize, maximumPoolSize, DEFAULT_KEEP_ALIVE,
TimeUnit.SECONDS, Executors.defaultThreadFactory(),
+ public PriorityThreadPoolExecutor(int minimumPoolSize, int
maximumPoolSize) {
+ this(minimumPoolSize, maximumPoolSize, DEFAULT_KEEP_ALIVE,
TimeUnit.SECONDS, Executors.defaultThreadFactory(),
null, null);
}
/**
- * Creates a default ThreadPool, with default values : - A default
ThreadFactory
- * - All events are accepted
+ * Creates a default ThreadPool, with default values :
+ * <ul>
+ * <li>minimum pool size is 0</li>
+ * <li>A default ThreadFactory</li>
+ * </ul>
*
- * @param corePoolSize
- * The initial pool sizePoolSize
- * @param maximumPoolSize
- * The maximum pool size
- * @param keepAliveTime
- * Default duration for a thread
- * @param unit
- * Time unit used for the keepAlive value
+ * @param minimumPoolSize The initial pool size
+ * @param maximumPoolSize The maximum pool size
+ * @param keepAliveTime Default duration for a thread
+ * @param unit Time unit used for the keepAlive value
*/
- public PriorityThreadPoolExecutor(int corePoolSize, int maximumPoolSize,
long keepAliveTime, TimeUnit unit) {
- this(corePoolSize, maximumPoolSize, keepAliveTime, unit,
Executors.defaultThreadFactory(), null, null);
+ public PriorityThreadPoolExecutor(int minimumPoolSize, int
maximumPoolSize, long keepAliveTime, TimeUnit unit) {
+ this(minimumPoolSize, maximumPoolSize, keepAliveTime, unit,
Executors.defaultThreadFactory(), null, null);
}
/**
* Creates a default ThreadPool, with default values : - A default
ThreadFactory
*
- * @param corePoolSize
- * The initial pool sizePoolSize
- * @param maximumPoolSize
- * The maximum pool size
- * @param keepAliveTime
- * Default duration for a thread
- * @param unit
- * Time unit used for the keepAlive value
- * @param eventQueueHandler
- * The queue used to store events
- */
- public PriorityThreadPoolExecutor(int corePoolSize, int maximumPoolSize,
long keepAliveTime, TimeUnit unit,
+ * @param minimumPoolSize The initial pool size
+ * @param maximumPoolSize The maximum pool size
+ * @param keepAliveTime Default duration for a thread
+ * @param unit Time unit used for the keepAlive value
+ * @param eventQueueHandler The queue used to store events
+ */
+ public PriorityThreadPoolExecutor(int minimumPoolSize, int
maximumPoolSize, long keepAliveTime, TimeUnit unit,
IoEventQueueHandler eventQueueHandler) {
- this(corePoolSize, maximumPoolSize, keepAliveTime, unit,
Executors.defaultThreadFactory(), eventQueueHandler,
+ this(minimumPoolSize, maximumPoolSize, keepAliveTime, unit,
Executors.defaultThreadFactory(), eventQueueHandler,
null);
}
/**
* Creates a default ThreadPool, with default values : - A default
ThreadFactory
*
- * @param corePoolSize
- * The initial pool sizePoolSize
- * @param maximumPoolSize
- * The maximum pool size
- * @param keepAliveTime
- * Default duration for a thread
- * @param unit
- * Time unit used for the keepAlive value
- * @param threadFactory
- * The factory used to create threads
- */
- public PriorityThreadPoolExecutor(int corePoolSize, int maximumPoolSize,
long keepAliveTime, TimeUnit unit,
+ * @param minimumPoolSize The initial pool size
+ * @param maximumPoolSize The maximum pool size
+ * @param keepAliveTime Default duration for a thread
+ * @param unit Time unit used for the keepAlive value
+ * @param threadFactory The factory used to create threads
+ */
+ public PriorityThreadPoolExecutor(int minimumPoolSize, int
maximumPoolSize, long keepAliveTime, TimeUnit unit,
ThreadFactory threadFactory) {
- this(corePoolSize, maximumPoolSize, keepAliveTime, unit,
threadFactory, null, null);
+ this(minimumPoolSize, maximumPoolSize, keepAliveTime, unit,
threadFactory, null, null);
}
/**
* Creates a new instance of a PrioritisedOrderedThreadPoolExecutor.
*
- * @param corePoolSize
- * The initial pool sizePoolSize
- * @param maximumPoolSize
- * The maximum pool size
- * @param keepAliveTime
- * Default duration for a thread
- * @param unit
- * Time unit used for the keepAlive value
- * @param threadFactory
- * The factory used to create threads
- * @param eventQueueHandler
- * The queue used to store events
- */
- public PriorityThreadPoolExecutor(int corePoolSize, int maximumPoolSize,
long keepAliveTime, TimeUnit unit,
+ * @param minimumPoolSize The initial pool sizePoolSize
+ * @param maximumPoolSize The maximum pool size
+ * @param keepAliveTime Default duration for a thread
+ * @param unit Time unit used for the keepAlive value
+ * @param threadFactory The factory used to create threads
+ * @param eventQueueHandler The queue used to store events
+ * @param comparator A session comparator
+ */
+ public PriorityThreadPoolExecutor(int minimumPoolSize, int
maximumPoolSize, long keepAliveTime, TimeUnit unit,
ThreadFactory threadFactory, IoEventQueueHandler
eventQueueHandler, Comparator<IoSession> comparator) {
// We have to initialize the pool with default values (0 and 1) in
order
// to
@@ -245,17 +249,17 @@ public class PriorityThreadPoolExecutor extends
ThreadPoolExecutor {
super(DEFAULT_INITIAL_THREAD_POOL_SIZE, 1, keepAliveTime, unit, new
SynchronousQueue<Runnable>(), threadFactory,
new AbortPolicy());
- if (corePoolSize < DEFAULT_INITIAL_THREAD_POOL_SIZE) {
- throw new IllegalArgumentException("corePoolSize: " +
corePoolSize);
+ if (minimumPoolSize < DEFAULT_INITIAL_THREAD_POOL_SIZE) {
+ throw new IllegalArgumentException("minimumPoolSize: " +
minimumPoolSize);
}
- if ((maximumPoolSize <= 0) || (maximumPoolSize < corePoolSize)) {
+ if ((maximumPoolSize <= 0) || (maximumPoolSize < minimumPoolSize)) {
throw new IllegalArgumentException("maximumPoolSize: " +
maximumPoolSize);
}
// Now, we can setup the pool sizes
super.setMaximumPoolSize(maximumPoolSize);
- super.setCorePoolSize(corePoolSize);
+ super.setCorePoolSize(minimumPoolSize);
// The queueHandler might be null.
if (eventQueueHandler == null) {
@@ -708,21 +712,21 @@ public class PriorityThreadPoolExecutor extends
ThreadPoolExecutor {
* {@inheritDoc}
*/
@Override
- public void setCorePoolSize(int corePoolSize) {
- if (corePoolSize < 0) {
- throw new IllegalArgumentException("corePoolSize: " +
corePoolSize);
+ public void setCorePoolSize(int minimumPoolSize) {
+ if (minimumPoolSize < 0) {
+ throw new IllegalArgumentException("minimumPoolSize: " +
minimumPoolSize);
}
- if (corePoolSize > super.getMaximumPoolSize()) {
- throw new IllegalArgumentException("corePoolSize exceeds
maximumPoolSize");
+ if (minimumPoolSize > super.getMaximumPoolSize()) {
+ throw new IllegalArgumentException("minimumPoolSize exceeds
maximumPoolSize");
}
synchronized (workers) {
- if (super.getCorePoolSize() > corePoolSize) {
- for (int i = super.getCorePoolSize() - corePoolSize; i > 0;
i--) {
+ if (super.getCorePoolSize() > minimumPoolSize) {
+ for (int i = super.getCorePoolSize() - minimumPoolSize; i > 0;
i--) {
removeWorker();
}
}
- super.setCorePoolSize(corePoolSize);
+ super.setCorePoolSize(minimumPoolSize);
}
}
@@ -895,7 +899,7 @@ public class PriorityThreadPoolExecutor extends
ThreadPoolExecutor {
int res = 0;
- // If there's a comparator, use it to prioritise events.
+ // If there's a comparator, use it to prioritize events.
if (comparator != null) {
res = comparator.compare(session, other.session);
}
diff --git a/pom.xml b/pom.xml
index 6383a48f1..7d28f49eb 100644
--- a/pom.xml
+++ b/pom.xml
@@ -24,7 +24,7 @@
<parent>
<groupId>org.apache</groupId>
<artifactId>apache</artifactId>
- <version>24</version>
+ <version>30</version>
<relativePath />
</parent>
@@ -95,50 +95,50 @@
<!-- additionalparam>-Xdoclint:none</additionalparam -->
<!-- Maven Plugins -->
- <version.apache.rat.plugin>0.13</version.apache.rat.plugin>
+ <version.apache.rat.plugin>0.15</version.apache.rat.plugin>
<version.api.plugin>3.9.4</version.api.plugin>
- <version.assembly.plugin>3.3.0</version.assembly.plugin>
- <version.build.helper.plugin>3.2.0</version.build.helper.plugin>
- <version.bundle.plugin>4.1.0</version.bundle.plugin>
+ <version.assembly.plugin>3.6.0</version.assembly.plugin>
+ <version.build.helper.plugin>3.4.0</version.build.helper.plugin>
+ <version.bundle.plugin>3.5.1</version.bundle.plugin>
<version.changes.plugin>2.12.1</version.changes.plugin>
- <version.checkstyle.plugin>3.1.2</version.checkstyle.plugin>
- <version.clean.plugin>3.1.0</version.clean.plugin>
+ <version.checkstyle.plugin>3.3.0</version.checkstyle.plugin>
+ <version.clean.plugin>3.3.1</version.clean.plugin>
<version.clirr.plugin>2.8</version.clirr.plugin>
<version.cobertura.plugin>2.7</version.cobertura.plugin>
- <version.compiler.plugin>3.8.1</version.compiler.plugin>
+ <version.compiler.plugin>3.11.0</version.compiler.plugin>
<version.dashboard.plugin>1.0.0-beta-1</version.dashboard.plugin>
- <version.dependency.plugin>3.1.2</version.dependency.plugin>
- <version.deploy.plugin>3.0.0-M1</version.deploy.plugin>
+ <version.dependency.plugin>3.6.0</version.dependency.plugin>
+ <version.deploy.plugin>3.1.1</version.deploy.plugin>
<version.docck.plugin>1.1</version.docck.plugin>
<version.eclipse.plugin>2.10</version.eclipse.plugin>
- <version.enforcer.plugin>3.0.0-M3</version.enforcer.plugin>
+ <version.enforcer.plugin>3.4.0</version.enforcer.plugin>
<version.findbugs.plugin>3.0.5</version.findbugs.plugin>
- <version.gpg.plugin>1.6</version.gpg.plugin>
- <version.install.plugin>3.0.0-M1</version.install.plugin>
- <version.jar.plugin>3.2.0</version.jar.plugin>
+ <version.gpg.plugin>3.1.0</version.gpg.plugin>
+ <version.install.plugin>3.1.1</version.install.plugin>
+ <version.jar.plugin>3.3.0</version.jar.plugin>
<version.javancss.plugin>2.1</version.javancss.plugin>
- <version.javadoc.plugin>3.2.0</version.javadoc.plugin>
+ <version.javadoc.plugin>3.5.0</version.javadoc.plugin>
<version.jdepend.plugin>2.0</version.jdepend.plugin>
- <version.jxr.plugin>3.1.1</version.jxr.plugin>
+ <version.jxr.plugin>3.3.0</version.jxr.plugin>
<version.model.plugin>3.9.4</version.model.plugin>
<version.plexus.utils>4.0.0</version.plexus.utils>
- <version.plugin.plugin>3.6.1</version.plugin.plugin>
- <version.pmd.plugin>3.14.0</version.pmd.plugin>
+ <version.plugin.plugin>3.9.0</version.plugin.plugin>
+ <version.pmd.plugin>3.21.0</version.pmd.plugin>
<version.project.plugin>3.0-alpha-2</version.project.plugin>
-
<version.project.info.report.plugin>3.1.2</version.project.info.report.plugin>
+
<version.project.info.report.plugin>3.4.5</version.project.info.report.plugin>
<version.rat.maven.plugin>1.0-alpha-3</version.rat.maven.plugin>
- <version.release.plugin>3.0.0-M5</version.release.plugin>
- <version.remote.resources.plugin>1.7.0</version.remote.resources.plugin>
- <version.resources.plugin>3.2.0</version.resources.plugin>
- <version.scm.plugin>1.11.2</version.scm.plugin>
+ <version.release.plugin>3.0.1</version.release.plugin>
+ <version.remote.resources.plugin>3.1.0</version.remote.resources.plugin>
+ <version.resources.plugin>3.3.1</version.resources.plugin>
+ <version.scm.plugin>2.0.1</version.scm.plugin>
<version.site.plugin>3.9.1</version.site.plugin>
- <version.source.plugin>3.2.1</version.source.plugin>
+ <version.source.plugin>3.3.0</version.source.plugin>
<version.shade.plugin>3.5.0</version.shade.plugin>
- <version.surefire.plugin>3.0.0-M5</version.surefire.plugin>
- <version.surfire.report.plugin>3.0.0-M5</version.surfire.report.plugin>
- <version.taglist.plugin>2.4</version.taglist.plugin>
+ <version.surefire.plugin>3.1.2</version.surefire.plugin>
+ <version.surfire.report.plugin>3.1.2</version.surfire.report.plugin>
+ <version.taglist.plugin>3.0.0</version.taglist.plugin>
<version.tools.maven.plugin>1.4</version.tools.maven.plugin>
- <version.versions.plugin>2.8.1</version.versions.plugin>
+ <version.versions.plugin>2.16.0</version.versions.plugin>
<version.xbean.plugin>4.23</version.xbean.plugin>
<!-- Jars -->
@@ -153,7 +153,7 @@
<version.pmd>4.3</version.pmd>
<version.rmock>2.0.2</version.rmock>
<version.slf4j.api>1.7.36</version.slf4j.api>
- <version.slf4j.log4j12>1.7.36</version.slf4j.log4j12>
+ <version.slf4j.reload4j>1.7.36</version.slf4j.reload4j>
<version.slf4j.jcl.over.slf4j>1.7.36</version.slf4j.jcl.over.slf4j>
<version.springframework>2.5.6.SEC03</version.springframework>
<version.tomcat.jni>10.0.27</version.tomcat.jni>
@@ -325,8 +325,8 @@
<dependency>
<groupId>org.slf4j</groupId>
- <artifactId>slf4j-log4j12</artifactId>
- <version>${version.slf4j.log4j12}</version>
+ <artifactId>slf4j-reload4j</artifactId>
+ <version>${version.slf4j.reload4j}</version>
</dependency>
<dependency>
@@ -372,7 +372,7 @@
<!-- logging implementation used for unit tests -->
<dependency>
<groupId>org.slf4j</groupId>
- <artifactId>slf4j-log4j12</artifactId>
+ <artifactId>slf4j-reload4j</artifactId>
<scope>test</scope>
</dependency>
