From 422a753ac6589ed775ad7ea003f288a7584971c6 Mon Sep 17 00:00:00 2001
From: Sebastian Sdorra <sebastian.sdorra@cloudogu.com>
Date: Sat, 8 Dec 2012 14:47:48 +0100
Subject: [PATCH] improve javadoc and implement toString method

---
 .../main/java/sonia/scm/group/GroupEvent.java | 35 +++++++++++++++----
 .../main/java/sonia/scm/user/UserEvent.java   | 16 ++++-----
 2 files changed, 36 insertions(+), 15 deletions(-)

diff --git a/scm-core/src/main/java/sonia/scm/group/GroupEvent.java b/scm-core/src/main/java/sonia/scm/group/GroupEvent.java
index 0a8f5fdfb3..e2bf3fb6ac 100644
--- a/scm-core/src/main/java/sonia/scm/group/GroupEvent.java
+++ b/scm-core/src/main/java/sonia/scm/group/GroupEvent.java
@@ -33,6 +33,8 @@ package sonia.scm.group;
 
 //~--- non-JDK imports --------------------------------------------------------
 
+import com.google.common.base.Objects;
+
 import sonia.scm.HandlerEvent;
 import sonia.scm.event.HandlerEventBase;
 
@@ -46,11 +48,11 @@ public final class GroupEvent implements HandlerEventBase<Group>
 {
 
   /**
-   * Constructs ...
+   * Constructs new group event
    *
    *
-   * @param group
-   * @param eventType
+   * @param group changed group
+   * @param eventType type of the event
    */
   public GroupEvent(Group group, HandlerEvent eventType)
   {
@@ -58,10 +60,29 @@ public final class GroupEvent implements HandlerEventBase<Group>
     this.eventType = eventType;
   }
 
+  //~--- methods --------------------------------------------------------------
+
+  /**
+   * {@inheritDoc}
+   *
+   *
+   * @return
+   */
+  @Override
+  public String toString()
+  {
+    //J-
+    return Objects.toStringHelper(this)
+                  .add("eventType", eventType)
+                  .add("group", group)
+                  .toString();
+    //J+
+  }
+
   //~--- get methods ----------------------------------------------------------
 
   /**
-   * Method description
+   * {@inheritDoc}
    *
    *
    * @return
@@ -73,7 +94,7 @@ public final class GroupEvent implements HandlerEventBase<Group>
   }
 
   /**
-   * Method description
+   * {@inheritDoc}
    *
    *
    * @return
@@ -86,9 +107,9 @@ public final class GroupEvent implements HandlerEventBase<Group>
 
   //~--- fields ---------------------------------------------------------------
 
-  /** Field description */
+  /** event type */
   private HandlerEvent eventType;
 
-  /** Field description */
+  /** changed group */
   private Group group;
 }
diff --git a/scm-core/src/main/java/sonia/scm/user/UserEvent.java b/scm-core/src/main/java/sonia/scm/user/UserEvent.java
index a536765e3a..25f44ab69d 100644
--- a/scm-core/src/main/java/sonia/scm/user/UserEvent.java
+++ b/scm-core/src/main/java/sonia/scm/user/UserEvent.java
@@ -48,11 +48,11 @@ public final class UserEvent implements HandlerEventBase<User>
 {
 
   /**
-   * Constructs ...
+   * Constructs new UserEvent.
    *
    *
-   * @param user
-   * @param eventType
+   * @param user changed user
+   * @param eventType type of the event
    */
   public UserEvent(User user, HandlerEvent eventType)
   {
@@ -63,7 +63,7 @@ public final class UserEvent implements HandlerEventBase<User>
   //~--- methods --------------------------------------------------------------
 
   /**
-   * Method description
+   * {@inheritDoc}
    *
    *
    * @return
@@ -82,7 +82,7 @@ public final class UserEvent implements HandlerEventBase<User>
   //~--- get methods ----------------------------------------------------------
 
   /**
-   * Method description
+   * {@inheritDoc}
    *
    *
    * @return
@@ -94,7 +94,7 @@ public final class UserEvent implements HandlerEventBase<User>
   }
 
   /**
-   * Method description
+   * {@inheritDoc}
    *
    *
    * @return
@@ -107,9 +107,9 @@ public final class UserEvent implements HandlerEventBase<User>
 
   //~--- fields ---------------------------------------------------------------
 
-  /** Field description */
+  /** type of the event */
   private HandlerEvent eventType;
 
-  /** Field description */
+  /** changed user */
   private User user;
 }