docs

25 files changed, 80 insertions, 0 deletions

diff --git a/plugins/org.eclipse.net4j.db/src/org/eclipse/net4j/db/DBType.java b/plugins/org.eclipse.net4j.db/src/org/eclipse/net4j/db/DBType.java
index 03787e7864..47a385f54c 100644
--- a/plugins/org.eclipse.net4j.db/src/org/eclipse/net4j/db/DBType.java
+++ b/plugins/org.eclipse.net4j.db/src/org/eclipse/net4j/db/DBType.java
@@ -30,6 +30,7 @@ import java.sql.SQLException;
  * Enumerates the SQL data types that are compatible with the DB framework.
  * 
  * @author Eike Stepper
+ * @noextend This interface is not intended to be extended by clients.
  */
 public enum DBType
 {
diff --git a/plugins/org.eclipse.net4j.db/src/org/eclipse/net4j/db/ddl/IDBField.java b/plugins/org.eclipse.net4j.db/src/org/eclipse/net4j/db/ddl/IDBField.java
index a2ef2e7f50..ae64b52c54 100644
--- a/plugins/org.eclipse.net4j.db/src/org/eclipse/net4j/db/ddl/IDBField.java
+++ b/plugins/org.eclipse.net4j.db/src/org/eclipse/net4j/db/ddl/IDBField.java
@@ -13,8 +13,11 @@ package org.eclipse.net4j.db.ddl;
 import org.eclipse.net4j.db.DBType;
 
 /**
+ * A field (column) specification in a {@link IDBTable DB table}.
+ * 
  * @author Eike Stepper
  * @noimplement This interface is not intended to be implemented by clients.
+ * @noextend This interface is not intended to be extended by clients.
  */
 public interface IDBField extends IDBSchemaElement
 {
diff --git a/plugins/org.eclipse.net4j.db/src/org/eclipse/net4j/db/ddl/IDBIndex.java b/plugins/org.eclipse.net4j.db/src/org/eclipse/net4j/db/ddl/IDBIndex.java
index cccbecb961..7698cf2dc5 100644
--- a/plugins/org.eclipse.net4j.db/src/org/eclipse/net4j/db/ddl/IDBIndex.java
+++ b/plugins/org.eclipse.net4j.db/src/org/eclipse/net4j/db/ddl/IDBIndex.java
@@ -11,8 +11,11 @@
 package org.eclipse.net4j.db.ddl;
 
 /**
+ * An index specification in a {@link IDBTable DB table}.
+ * 
  * @author Eike Stepper
  * @noimplement This interface is not intended to be implemented by clients.
+ * @noextend This interface is not intended to be extended by clients.
  */
 public interface IDBIndex extends IDBSchemaElement
 {
@@ -29,7 +32,10 @@ public interface IDBIndex extends IDBSchemaElement
   public int getPosition();
 
   /**
+   * The type of an {@link IDBIndex index} specification in a {@link IDBTable DB table}.
+   * 
    * @author Eike Stepper
+   * @noextend This interface is not intended to be extended by clients.
    */
   public enum Type
   {
diff --git a/plugins/org.eclipse.net4j.db/src/org/eclipse/net4j/db/ddl/IDBSchema.java b/plugins/org.eclipse.net4j.db/src/org/eclipse/net4j/db/ddl/IDBSchema.java
index d8276c5e93..70d66863d0 100644
--- a/plugins/org.eclipse.net4j.db/src/org/eclipse/net4j/db/ddl/IDBSchema.java
+++ b/plugins/org.eclipse.net4j.db/src/org/eclipse/net4j/db/ddl/IDBSchema.java
@@ -21,6 +21,9 @@ import java.sql.Connection;
 import java.util.Set;
 
 /**
+ * Specifies a number of {@link IDBTable DB tables} that can be created in or dropped from a database through a
+ * {@link IDBAdapter DB adapter}.
+ * 
  * @author Eike Stepper
  */
 public interface IDBSchema extends IDBSchemaElement
diff --git a/plugins/org.eclipse.net4j.db/src/org/eclipse/net4j/db/ddl/IDBSchemaElement.java b/plugins/org.eclipse.net4j.db/src/org/eclipse/net4j/db/ddl/IDBSchemaElement.java
index a95e709e90..d563271dfd 100644
--- a/plugins/org.eclipse.net4j.db/src/org/eclipse/net4j/db/ddl/IDBSchemaElement.java
+++ b/plugins/org.eclipse.net4j.db/src/org/eclipse/net4j/db/ddl/IDBSchemaElement.java
@@ -13,8 +13,11 @@ package org.eclipse.net4j.db.ddl;
 import java.util.Properties;
 
 /**
+ * Specifies a hierachical namespace for elements in a {@link IDBSchema DB schema}.
+ * 
  * @author Eike Stepper
  * @noimplement This interface is not intended to be implemented by clients.
+ * @noextend This interface is not intended to be extended by clients.
  */
 public interface IDBSchemaElement
 {
diff --git a/plugins/org.eclipse.net4j.db/src/org/eclipse/net4j/db/ddl/IDBTable.java b/plugins/org.eclipse.net4j.db/src/org/eclipse/net4j/db/ddl/IDBTable.java
index dae66afd2c..dc7166b389 100644
--- a/plugins/org.eclipse.net4j.db/src/org/eclipse/net4j/db/ddl/IDBTable.java
+++ b/plugins/org.eclipse.net4j.db/src/org/eclipse/net4j/db/ddl/IDBTable.java
@@ -13,8 +13,11 @@ package org.eclipse.net4j.db.ddl;
 import org.eclipse.net4j.db.DBType;
 
 /**
+ * A table specification in a {@link IDBSchema DB schema}.
+ * 
  * @author Eike Stepper
  * @noimplement This interface is not intended to be implemented by clients.
+ * @noextend This interface is not intended to be extended by clients.
  */
 public interface IDBTable extends IDBSchemaElement
 {
diff --git a/plugins/org.eclipse.net4j.db/src/org/eclipse/net4j/db/dml/IDBParameter.java b/plugins/org.eclipse.net4j.db/src/org/eclipse/net4j/db/dml/IDBParameter.java
index 48f24fe89b..c0493206ea 100644
--- a/plugins/org.eclipse.net4j.db/src/org/eclipse/net4j/db/dml/IDBParameter.java
+++ b/plugins/org.eclipse.net4j.db/src/org/eclipse/net4j/db/dml/IDBParameter.java
@@ -13,8 +13,11 @@ package org.eclipse.net4j.db.dml;
 import org.eclipse.net4j.db.DBType;
 
 /**
+ * A parameter specification in a {@link IDBStatement DB statement}.
+ * 
  * @author Eike Stepper
  * @noimplement This interface is not intended to be implemented by clients.
+ * @noextend This interface is not intended to be extended by clients.
  */
 public interface IDBParameter
 {
diff --git a/plugins/org.eclipse.net4j.db/src/org/eclipse/net4j/db/dml/IDBStatement.java b/plugins/org.eclipse.net4j.db/src/org/eclipse/net4j/db/dml/IDBStatement.java
index 20be8ba3b1..d38554c3f5 100644
--- a/plugins/org.eclipse.net4j.db/src/org/eclipse/net4j/db/dml/IDBStatement.java
+++ b/plugins/org.eclipse.net4j.db/src/org/eclipse/net4j/db/dml/IDBStatement.java
@@ -15,8 +15,11 @@ import org.eclipse.net4j.db.ddl.IDBField;
 import org.eclipse.net4j.db.ddl.IDBSchemaElement;
 
 /**
+ * Specifies an SQL statement with zero or more {@link IDBParameter parameters}.
+ * 
  * @author Eike Stepper
  * @noimplement This interface is not intended to be implemented by clients.
+ * @noextend This interface is not intended to be extended by clients.
  */
 public interface IDBStatement
 {
diff --git a/plugins/org.eclipse.net4j.http.common/src/org/eclipse/net4j/http/common/IHTTPConnector.java b/plugins/org.eclipse.net4j.http.common/src/org/eclipse/net4j/http/common/IHTTPConnector.java
index d8f7400492..b007ca1773 100644
--- a/plugins/org.eclipse.net4j.http.common/src/org/eclipse/net4j/http/common/IHTTPConnector.java
+++ b/plugins/org.eclipse.net4j.http.common/src/org/eclipse/net4j/http/common/IHTTPConnector.java
@@ -13,6 +13,8 @@ package org.eclipse.net4j.http.common;
 import org.eclipse.net4j.connector.IConnector;
 
 /**
+ * A {@link IConnector connector} that implements polling HTTP transport.
+ * 
  * @author Eike Stepper
  * @noextend This interface is not intended to be extended by clients.
  * @noimplement This interface is not intended to be implemented by clients.
diff --git a/plugins/org.eclipse.net4j.http.server/src/org/eclipse/net4j/http/server/HTTPServerUtil.java b/plugins/org.eclipse.net4j.http.server/src/org/eclipse/net4j/http/server/HTTPServerUtil.java
index c4d5578521..d2a4f8da3b 100644
--- a/plugins/org.eclipse.net4j.http.server/src/org/eclipse/net4j/http/server/HTTPServerUtil.java
+++ b/plugins/org.eclipse.net4j.http.server/src/org/eclipse/net4j/http/server/HTTPServerUtil.java
@@ -15,6 +15,8 @@ import org.eclipse.net4j.http.internal.server.RandomizerInjector;
 import org.eclipse.net4j.util.container.IManagedContainer;
 
 /**
+ * A utility class with static convenience methods.
+ * 
  * @author Eike Stepper
  */
 public final class HTTPServerUtil
diff --git a/plugins/org.eclipse.net4j.http.server/src/org/eclipse/net4j/http/server/IHTTPAcceptor.java b/plugins/org.eclipse.net4j.http.server/src/org/eclipse/net4j/http/server/IHTTPAcceptor.java
index edacfa43ae..2a164e9ce4 100644
--- a/plugins/org.eclipse.net4j.http.server/src/org/eclipse/net4j/http/server/IHTTPAcceptor.java
+++ b/plugins/org.eclipse.net4j.http.server/src/org/eclipse/net4j/http/server/IHTTPAcceptor.java
@@ -13,6 +13,9 @@ package org.eclipse.net4j.http.server;
 import org.eclipse.net4j.acceptor.IAcceptor;
 
 /**
+ * An {@link IAcceptor acceptor} that implements HTTP transport by collaborating with a configured
+ * {@link INet4jTransportServlet servlet}.
+ * 
  * @author Eike Stepper
  * @noextend This interface is not intended to be extended by clients.
  * @noimplement This interface is not intended to be implemented by clients.
diff --git a/plugins/org.eclipse.net4j.http.server/src/org/eclipse/net4j/http/server/INet4jTransportServlet.java b/plugins/org.eclipse.net4j.http.server/src/org/eclipse/net4j/http/server/INet4jTransportServlet.java
index 23400e154d..d30e1f1324 100644
--- a/plugins/org.eclipse.net4j.http.server/src/org/eclipse/net4j/http/server/INet4jTransportServlet.java
+++ b/plugins/org.eclipse.net4j.http.server/src/org/eclipse/net4j/http/server/INet4jTransportServlet.java
@@ -19,6 +19,8 @@ import javax.servlet.Servlet;
 import java.io.IOException;
 
 /**
+ * A {@link Servlet servlet} with a configured {@link RequestHandler request handler}.
+ * 
  * @author Eike Stepper
  * @noextend This interface is not intended to be extended by clients.
  * @noimplement This interface is not intended to be implemented by clients.
@@ -30,6 +32,8 @@ public interface INet4jTransportServlet extends Servlet
   public void setRequestHandler(RequestHandler handler);
 
   /**
+   * Call-back that handles the requests that arrive at a {@link INet4jTransportServlet servlet}.
+   * 
    * @author Eike Stepper
    */
   public interface RequestHandler
diff --git a/plugins/org.eclipse.net4j.http/src/org/eclipse/net4j/http/HTTPUtil.java b/plugins/org.eclipse.net4j.http/src/org/eclipse/net4j/http/HTTPUtil.java
index 05527b52aa..e59d53dcff 100644
--- a/plugins/org.eclipse.net4j.http/src/org/eclipse/net4j/http/HTTPUtil.java
+++ b/plugins/org.eclipse.net4j.http/src/org/eclipse/net4j/http/HTTPUtil.java
@@ -15,6 +15,8 @@ import org.eclipse.net4j.internal.http.HTTPConnectorFactory;
 import org.eclipse.net4j.util.container.IManagedContainer;
 
 /**
+ * A utility class with static convenience methods.
+ * 
  * @author Eike Stepper
  */
 public final class HTTPUtil
diff --git a/plugins/org.eclipse.net4j.jvm/src/org/eclipse/net4j/jvm/IJVMAcceptor.java b/plugins/org.eclipse.net4j.jvm/src/org/eclipse/net4j/jvm/IJVMAcceptor.java
index c3e619baef..27c409b840 100644
--- a/plugins/org.eclipse.net4j.jvm/src/org/eclipse/net4j/jvm/IJVMAcceptor.java
+++ b/plugins/org.eclipse.net4j.jvm/src/org/eclipse/net4j/jvm/IJVMAcceptor.java
@@ -13,6 +13,8 @@ package org.eclipse.net4j.jvm;
 import org.eclipse.net4j.acceptor.IAcceptor;
 
 /**
+ * An {@link IAcceptor acceptor} that implements JVM-embedded transport.
+ * 
  * @author Eike Stepper
  * @noextend This interface is not intended to be extended by clients.
  * @noimplement This interface is not intended to be implemented by clients.
diff --git a/plugins/org.eclipse.net4j.jvm/src/org/eclipse/net4j/jvm/IJVMAcceptorManager.java b/plugins/org.eclipse.net4j.jvm/src/org/eclipse/net4j/jvm/IJVMAcceptorManager.java
index 46e837ff08..3b588893ca 100644
--- a/plugins/org.eclipse.net4j.jvm/src/org/eclipse/net4j/jvm/IJVMAcceptorManager.java
+++ b/plugins/org.eclipse.net4j.jvm/src/org/eclipse/net4j/jvm/IJVMAcceptorManager.java
@@ -14,6 +14,8 @@ import org.eclipse.net4j.internal.jvm.JVMAcceptorManager;
 import org.eclipse.net4j.util.registry.IRegistry;
 
 /**
+ * A singleton that manages all {@link IJVMAcceptor JVM acceptors} in the current JVM.
+ * 
  * @author Eike Stepper
  * @noextend This interface is not intended to be extended by clients.
  * @noimplement This interface is not intended to be implemented by clients.
diff --git a/plugins/org.eclipse.net4j.jvm/src/org/eclipse/net4j/jvm/IJVMConnector.java b/plugins/org.eclipse.net4j.jvm/src/org/eclipse/net4j/jvm/IJVMConnector.java
index cd7c154903..72515cb403 100644
--- a/plugins/org.eclipse.net4j.jvm/src/org/eclipse/net4j/jvm/IJVMConnector.java
+++ b/plugins/org.eclipse.net4j.jvm/src/org/eclipse/net4j/jvm/IJVMConnector.java
@@ -13,6 +13,8 @@ package org.eclipse.net4j.jvm;
 import org.eclipse.net4j.connector.IConnector;
 
 /**
+ * A {@link IConnector connector} that implements JVM-embedded transport.
+ * 
  * @author Eike Stepper
  * @noextend This interface is not intended to be extended by clients.
  * @noimplement This interface is not intended to be implemented by clients.
diff --git a/plugins/org.eclipse.net4j.jvm/src/org/eclipse/net4j/jvm/JVMUtil.java b/plugins/org.eclipse.net4j.jvm/src/org/eclipse/net4j/jvm/JVMUtil.java
index 8203d40cc7..a260741a82 100644
--- a/plugins/org.eclipse.net4j.jvm/src/org/eclipse/net4j/jvm/JVMUtil.java
+++ b/plugins/org.eclipse.net4j.jvm/src/org/eclipse/net4j/jvm/JVMUtil.java
@@ -15,6 +15,8 @@ import org.eclipse.net4j.internal.jvm.JVMConnectorFactory;
 import org.eclipse.net4j.util.container.IManagedContainer;
 
 /**
+ * A utility class with static convenience methods.
+ * 
  * @author Eike Stepper
  */
 public final class JVMUtil
diff --git a/plugins/org.eclipse.net4j.tcp/src/org/eclipse/net4j/tcp/ITCPAcceptor.java b/plugins/org.eclipse.net4j.tcp/src/org/eclipse/net4j/tcp/ITCPAcceptor.java
index 5ab1e5e135..f48941aabd 100644
--- a/plugins/org.eclipse.net4j.tcp/src/org/eclipse/net4j/tcp/ITCPAcceptor.java
+++ b/plugins/org.eclipse.net4j.tcp/src/org/eclipse/net4j/tcp/ITCPAcceptor.java
@@ -12,8 +12,12 @@ package org.eclipse.net4j.tcp;
 
 import org.eclipse.net4j.acceptor.IAcceptor;
 import org.eclipse.net4j.internal.tcp.bundle.OM;
+import org.eclipse.net4j.tcp.ssl.SSLUtil;
 
 /**
+ * An {@link IAcceptor acceptor} that implements non-blocking multiplexed TCP transport, optionally with {@link SSLUtil
+ * SSL}.
+ * 
  * @author Eike Stepper
  * @noextend This interface is not intended to be extended by clients.
  * @noimplement This interface is not intended to be implemented by clients.
diff --git a/plugins/org.eclipse.net4j.tcp/src/org/eclipse/net4j/tcp/ITCPActiveSelectorListener.java b/plugins/org.eclipse.net4j.tcp/src/org/eclipse/net4j/tcp/ITCPActiveSelectorListener.java
index e876cc4545..c095ad1e91 100644
--- a/plugins/org.eclipse.net4j.tcp/src/org/eclipse/net4j/tcp/ITCPActiveSelectorListener.java
+++ b/plugins/org.eclipse.net4j.tcp/src/org/eclipse/net4j/tcp/ITCPActiveSelectorListener.java
@@ -10,10 +10,17 @@
  */
 package org.eclipse.net4j.tcp;
 
+import org.eclipse.net4j.connector.IConnector;
+
 import java.nio.channels.SocketChannel;
 
 /**
+ * Call-back that handles the possible calls from a {@link ITCPSelector selector} to an active consumer, usually a
+ * {@link IConnector connector}.
+ * 
  * @author Eike Stepper
+ * @noimplement This interface is not intended to be implemented by clients.
+ * @noextend This interface is not intended to be extended by clients.
  */
 public interface ITCPActiveSelectorListener
 {
diff --git a/plugins/org.eclipse.net4j.tcp/src/org/eclipse/net4j/tcp/ITCPConnector.java b/plugins/org.eclipse.net4j.tcp/src/org/eclipse/net4j/tcp/ITCPConnector.java
index cc43f14550..b4608807cc 100644
--- a/plugins/org.eclipse.net4j.tcp/src/org/eclipse/net4j/tcp/ITCPConnector.java
+++ b/plugins/org.eclipse.net4j.tcp/src/org/eclipse/net4j/tcp/ITCPConnector.java
@@ -11,8 +11,12 @@
 package org.eclipse.net4j.tcp;
 
 import org.eclipse.net4j.connector.IConnector;
+import org.eclipse.net4j.tcp.ssl.SSLUtil;
 
 /**
+ * A {@link IConnector connector} that implements non-blocking multiplexed TCP transport, optionally with
+ * {@link SSLUtil SSL}.
+ * 
  * @author Eike Stepper
  * @noextend This interface is not intended to be extended by clients.
  * @noimplement This interface is not intended to be implemented by clients.
diff --git a/plugins/org.eclipse.net4j.tcp/src/org/eclipse/net4j/tcp/ITCPNegotiationContext.java b/plugins/org.eclipse.net4j.tcp/src/org/eclipse/net4j/tcp/ITCPNegotiationContext.java
index f55319fbc1..98f5a78601 100644
--- a/plugins/org.eclipse.net4j.tcp/src/org/eclipse/net4j/tcp/ITCPNegotiationContext.java
+++ b/plugins/org.eclipse.net4j.tcp/src/org/eclipse/net4j/tcp/ITCPNegotiationContext.java
@@ -13,6 +13,8 @@ package org.eclipse.net4j.tcp;
 import org.eclipse.net4j.util.security.INegotiationContext;
 
 /**
+ * A {@link INegotiationContext negotiation context} that is used in TCP transport.
+ * 
  * @author Eike Stepper
  * @since 2.0
  * @noextend This interface is not intended to be extended by clients.
diff --git a/plugins/org.eclipse.net4j.tcp/src/org/eclipse/net4j/tcp/ITCPPassiveSelectorListener.java b/plugins/org.eclipse.net4j.tcp/src/org/eclipse/net4j/tcp/ITCPPassiveSelectorListener.java
index e00eb4356c..fa5503f62e 100644
--- a/plugins/org.eclipse.net4j.tcp/src/org/eclipse/net4j/tcp/ITCPPassiveSelectorListener.java
+++ b/plugins/org.eclipse.net4j.tcp/src/org/eclipse/net4j/tcp/ITCPPassiveSelectorListener.java
@@ -10,11 +10,17 @@
  */
 package org.eclipse.net4j.tcp;
 
+import org.eclipse.net4j.acceptor.IAcceptor;
+
 import java.nio.channels.ServerSocketChannel;
 
 /**
+ * Call-back that handles the possible calls from a {@link ITCPSelector selector} to a passive consumer, usually an
+ * {@link IAcceptor acceptor}.
+ * 
  * @author Eike Stepper
  * @noimplement This interface is not intended to be implemented by clients.
+ * @noextend This interface is not intended to be extended by clients.
  */
 public interface ITCPPassiveSelectorListener
 {
diff --git a/plugins/org.eclipse.net4j.tcp/src/org/eclipse/net4j/tcp/ITCPSelector.java b/plugins/org.eclipse.net4j.tcp/src/org/eclipse/net4j/tcp/ITCPSelector.java
index 2ae923bbf0..0c5a87a257 100644
--- a/plugins/org.eclipse.net4j.tcp/src/org/eclipse/net4j/tcp/ITCPSelector.java
+++ b/plugins/org.eclipse.net4j.tcp/src/org/eclipse/net4j/tcp/ITCPSelector.java
@@ -10,12 +10,19 @@
  */
 package org.eclipse.net4j.tcp;
 
+import org.eclipse.net4j.acceptor.IAcceptor;
+import org.eclipse.net4j.connector.IConnector;
+
 import java.nio.channels.SelectionKey;
 import java.nio.channels.Selector;
 import java.nio.channels.ServerSocketChannel;
 import java.nio.channels.SocketChannel;
 
 /**
+ * Encapsulates a Java {@link Selector socket selector} and orchestrates a number of {@link ITCPPassiveSelectorListener
+ * active} and {@link ITCPPassiveSelectorListener passive} consumers, usually {@link IConnector connectors} and
+ * {@link IAcceptor acceptors} that compete for the socket selector's I/O time.
+ * 
  * @author Eike Stepper
  * @noextend This interface is not intended to be extended by clients.
  * @noimplement This interface is not intended to be implemented by clients.
diff --git a/plugins/org.eclipse.net4j.tcp/src/org/eclipse/net4j/tcp/TCPUtil.java b/plugins/org.eclipse.net4j.tcp/src/org/eclipse/net4j/tcp/TCPUtil.java
index 2fea97db36..6b445ce73a 100644
--- a/plugins/org.eclipse.net4j.tcp/src/org/eclipse/net4j/tcp/TCPUtil.java
+++ b/plugins/org.eclipse.net4j.tcp/src/org/eclipse/net4j/tcp/TCPUtil.java
@@ -17,6 +17,8 @@ import org.eclipse.net4j.internal.tcp.TCPSelectorInjector;
 import org.eclipse.net4j.util.container.IManagedContainer;
 
 /**
+ * A utility class with static convenience methods.
+ * 
  * @author Eike Stepper
  */
 public final class TCPUtil
diff --git a/plugins/org.eclipse.net4j.tcp/src/org/eclipse/net4j/tcp/ssl/SSLUtil.java b/plugins/org.eclipse.net4j.tcp/src/org/eclipse/net4j/tcp/ssl/SSLUtil.java
index a0790f1195..ebe1391987 100644
--- a/plugins/org.eclipse.net4j.tcp/src/org/eclipse/net4j/tcp/ssl/SSLUtil.java
+++ b/plugins/org.eclipse.net4j.tcp/src/org/eclipse/net4j/tcp/ssl/SSLUtil.java
@@ -40,6 +40,8 @@ import java.security.UnrecoverableKeyException;
 import java.security.cert.CertificateException;
 
 /**
+ * A utility class with various static factory and convenience methods for SSL transport.
+ * 
  * @author Teerawat Chaiyakijpichet (No Magic Asia Ltd.)
  * @author Caspar De Groot (No Magic Asia Ltd.)
  * @since 4.0