From c4c2a3435c710554d6dbd57dec80dffc7deb7ef6 Mon Sep 17 00:00:00 2001
From: Pierre-Yves Monnet <pierre-yves.monnet@laposte.net>
Date: Thu, 14 Mar 2019 11:46:31 -0700
Subject: [PATCH] Add some getInstance() to create direct BonitaEvent

---
 .gitignore                                    |  1 +
 .project                                      | 23 +++++++++++++++
 .settings/org.eclipse.jdt.core.prefs          | 12 ++++++++
 .settings/org.eclipse.m2e.core.prefs          |  4 +++
 pom.xml                                       |  2 +-
 .../java/org/bonitasoft/log/event/BEvent.java | 28 +++++++++++++++++--
 6 files changed, 66 insertions(+), 4 deletions(-)
 create mode 100644 .gitignore
 create mode 100644 .project
 create mode 100644 .settings/org.eclipse.jdt.core.prefs
 create mode 100644 .settings/org.eclipse.m2e.core.prefs

diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..b83d222
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1 @@
+/target/
diff --git a/.project b/.project
new file mode 100644
index 0000000..2e92667
--- /dev/null
+++ b/.project
@@ -0,0 +1,23 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<projectDescription>
+	<name>BonitaEvent</name>
+	<comment></comment>
+	<projects>
+	</projects>
+	<buildSpec>
+		<buildCommand>
+			<name>org.eclipse.jdt.core.javabuilder</name>
+			<arguments>
+			</arguments>
+		</buildCommand>
+		<buildCommand>
+			<name>org.eclipse.m2e.core.maven2Builder</name>
+			<arguments>
+			</arguments>
+		</buildCommand>
+	</buildSpec>
+	<natures>
+		<nature>org.eclipse.jdt.core.javanature</nature>
+		<nature>org.eclipse.m2e.core.maven2Nature</nature>
+	</natures>
+</projectDescription>
diff --git a/.settings/org.eclipse.jdt.core.prefs b/.settings/org.eclipse.jdt.core.prefs
new file mode 100644
index 0000000..8e4055a
--- /dev/null
+++ b/.settings/org.eclipse.jdt.core.prefs
@@ -0,0 +1,12 @@
+eclipse.preferences.version=1
+org.eclipse.jdt.core.compiler.codegen.inlineJsrBytecode=enabled
+org.eclipse.jdt.core.compiler.codegen.targetPlatform=1.5
+org.eclipse.jdt.core.compiler.codegen.unusedLocal=preserve
+org.eclipse.jdt.core.compiler.compliance=1.5
+org.eclipse.jdt.core.compiler.debug.lineNumber=generate
+org.eclipse.jdt.core.compiler.debug.localVariable=generate
+org.eclipse.jdt.core.compiler.debug.sourceFile=generate
+org.eclipse.jdt.core.compiler.problem.assertIdentifier=error
+org.eclipse.jdt.core.compiler.problem.enumIdentifier=error
+org.eclipse.jdt.core.compiler.problem.forbiddenReference=warning
+org.eclipse.jdt.core.compiler.source=1.5
diff --git a/.settings/org.eclipse.m2e.core.prefs b/.settings/org.eclipse.m2e.core.prefs
new file mode 100644
index 0000000..f897a7f
--- /dev/null
+++ b/.settings/org.eclipse.m2e.core.prefs
@@ -0,0 +1,4 @@
+activeProfiles=
+eclipse.preferences.version=1
+resolveWorkspaceProjects=true
+version=1
diff --git a/pom.xml b/pom.xml
index a8f1bda..4be457f 100644
--- a/pom.xml
+++ b/pom.xml
@@ -2,6 +2,6 @@
   <modelVersion>4.0.0</modelVersion>
   <groupId>com.bonitasoft.log.event</groupId>
   <artifactId>bonita-event</artifactId>
-  <version>1.2.0</version>
+  <version>1.3.0</version>
   <name>BonitaEvent</name>
 </project>
\ No newline at end of file
diff --git a/src/main/java/org/bonitasoft/log/event/BEvent.java b/src/main/java/org/bonitasoft/log/event/BEvent.java
index d6c45d4..00f3f5d 100644
--- a/src/main/java/org/bonitasoft/log/event/BEvent.java
+++ b/src/main/java/org/bonitasoft/log/event/BEvent.java
@@ -110,16 +110,37 @@ public BEvent(final String packageName, final long number, final Level level, fi
     }
 
     /**
-     * this is the common constructor in usage of event.
+     * create a Event Success with only a title.
+     */
+    public static BEvent getInstanceShortSuccess(final String packageName, final long number, final String title)
+    {
+      return new BEvent(packageName, number, Level.SUCCESS, title, null);
+    }
+    /**
+     * create a Event Success with title and the cause, to give more explanation on the success.
+     */
+    public static BEvent getInstanceSuccess(final String packageName, final long number, final String title, String cause)
+    {
+      return new BEvent(packageName, number, Level.SUCCESS, title, cause);
+    }
+    /**
+     * this is the common constructor in usage of event. A main event is referenced, which give all explanations, and the event only capture some additionnal parameters
      *
-     * @param referenceEvent
-     * @param parameters
+     * @param referenceEvent : the referentiel event, which contains the level, cause, explanation, action (if errors). Example, a event to explain that a file can't be openned.
+     * @param parameters : to give more explanations to the event, the parameters carry all information to send to users (example, complete fileName)
      */
     public BEvent(final BEvent referenceEvent, final String parameters) {
         mReferenceEvent = referenceEvent;
         mParameters = parameters;
     }
 
+    /**
+     * Build an event from an Exception. The referentiel event contains all informations (explanation, cause, actions) and the exception is used to complete the event. Any parameters are welcome
+     * Default Constructor.
+     * @param referenceEvent: the referentiel event, which contains the level, cause, explanation, action (if errors). Example, a event to explain that a file can't be openned. 
+     * @param e: the exception, to collect more information
+     * @param parameters: to give more explanations to the event, the parameters carry all information to send to users (example, complete fileName)
+     */
     public BEvent(final BEvent referenceEvent, final Exception e, final String parameters) {
         mReferenceEvent = referenceEvent;
         mParameters = parameters;
@@ -129,6 +150,7 @@ public BEvent(final BEvent referenceEvent, final Exception e, final String param
         mExceptionDetails = sw.toString();
     }
 
+    
     /* ******************************************************************************** */
     /*                                                                                  */
     /* Tools */