summaryrefslogtreecommitdiff
path: root/src/main/java/com/c2kernel/entity/package-info.java
diff options
context:
space:
mode:
authorAndrew Branson <andrew.branson@cern.ch>2014-09-26 16:02:24 +0200
committerAndrew Branson <andrew.branson@cern.ch>2014-09-26 16:02:24 +0200
commit202041b7fb62b1075d23b2e6ab8a5366d71f1766 (patch)
tree88d1cd94f4e79f9298b66826ed078e5057cfb6ca /src/main/java/com/c2kernel/entity/package-info.java
parent6af4879ac29414287b0dc6b9150ab93c5cb78809 (diff)
Package documentation for collection, entity, entity.agent and
entity.transfer packages
Diffstat (limited to 'src/main/java/com/c2kernel/entity/package-info.java')
-rw-r--r--src/main/java/com/c2kernel/entity/package-info.java19
1 files changed, 19 insertions, 0 deletions
diff --git a/src/main/java/com/c2kernel/entity/package-info.java b/src/main/java/com/c2kernel/entity/package-info.java
new file mode 100644
index 0000000..cf7bafb
--- /dev/null
+++ b/src/main/java/com/c2kernel/entity/package-info.java
@@ -0,0 +1,19 @@
+/**
+ * The implementations of Items, and their core functionality.
+ *
+ * <p>The CORBA IDLs generate the Item and Agent interfaces and their support
+ * classes in this package. In the kernel source tree, the classes
+ * {@link TraceableEntity} and {@link ItemImplementation} provides the
+ * implementing object for the Item on the server side, while the Locator class,
+ * plus the {@link CorbaServer} handle instantiation and caching of Items (and
+ * Agents) on the server.
+ *
+ * <p>The corresponding implementation for Agents is located in the agent
+ * sub-package.
+ *
+ * <p>Also in this package is the {@link C2KLocalObject} interface, which is
+ * implemented by all objects that may be stored in the CRISTAL persistency
+ * mechanism.
+ */
+
+package com.c2kernel.entity; \ No newline at end of file