Merge pull request #2029 from Cousjava/javadoc-threadlocalpool

Added javadoc comments to explain ThreadLocalPool and some others
eclipse-ee4j · Mar 25, 2019 · d1c4b52 · d1c4b52
2 parents 107a650 + 1771a49
commit d1c4b52
Show file tree

Hide file tree

Showing 31 changed files with 307 additions and 249 deletions.
diff --git a/modules/grizzly/src/main/java/org/glassfish/grizzly/AbstractBindingHandler.java b/modules/grizzly/src/main/java/org/glassfish/grizzly/AbstractBindingHandler.java
@@ -1,5 +1,6 @@
 /*
  * Copyright (c) 2012, 2017 Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2018 Payara Services Ltd.
  *
  * This program and the accompanying materials are made available under the
  * terms of the Eclipse Public License v. 2.0, which is available at
@@ -163,7 +164,7 @@ public Connection<?> bind(final String host, final PortRange portRange,
     /**
      * This operation is not supported by implementations of {@link AbstractBindingHandler}.
      *
-     * @throws UnsupportedOperationException
+     * @throws UnsupportedOperationException by default
      */
     @Override
     public final void unbindAll() {

diff --git a/modules/grizzly/src/main/java/org/glassfish/grizzly/AbstractSocketConnectorHandler.java b/modules/grizzly/src/main/java/org/glassfish/grizzly/AbstractSocketConnectorHandler.java
@@ -1,5 +1,6 @@
 /*
  * Copyright (c) 2008, 2017 Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2018 Payara Services Ltd.
  *
  * This program and the accompanying materials are made available under the
  * terms of the Eclipse Public License v. 2.0, which is available at
@@ -140,6 +141,7 @@ public void addMonitoringProbe(ConnectionProbe probe) {
      * Remove the {@link ConnectionProbe}.
      *
      * @param probe the {@link ConnectionProbe}.
+     * @return true if probe was in the list and is now removed
      */
     public boolean removeMonitoringProbe(ConnectionProbe probe) {
         return probes.remove(probe);
@@ -190,7 +192,7 @@ protected void onComplete() {
     /**
      * Builder
      *
-     * @param <E>
+     * @param <E> itself
      */
     @SuppressWarnings("unchecked")
     public abstract static class Builder<E extends Builder> {

diff --git a/modules/grizzly/src/main/java/org/glassfish/grizzly/AbstractTransport.java b/modules/grizzly/src/main/java/org/glassfish/grizzly/AbstractTransport.java
@@ -432,8 +432,8 @@ public void setAttributeBuilder(AttributeBuilder attributeBuilder) {
     /**
      * Close the connection, managed by Transport
      * 
-     * @param connection
-     * @throws IOException
+     * @param connection {@link org.glassfish.grizzly.nio.NIOConnection} to close
+     * @throws IOException not used
      */
     protected abstract void closeConnection(Connection connection) throws IOException;