From 61c902930d345d02aa6d09921bc19a85356edf27 Mon Sep 17 00:00:00 2001 From: Mahmoud Ben Hassine Date: Tue, 8 Dec 2015 00:48:29 +0100 Subject: [PATCH] fix javadoc --- .../src/main/java/org/easyrules/core/BasicRule.java | 2 +- .../main/java/org/easyrules/core/DefaultRulesEngine.java | 4 ++-- easyrules-core/src/main/java/org/easyrules/overview.html | 6 +++--- .../java/org/easyrules/core/DefaultJmxRulesEngine.java | 2 +- .../java/org/easyrules/quartz/RulesEngineScheduler.java | 9 +++++++-- 5 files changed, 14 insertions(+), 9 deletions(-) diff --git a/easyrules-core/src/main/java/org/easyrules/core/BasicRule.java b/easyrules-core/src/main/java/org/easyrules/core/BasicRule.java index 8d5fb20..bf2f66f 100644 --- a/easyrules-core/src/main/java/org/easyrules/core/BasicRule.java +++ b/easyrules-core/src/main/java/org/easyrules/core/BasicRule.java @@ -31,7 +31,7 @@ import javax.management.MXBean; /** * Basic rule implementation class that provides common methods. - *

+ * * You can extend this class and override {@link BasicRule#evaluate()} and {@link BasicRule#execute()} * to provide rule conditions and actions logic. * diff --git a/easyrules-core/src/main/java/org/easyrules/core/DefaultRulesEngine.java b/easyrules-core/src/main/java/org/easyrules/core/DefaultRulesEngine.java index ec51755..a4093e7 100644 --- a/easyrules-core/src/main/java/org/easyrules/core/DefaultRulesEngine.java +++ b/easyrules-core/src/main/java/org/easyrules/core/DefaultRulesEngine.java @@ -39,9 +39,9 @@ import static java.lang.String.format; /** * Default {@link org.easyrules.api.RulesEngine} implementation. - *

+ * * This implementation handles a set of rules with unique name. - *

+ * * Rules are fired according to their natural order which is priority by default. * * @author Mahmoud Ben Hassine (mahmoud.benhassine@icloud.com) diff --git a/easyrules-core/src/main/java/org/easyrules/overview.html b/easyrules-core/src/main/java/org/easyrules/overview.html index 4015ea2..301095d 100644 --- a/easyrules-core/src/main/java/org/easyrules/overview.html +++ b/easyrules-core/src/main/java/org/easyrules/overview.html @@ -1,11 +1,11 @@ - Easy Rules 2.1.0 RELEASE API + Easy Rules 2.2.0 RELEASE API -

Easy Rules 2.1.0 RELEASE API

+

Easy Rules 2.2.0 RELEASE API

- \ No newline at end of file + diff --git a/easyrules-jmx/src/main/java/org/easyrules/core/DefaultJmxRulesEngine.java b/easyrules-jmx/src/main/java/org/easyrules/core/DefaultJmxRulesEngine.java index b97633f..daff049 100644 --- a/easyrules-jmx/src/main/java/org/easyrules/core/DefaultJmxRulesEngine.java +++ b/easyrules-jmx/src/main/java/org/easyrules/core/DefaultJmxRulesEngine.java @@ -31,7 +31,7 @@ import java.util.List; /** * Default {@link JmxRulesEngine} implementation. - *

+ * * This implementation handles a set of JMX rules with unique names. * * @author Drem Darios (drem.darios@gmail.com) diff --git a/easyrules-quartz/src/main/java/org/easyrules/quartz/RulesEngineScheduler.java b/easyrules-quartz/src/main/java/org/easyrules/quartz/RulesEngineScheduler.java index 5f54ec5..3388a15 100644 --- a/easyrules-quartz/src/main/java/org/easyrules/quartz/RulesEngineScheduler.java +++ b/easyrules-quartz/src/main/java/org/easyrules/quartz/RulesEngineScheduler.java @@ -41,7 +41,7 @@ import static org.quartz.TriggerBuilder.newTrigger; /** * Quartz scheduler wrapper used to setup triggers. - *

+ * * Created by Sunand on 6/8/2015. */ public class RulesEngineScheduler { @@ -91,6 +91,7 @@ public class RulesEngineScheduler { * * @param engine the engine to schedule * @param startTime the start time + * @throws RulesEngineSchedulerException if unable to schedule the rules engine */ public void scheduleAt(final RulesEngine engine, final Date startTime) throws RulesEngineSchedulerException { checkNotNull(engine, "engine"); @@ -122,6 +123,7 @@ public class RulesEngineScheduler { * @param engine the engine to schedule * @param startTime the start time * @param interval the repeat interval in seconds + * @throws RulesEngineSchedulerException if unable to schedule the rules engine */ public void scheduleAtWithInterval(final RulesEngine engine, final Date startTime, final int interval) throws RulesEngineSchedulerException { checkNotNull(engine, "engine"); @@ -159,6 +161,7 @@ public class RulesEngineScheduler { * @param cronExpression the cron expression to use. * For a complete tutorial about cron expressions, please refer to * quartz reference documentation. + * @throws RulesEngineSchedulerException if unable to schedule the rules engine */ public void scheduleCron(final RulesEngine engine, final String cronExpression) throws RulesEngineSchedulerException { checkNotNull(engine, "engine"); @@ -230,7 +233,7 @@ public class RulesEngineScheduler { /** * Stop the scheduler. - *

+ * * Note: The scheduler cannot be re-started and no more engines can be scheduled. * * @throws RulesEngineSchedulerException thrown if the scheduler cannot be stopped @@ -246,6 +249,7 @@ public class RulesEngineScheduler { /** * Check if the scheduler is started. * + * @return true if the scheduler is started, false else * @throws RulesEngineSchedulerException thrown if the scheduler status cannot be checked */ public boolean isStarted() throws RulesEngineSchedulerException { @@ -259,6 +263,7 @@ public class RulesEngineScheduler { /** * Check if the scheduler is stopped. * + * @return true if the scheduler is stopped, false else * @throws RulesEngineSchedulerException thrown if the scheduler status cannot be checked */ public boolean isStopped() throws RulesEngineSchedulerException {