added javadoc

9 files changed, 47 insertions, 3 deletions

diff --git a/plugins/org.eclipse.net4j.util/src/org/eclipse/net4j/util/lifecycle/ILifecycle.java b/plugins/org.eclipse.net4j.util/src/org/eclipse/net4j/util/lifecycle/ILifecycle.java
index 26c69f89a2..6434a428ed 100644
--- a/plugins/org.eclipse.net4j.util/src/org/eclipse/net4j/util/lifecycle/ILifecycle.java
+++ b/plugins/org.eclipse.net4j.util/src/org/eclipse/net4j/util/lifecycle/ILifecycle.java
@@ -13,7 +13,19 @@ package org.eclipse.net4j.util.lifecycle;
 import org.eclipse.net4j.util.event.INotifier;
 
 /**
+ * An entity that has a well-defined {@link #getLifecycleState() lifecycle} and can be {@link #activate() activated} or
+ * {@link #deactivate() deactivated}.
+ * <p>
+ * Fires the following events:
+ * <ul>
+ * <li> {@link ILifecycleEvent} before and after the {@link #getLifecycleState() state} of this lifecycle changes.
+ * </ul>
+ * 
  * @author Eike Stepper
+ * @apiviz.landmark
+ * @apiviz.has LifecycleState
+ * @apiviz.uses ILifecycleEvent - - fires
+ * @apiviz.excludeSubtypes
  */
 public interface ILifecycle extends INotifier
 {
diff --git a/plugins/org.eclipse.net4j.util/src/org/eclipse/net4j/util/lifecycle/ILifecycleEvent.java b/plugins/org.eclipse.net4j.util/src/org/eclipse/net4j/util/lifecycle/ILifecycleEvent.java
index 561e6fb02d..3b9ed7248e 100644
--- a/plugins/org.eclipse.net4j.util/src/org/eclipse/net4j/util/lifecycle/ILifecycleEvent.java
+++ b/plugins/org.eclipse.net4j.util/src/org/eclipse/net4j/util/lifecycle/ILifecycleEvent.java
@@ -13,12 +13,14 @@ package org.eclipse.net4j.util.lifecycle;
 import org.eclipse.net4j.util.event.IEvent;
 
 /**
- * An {@link IEvent event} fired from an object with a {@link ILifecycle lifecycle} when its lifecycle {@link Kind
+ * An {@link IEvent event} fired from an entity with a {@link ILifecycle lifecycle} when its lifecycle {@link Kind
  * state} has changed.
  * 
  * @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.
+ * @noimplement Thi import org.eclipse.net4j.util.event.IEvent; import org.eclipse.net4j.util.event.IEvent; import
+ *              org.eclipse.net4j.util.event.IEvent; s interface is not intended to be implemented by clients.
+ * @apiviz.has org.eclipse.net4j.util.lifecycle.ILifecycleEvent.Kind
  */
 public interface ILifecycleEvent extends IEvent
 {
@@ -30,7 +32,7 @@ public interface ILifecycleEvent extends IEvent
   public Kind getKind();
 
   /**
-   * Enumerates the possible {@link ILifecycle#getLifecycleState() lifecycle state} changes of an object.
+   * Enumerates the possible {@link ILifecycle#getLifecycleState() lifecycle state} changes of an entity.
    * 
    * @author Eike Stepper
    */
diff --git a/plugins/org.eclipse.net4j.util/src/org/eclipse/net4j/util/lifecycle/Lifecycle.java b/plugins/org.eclipse.net4j.util/src/org/eclipse/net4j/util/lifecycle/Lifecycle.java
index 4cde6c2b2d..dd448d04be 100644
--- a/plugins/org.eclipse.net4j.util/src/org/eclipse/net4j/util/lifecycle/Lifecycle.java
+++ b/plugins/org.eclipse.net4j.util/src/org/eclipse/net4j/util/lifecycle/Lifecycle.java
@@ -21,7 +21,10 @@ import org.eclipse.net4j.util.om.trace.ContextTracer;
 import java.util.concurrent.Semaphore;
 
 /**
+ * A default implementation of an entity with a {@link ILifecycle lifecycle}.
+ * 
  * @author Eike Stepper
+ * @apiviz.exclude
  */
 public class Lifecycle extends Notifier implements ILifecycle
 {
diff --git a/plugins/org.eclipse.net4j.util/src/org/eclipse/net4j/util/lifecycle/LifecycleEvent.java b/plugins/org.eclipse.net4j.util/src/org/eclipse/net4j/util/lifecycle/LifecycleEvent.java
index ac734494d6..95b4fcd8af 100644
--- a/plugins/org.eclipse.net4j.util/src/org/eclipse/net4j/util/lifecycle/LifecycleEvent.java
+++ b/plugins/org.eclipse.net4j.util/src/org/eclipse/net4j/util/lifecycle/LifecycleEvent.java
@@ -13,8 +13,11 @@ package org.eclipse.net4j.util.lifecycle;
 import org.eclipse.net4j.util.event.Event;
 
 /**
+ * A default implementation of a lifecycle {@link ILifecycleEvent event}.
+ * 
  * @author Eike Stepper
  * @noextend This class is not intended to be subclassed by clients.
+ * @apiviz.exclude
  */
 public class LifecycleEvent extends Event implements ILifecycleEvent
 {
diff --git a/plugins/org.eclipse.net4j.util/src/org/eclipse/net4j/util/lifecycle/LifecycleEventAdapter.java b/plugins/org.eclipse.net4j.util/src/org/eclipse/net4j/util/lifecycle/LifecycleEventAdapter.java
index ce5ccf371a..2ddf398f94 100644
--- a/plugins/org.eclipse.net4j.util/src/org/eclipse/net4j/util/lifecycle/LifecycleEventAdapter.java
+++ b/plugins/org.eclipse.net4j.util/src/org/eclipse/net4j/util/lifecycle/LifecycleEventAdapter.java
@@ -14,7 +14,11 @@ import org.eclipse.net4j.util.event.IEvent;
 import org.eclipse.net4j.util.event.IListener;
 
 /**
+ * A {@link IListener listener} that dispatches lifecycle {@link ILifecycleEvent events} to methods that can be
+ * overridden by extenders.
+ * 
  * @author Eike Stepper
+ * @apiviz.exclude
  */
 public class LifecycleEventAdapter implements IListener
 {
diff --git a/plugins/org.eclipse.net4j.util/src/org/eclipse/net4j/util/lifecycle/LifecycleException.java b/plugins/org.eclipse.net4j.util/src/org/eclipse/net4j/util/lifecycle/LifecycleException.java
index bbe4da822c..2a3f2d5934 100644
--- a/plugins/org.eclipse.net4j.util/src/org/eclipse/net4j/util/lifecycle/LifecycleException.java
+++ b/plugins/org.eclipse.net4j.util/src/org/eclipse/net4j/util/lifecycle/LifecycleException.java
@@ -11,8 +11,11 @@
 package org.eclipse.net4j.util.lifecycle;
 
 /**
+ * An unchecked wrapper exception for checked exceptions being thrown from {@link Lifecycle#doActivate()}.
+ * 
  * @author Eike Stepper
  * @noextend This class is not intended to be subclassed by clients.
+ * @apiviz.exclude
  */
 public class LifecycleException extends RuntimeException
 {
diff --git a/plugins/org.eclipse.net4j.util/src/org/eclipse/net4j/util/lifecycle/LifecycleState.java b/plugins/org.eclipse.net4j.util/src/org/eclipse/net4j/util/lifecycle/LifecycleState.java
index 3079b4ddbb..e420cef14f 100644
--- a/plugins/org.eclipse.net4j.util/src/org/eclipse/net4j/util/lifecycle/LifecycleState.java
+++ b/plugins/org.eclipse.net4j.util/src/org/eclipse/net4j/util/lifecycle/LifecycleState.java
@@ -11,6 +11,8 @@
 package org.eclipse.net4j.util.lifecycle;
 
 /**
+ * Enumerates the possible lifecycle states of an entity with a {@link ILifecycle lifecycle}.
+ * 
  * @author Eike Stepper
  * @since 3.0
  */
diff --git a/plugins/org.eclipse.net4j.util/src/org/eclipse/net4j/util/lifecycle/LifecycleUtil.java b/plugins/org.eclipse.net4j.util/src/org/eclipse/net4j/util/lifecycle/LifecycleUtil.java
index f15d4b382c..79a3fb13c3 100644
--- a/plugins/org.eclipse.net4j.util/src/org/eclipse/net4j/util/lifecycle/LifecycleUtil.java
+++ b/plugins/org.eclipse.net4j.util/src/org/eclipse/net4j/util/lifecycle/LifecycleUtil.java
@@ -29,6 +29,8 @@ import java.util.concurrent.CountDownLatch;
 import java.util.concurrent.TimeUnit;
 
 /**
+ * Various static helper methods for dealing with {@link ILifecycle lifecycles}.
+ * 
  * @author Eike Stepper
  */
 public final class LifecycleUtil
@@ -321,7 +323,11 @@ public final class LifecycleUtil
   }
 
   /**
+   * Annotates a method of a POJO class that's supposed to be called to <em>activate</em> a POJO object during
+   * {@link LifecycleUtil#activate(Object)}.
+   * 
    * @author Eike Stepper
+   * @apiviz.exclude
    */
   @Retention(RetentionPolicy.RUNTIME)
   @Target(ElementType.METHOD)
@@ -331,7 +337,11 @@ public final class LifecycleUtil
   }
 
   /**
+   * Annotates a method of a POJO class that's supposed to be called to <em>deactivate</em> a POJO object during
+   * {@link LifecycleUtil#deactivate(Object)}.
+   * 
    * @author Eike Stepper
+   * @apiviz.exclude
    */
   @Retention(RetentionPolicy.RUNTIME)
   @Target(ElementType.METHOD)
@@ -341,8 +351,12 @@ public final class LifecycleUtil
   }
 
   /**
+   * The {@link InvocationHandler invocation handler} of the {@link Proxy dynamic proxy} created in
+   * {@link LifecycleUtil#delegateLifecycle(ClassLoader, Object, ILifecycle) LifecycleUtil.delegateLifecycle()}.
+   * 
    * @author Eike Stepper
    * @since 2.0
+   * @apiviz.exclude
    */
   public static final class Delegator<T> implements InvocationHandler
   {
diff --git a/plugins/org.eclipse.net4j.util/src/org/eclipse/net4j/util/lifecycle/package-info.java b/plugins/org.eclipse.net4j.util/src/org/eclipse/net4j/util/lifecycle/package-info.java
index b2aa771c09..6ecf268ca9 100644
--- a/plugins/org.eclipse.net4j.util/src/org/eclipse/net4j/util/lifecycle/package-info.java
+++ b/plugins/org.eclipse.net4j.util/src/org/eclipse/net4j/util/lifecycle/package-info.java
@@ -16,3 +16,4 @@
  * used to implement such objects are provided as well.

  */

 package org.eclipse.net4j.util.lifecycle;

+