summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorEike Stepper2006-10-24 04:48:23 (EDT)
committerEike Stepper2006-10-24 04:48:23 (EDT)
commit107521df821d72413751bd6c98ceb71a8a60334b (patch)
treed86c56a2baa68c3f88be2f748e5d5d3e9af5731b
parent93059a438c016694152ffe12e89817d99330c766 (diff)
downloadcdo-107521df821d72413751bd6c98ceb71a8a60334b.zip
cdo-107521df821d72413751bd6c98ceb71a8a60334b.tar.gz
cdo-107521df821d72413751bd6c98ceb71a8a60334b.tar.bz2
Added package docs
-rw-r--r--plugins/org.eclipse.net4j/src/org/eclipse/net4j/message/package.html44
-rw-r--r--plugins/org.eclipse.net4j/src/org/eclipse/net4j/remote/package.html44
-rw-r--r--plugins/org.eclipse.net4j/src/org/eclipse/net4j/signal/package.html44
-rw-r--r--plugins/org.eclipse.net4j/src/org/eclipse/net4j/transport/package.html48
-rw-r--r--plugins/org.eclipse.net4j/src/org/eclipse/net4j/transport/tcp/package.html43
-rw-r--r--plugins/org.eclipse.net4j/src/org/eclipse/net4j/transport/util/package.html43
-rw-r--r--plugins/org.eclipse.net4j/src/org/eclipse/net4j/util/concurrent/package.html43
-rw-r--r--plugins/org.eclipse.net4j/src/org/eclipse/net4j/util/lifecycle/package.html45
-rw-r--r--plugins/org.eclipse.net4j/src/org/eclipse/net4j/util/package.html43
-rw-r--r--plugins/org.eclipse.net4j/src/org/eclipse/net4j/util/registry/package.html50
-rw-r--r--plugins/org.eclipse.net4j/src/org/eclipse/net4j/util/stream/package.html43
11 files changed, 490 insertions, 0 deletions
diff --git a/plugins/org.eclipse.net4j/src/org/eclipse/net4j/message/package.html b/plugins/org.eclipse.net4j/src/org/eclipse/net4j/message/package.html
new file mode 100644
index 0000000..6317e59
--- /dev/null
+++ b/plugins/org.eclipse.net4j/src/org/eclipse/net4j/message/package.html
@@ -0,0 +1,44 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
+<html>
+<head>
+<!--
+
+ Copyright (c) 2004, 2005, 2006 Eike Stepper, Germany.
+ All rights reserved. This program and the accompanying materials
+ are made available under the terms of the Eclipse Public License v1.0
+ which accompanies this distribution, and is available at
+ http://www.eclipse.org/legal/epl-v10.html
+
+ Contributors:
+ Eike Stepper - Initial API and implementation
+
+-->
+</head>
+<body bgcolor="white">
+
+A framework for publish/subscribe based communication on top of
+the Net4j transport layer.
+<p>
+
+<!--
+
+<h2>Package Specification</h2>
+
+##### FILL IN ANY SPECS NEEDED BY JAVA COMPATIBILITY KIT #####
+<ul>
+ <li><a href="">##### REFER TO ANY FRAMEMAKER SPECIFICATION HERE #####</a>
+</ul>
+
+<h2>Related Documentation</h2>
+
+For overviews, tutorials, examples, guides, and tool documentation, please see:
+<ul>
+ <li><a href="">##### REFER TO NON-SPEC DOCUMENTATION HERE #####</a>
+</ul>
+
+-->
+
+<!-- Put @see and @since tags down here. -->
+
+</body>
+</html>
diff --git a/plugins/org.eclipse.net4j/src/org/eclipse/net4j/remote/package.html b/plugins/org.eclipse.net4j/src/org/eclipse/net4j/remote/package.html
new file mode 100644
index 0000000..5931489
--- /dev/null
+++ b/plugins/org.eclipse.net4j/src/org/eclipse/net4j/remote/package.html
@@ -0,0 +1,44 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
+<html>
+<head>
+<!--
+
+ Copyright (c) 2004, 2005, 2006 Eike Stepper, Germany.
+ All rights reserved. This program and the accompanying materials
+ are made available under the terms of the Eclipse Public License v1.0
+ which accompanies this distribution, and is available at
+ http://www.eclipse.org/legal/epl-v10.html
+
+ Contributors:
+ Eike Stepper - Initial API and implementation
+
+-->
+</head>
+<body bgcolor="white">
+
+A framework for exporting and importing services on top of
+the Net4j transport layer.
+<p>
+
+<!--
+
+<h2>Package Specification</h2>
+
+##### FILL IN ANY SPECS NEEDED BY JAVA COMPATIBILITY KIT #####
+<ul>
+ <li><a href="">##### REFER TO ANY FRAMEMAKER SPECIFICATION HERE #####</a>
+</ul>
+
+<h2>Related Documentation</h2>
+
+For overviews, tutorials, examples, guides, and tool documentation, please see:
+<ul>
+ <li><a href="">##### REFER TO NON-SPEC DOCUMENTATION HERE #####</a>
+</ul>
+
+-->
+
+<!-- Put @see and @since tags down here. -->
+
+</body>
+</html>
diff --git a/plugins/org.eclipse.net4j/src/org/eclipse/net4j/signal/package.html b/plugins/org.eclipse.net4j/src/org/eclipse/net4j/signal/package.html
new file mode 100644
index 0000000..671fb2d
--- /dev/null
+++ b/plugins/org.eclipse.net4j/src/org/eclipse/net4j/signal/package.html
@@ -0,0 +1,44 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
+<html>
+<head>
+<!--
+
+ Copyright (c) 2004, 2005, 2006 Eike Stepper, Germany.
+ All rights reserved. This program and the accompanying materials
+ are made available under the terms of the Eclipse Public License v1.0
+ which accompanies this distribution, and is available at
+ http://www.eclipse.org/legal/epl-v10.html
+
+ Contributors:
+ Eike Stepper - Initial API and implementation
+
+-->
+</head>
+<body bgcolor="white">
+
+A framework for request/response based communication on top of
+the Net4j transport layer.
+<p>
+
+<!--
+
+<h2>Package Specification</h2>
+
+##### FILL IN ANY SPECS NEEDED BY JAVA COMPATIBILITY KIT #####
+<ul>
+ <li><a href="">##### REFER TO ANY FRAMEMAKER SPECIFICATION HERE #####</a>
+</ul>
+
+<h2>Related Documentation</h2>
+
+For overviews, tutorials, examples, guides, and tool documentation, please see:
+<ul>
+ <li><a href="">##### REFER TO NON-SPEC DOCUMENTATION HERE #####</a>
+</ul>
+
+-->
+
+<!-- Put @see and @since tags down here. -->
+
+</body>
+</html>
diff --git a/plugins/org.eclipse.net4j/src/org/eclipse/net4j/transport/package.html b/plugins/org.eclipse.net4j/src/org/eclipse/net4j/transport/package.html
new file mode 100644
index 0000000..710815a
--- /dev/null
+++ b/plugins/org.eclipse.net4j/src/org/eclipse/net4j/transport/package.html
@@ -0,0 +1,48 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
+<html>
+<head>
+<!--
+
+ Copyright (c) 2004, 2005, 2006 Eike Stepper, Germany.
+ All rights reserved. This program and the accompanying materials
+ are made available under the terms of the Eclipse Public License v1.0
+ which accompanies this distribution, and is available at
+ http://www.eclipse.org/legal/epl-v10.html
+
+ Contributors:
+ Eike Stepper - Initial API and implementation
+
+-->
+</head>
+<body bgcolor="white">
+
+The transport layer of the Net4j API.
+The four main interfaces of the transport layer are
+{@link org.eclipse.net4j.transport.Buffer},
+{@link org.eclipse.net4j.transport.Channel},
+{@link org.eclipse.net4j.transport.Connector} and
+{@link org.eclipse.net4j.transport.Protocol}.
+<p>
+
+<!--
+
+<h2>Package Specification</h2>
+
+##### FILL IN ANY SPECS NEEDED BY JAVA COMPATIBILITY KIT #####
+<ul>
+ <li><a href="">##### REFER TO ANY FRAMEMAKER SPECIFICATION HERE #####</a>
+</ul>
+
+<h2>Related Documentation</h2>
+
+For overviews, tutorials, examples, guides, and tool documentation, please see:
+<ul>
+ <li><a href="">##### REFER TO NON-SPEC DOCUMENTATION HERE #####</a>
+</ul>
+
+-->
+
+<!-- Put @see and @since tags down here. -->
+
+</body>
+</html>
diff --git a/plugins/org.eclipse.net4j/src/org/eclipse/net4j/transport/tcp/package.html b/plugins/org.eclipse.net4j/src/org/eclipse/net4j/transport/tcp/package.html
new file mode 100644
index 0000000..540d8b7
--- /dev/null
+++ b/plugins/org.eclipse.net4j/src/org/eclipse/net4j/transport/tcp/package.html
@@ -0,0 +1,43 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
+<html>
+<head>
+<!--
+
+ Copyright (c) 2004, 2005, 2006 Eike Stepper, Germany.
+ All rights reserved. This program and the accompanying materials
+ are made available under the terms of the Eclipse Public License v1.0
+ which accompanies this distribution, and is available at
+ http://www.eclipse.org/legal/epl-v10.html
+
+ Contributors:
+ Eike Stepper - Initial API and implementation
+
+-->
+</head>
+<body bgcolor="white">
+
+Interfaces for the transport layer specialized for TCP socket connections.
+<p>
+
+<!--
+
+<h2>Package Specification</h2>
+
+##### FILL IN ANY SPECS NEEDED BY JAVA COMPATIBILITY KIT #####
+<ul>
+ <li><a href="">##### REFER TO ANY FRAMEMAKER SPECIFICATION HERE #####</a>
+</ul>
+
+<h2>Related Documentation</h2>
+
+For overviews, tutorials, examples, guides, and tool documentation, please see:
+<ul>
+ <li><a href="">##### REFER TO NON-SPEC DOCUMENTATION HERE #####</a>
+</ul>
+
+-->
+
+<!-- Put @see and @since tags down here. -->
+
+</body>
+</html>
diff --git a/plugins/org.eclipse.net4j/src/org/eclipse/net4j/transport/util/package.html b/plugins/org.eclipse.net4j/src/org/eclipse/net4j/transport/util/package.html
new file mode 100644
index 0000000..6fc006e
--- /dev/null
+++ b/plugins/org.eclipse.net4j/src/org/eclipse/net4j/transport/util/package.html
@@ -0,0 +1,43 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
+<html>
+<head>
+<!--
+
+ Copyright (c) 2004, 2005, 2006 Eike Stepper, Germany.
+ All rights reserved. This program and the accompanying materials
+ are made available under the terms of the Eclipse Public License v1.0
+ which accompanies this distribution, and is available at
+ http://www.eclipse.org/legal/epl-v10.html
+
+ Contributors:
+ Eike Stepper - Initial API and implementation
+
+-->
+</head>
+<body bgcolor="white">
+
+Stream classes for the transport layer.
+<p>
+
+<!--
+
+<h2>Package Specification</h2>
+
+##### FILL IN ANY SPECS NEEDED BY JAVA COMPATIBILITY KIT #####
+<ul>
+ <li><a href="">##### REFER TO ANY FRAMEMAKER SPECIFICATION HERE #####</a>
+</ul>
+
+<h2>Related Documentation</h2>
+
+For overviews, tutorials, examples, guides, and tool documentation, please see:
+<ul>
+ <li><a href="">##### REFER TO NON-SPEC DOCUMENTATION HERE #####</a>
+</ul>
+
+-->
+
+<!-- Put @see and @since tags down here. -->
+
+</body>
+</html>
diff --git a/plugins/org.eclipse.net4j/src/org/eclipse/net4j/util/concurrent/package.html b/plugins/org.eclipse.net4j/src/org/eclipse/net4j/util/concurrent/package.html
new file mode 100644
index 0000000..df23882
--- /dev/null
+++ b/plugins/org.eclipse.net4j/src/org/eclipse/net4j/util/concurrent/package.html
@@ -0,0 +1,43 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
+<html>
+<head>
+<!--
+
+ Copyright (c) 2004, 2005, 2006 Eike Stepper, Germany.
+ All rights reserved. This program and the accompanying materials
+ are made available under the terms of the Eclipse Public License v1.0
+ which accompanies this distribution, and is available at
+ http://www.eclipse.org/legal/epl-v10.html
+
+ Contributors:
+ Eike Stepper - Initial API and implementation
+
+-->
+</head>
+<body bgcolor="white">
+
+Utility interfaces and classes commonly useful in concurrent programming.
+<p>
+
+<!--
+
+<h2>Package Specification</h2>
+
+##### FILL IN ANY SPECS NEEDED BY JAVA COMPATIBILITY KIT #####
+<ul>
+ <li><a href="">##### REFER TO ANY FRAMEMAKER SPECIFICATION HERE #####</a>
+</ul>
+
+<h2>Related Documentation</h2>
+
+For overviews, tutorials, examples, guides, and tool documentation, please see:
+<ul>
+ <li><a href="">##### REFER TO NON-SPEC DOCUMENTATION HERE #####</a>
+</ul>
+
+-->
+
+<!-- Put @see and @since tags down here. -->
+
+</body>
+</html>
diff --git a/plugins/org.eclipse.net4j/src/org/eclipse/net4j/util/lifecycle/package.html b/plugins/org.eclipse.net4j/src/org/eclipse/net4j/util/lifecycle/package.html
new file mode 100644
index 0000000..2debae6
--- /dev/null
+++ b/plugins/org.eclipse.net4j/src/org/eclipse/net4j/util/lifecycle/package.html
@@ -0,0 +1,45 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
+<html>
+<head>
+<!--
+
+ Copyright (c) 2004, 2005, 2006 Eike Stepper, Germany.
+ All rights reserved. This program and the accompanying materials
+ are made available under the terms of the Eclipse Public License v1.0
+ which accompanies this distribution, and is available at
+ http://www.eclipse.org/legal/epl-v10.html
+
+ Contributors:
+ Eike Stepper - Initial API and implementation
+
+-->
+</head>
+<body bgcolor="white">
+
+Interfaces that describe the behaviour of objects with respect to their lifecycle.
+A utility class to interact with such objects and an abstract class that can be
+used to implement such objects are provided as well.
+<p>
+
+<!--
+
+<h2>Package Specification</h2>
+
+##### FILL IN ANY SPECS NEEDED BY JAVA COMPATIBILITY KIT #####
+<ul>
+ <li><a href="">##### REFER TO ANY FRAMEMAKER SPECIFICATION HERE #####</a>
+</ul>
+
+<h2>Related Documentation</h2>
+
+For overviews, tutorials, examples, guides, and tool documentation, please see:
+<ul>
+ <li><a href="">##### REFER TO NON-SPEC DOCUMENTATION HERE #####</a>
+</ul>
+
+-->
+
+<!-- Put @see and @since tags down here. -->
+
+</body>
+</html>
diff --git a/plugins/org.eclipse.net4j/src/org/eclipse/net4j/util/package.html b/plugins/org.eclipse.net4j/src/org/eclipse/net4j/util/package.html
new file mode 100644
index 0000000..0e89bc3
--- /dev/null
+++ b/plugins/org.eclipse.net4j/src/org/eclipse/net4j/util/package.html
@@ -0,0 +1,43 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
+<html>
+<head>
+<!--
+
+ Copyright (c) 2004, 2005, 2006 Eike Stepper, Germany.
+ All rights reserved. This program and the accompanying materials
+ are made available under the terms of the Eclipse Public License v1.0
+ which accompanies this distribution, and is available at
+ http://www.eclipse.org/legal/epl-v10.html
+
+ Contributors:
+ Eike Stepper - Initial API and implementation
+
+-->
+</head>
+<body bgcolor="white">
+
+Utility classes.
+<p>
+
+<!--
+
+<h2>Package Specification</h2>
+
+##### FILL IN ANY SPECS NEEDED BY JAVA COMPATIBILITY KIT #####
+<ul>
+ <li><a href="">##### REFER TO ANY FRAMEMAKER SPECIFICATION HERE #####</a>
+</ul>
+
+<h2>Related Documentation</h2>
+
+For overviews, tutorials, examples, guides, and tool documentation, please see:
+<ul>
+ <li><a href="">##### REFER TO NON-SPEC DOCUMENTATION HERE #####</a>
+</ul>
+
+-->
+
+<!-- Put @see and @since tags down here. -->
+
+</body>
+</html>
diff --git a/plugins/org.eclipse.net4j/src/org/eclipse/net4j/util/registry/package.html b/plugins/org.eclipse.net4j/src/org/eclipse/net4j/util/registry/package.html
new file mode 100644
index 0000000..b596cc3
--- /dev/null
+++ b/plugins/org.eclipse.net4j/src/org/eclipse/net4j/util/registry/package.html
@@ -0,0 +1,50 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
+<html>
+<head>
+<!--
+
+ Copyright (c) 2004, 2005, 2006 Eike Stepper, Germany.
+ All rights reserved. This program and the accompanying materials
+ are made available under the terms of the Eclipse Public License v1.0
+ which accompanies this distribution, and is available at
+ http://www.eclipse.org/legal/epl-v10.html
+
+ Contributors:
+ Eike Stepper - Initial API and implementation
+
+-->
+</head>
+<body bgcolor="white">
+
+Interfaces and classes for general purpose registries.
+A registry is like a <code>Map</code> but has some additional features:
+<ul>
+ <li>It provides a descriptor framework for registry elements that
+ are to be instantiated lazily
+ <li>It provides a notification framework that enables clients to
+ react on events (including the resolution of a lazy descriptor)
+<ul>
+<p>
+
+<!--
+
+<h2>Package Specification</h2>
+
+##### FILL IN ANY SPECS NEEDED BY JAVA COMPATIBILITY KIT #####
+<ul>
+ <li><a href="">##### REFER TO ANY FRAMEMAKER SPECIFICATION HERE #####</a>
+</ul>
+
+<h2>Related Documentation</h2>
+
+For overviews, tutorials, examples, guides, and tool documentation, please see:
+<ul>
+ <li><a href="">##### REFER TO NON-SPEC DOCUMENTATION HERE #####</a>
+</ul>
+
+-->
+
+<!-- Put @see and @since tags down here. -->
+
+</body>
+</html>
diff --git a/plugins/org.eclipse.net4j/src/org/eclipse/net4j/util/stream/package.html b/plugins/org.eclipse.net4j/src/org/eclipse/net4j/util/stream/package.html
new file mode 100644
index 0000000..da3a70c
--- /dev/null
+++ b/plugins/org.eclipse.net4j/src/org/eclipse/net4j/util/stream/package.html
@@ -0,0 +1,43 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
+<html>
+<head>
+<!--
+
+ Copyright (c) 2004, 2005, 2006 Eike Stepper, Germany.
+ All rights reserved. This program and the accompanying materials
+ are made available under the terms of the Eclipse Public License v1.0
+ which accompanies this distribution, and is available at
+ http://www.eclipse.org/legal/epl-v10.html
+
+ Contributors:
+ Eike Stepper - Initial API and implementation
+
+-->
+</head>
+<body bgcolor="white">
+
+Interfaces and classes for data I/O.
+<p>
+
+<!--
+
+<h2>Package Specification</h2>
+
+##### FILL IN ANY SPECS NEEDED BY JAVA COMPATIBILITY KIT #####
+<ul>
+ <li><a href="">##### REFER TO ANY FRAMEMAKER SPECIFICATION HERE #####</a>
+</ul>
+
+<h2>Related Documentation</h2>
+
+For overviews, tutorials, examples, guides, and tool documentation, please see:
+<ul>
+ <li><a href="">##### REFER TO NON-SPEC DOCUMENTATION HERE #####</a>
+</ul>
+
+-->
+
+<!-- Put @see and @since tags down here. -->
+
+</body>
+</html>