github-forks
/
easy-rules
mirror of https://github.com/j-easy/easy-rules.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

fix javadoc

Browse Source
pull/55/head
Mahmoud Ben Hassine 9 years ago
parent 25814e81f5
commit 61c902930d
5 changed files with 14 additions and 9 deletions
Show Stats Download Patch File Download Diff File

2
easyrules-core/src/main/java/org/easyrules/core/BasicRule.java
Unescape Escape View File

@ -31,7 +31,7 @@ import javax.management.MXBean;
/** /**
* Basic rule implementation class that provides common methods. * Basic rule implementation class that provides common methods.
* <p/> *
* You can extend this class and override {@link BasicRule#evaluate()} and {@link BasicRule#execute()} * You can extend this class and override {@link BasicRule#evaluate()} and {@link BasicRule#execute()}
* to provide rule conditions and actions logic. * to provide rule conditions and actions logic.
* *

4
easyrules-core/src/main/java/org/easyrules/core/DefaultRulesEngine.java
Unescape Escape View File

@ -39,9 +39,9 @@ import static java.lang.String.format;
/** /**
* Default {@link org.easyrules.api.RulesEngine} implementation. * Default {@link org.easyrules.api.RulesEngine} implementation.
* <p/> *
* This implementation handles a set of rules with unique name. * This implementation handles a set of rules with unique name.
* <p/> *
* Rules are fired according to their natural order which is priority by default. * Rules are fired according to their natural order which is priority by default.
* *
* @author Mahmoud Ben Hassine (mahmoud.benhassine@icloud.com) * @author Mahmoud Ben Hassine (mahmoud.benhassine@icloud.com)

6
easyrules-core/src/main/java/org/easyrules/overview.html
Unescape Escape View File

@ -1,11 +1,11 @@
<html> <html>
<head> <head>
<title>Easy Rules 2.1.0 RELEASE API</title> <title>Easy Rules 2.2.0 RELEASE API</title>
</head> </head>
<body> <body>
<h1 class="title">Easy Rules 2.1.0 RELEASE API</h1> <h1 class="title">Easy Rules 2.2.0 RELEASE API</h1>
</body> </body>
</html> </html>

2
easyrules-jmx/src/main/java/org/easyrules/core/DefaultJmxRulesEngine.java
Unescape Escape View File

@ -31,7 +31,7 @@ import java.util.List;
/** /**
* Default {@link JmxRulesEngine} implementation. * Default {@link JmxRulesEngine} implementation.
* <p/> *
* This implementation handles a set of JMX rules with unique names. * This implementation handles a set of JMX rules with unique names.
* *
* @author Drem Darios (drem.darios@gmail.com) * @author Drem Darios (drem.darios@gmail.com)

9
easyrules-quartz/src/main/java/org/easyrules/quartz/RulesEngineScheduler.java
Unescape Escape View File

@ -41,7 +41,7 @@ import static org.quartz.TriggerBuilder.newTrigger;
/** /**
* Quartz scheduler wrapper used to setup triggers. * Quartz scheduler wrapper used to setup triggers.
* <p/> *
* Created by Sunand on 6/8/2015. * Created by Sunand on 6/8/2015.
*/ */
public class RulesEngineScheduler { public class RulesEngineScheduler {
@ -91,6 +91,7 @@ public class RulesEngineScheduler {
* *
* @param engine the engine to schedule * @param engine the engine to schedule
* @param startTime the start time * @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 { public void scheduleAt(final RulesEngine engine, final Date startTime) throws RulesEngineSchedulerException {
checkNotNull(engine, "engine"); checkNotNull(engine, "engine");
@ -122,6 +123,7 @@ public class RulesEngineScheduler {
* @param engine the engine to schedule * @param engine the engine to schedule
* @param startTime the start time * @param startTime the start time
* @param interval the repeat interval in seconds * @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 { public void scheduleAtWithInterval(final RulesEngine engine, final Date startTime, final int interval) throws RulesEngineSchedulerException {
checkNotNull(engine, "engine"); checkNotNull(engine, "engine");
@ -159,6 +161,7 @@ public class RulesEngineScheduler {
* @param cronExpression the cron expression to use. * @param cronExpression the cron expression to use.
* For a complete tutorial about cron expressions, please refer to * For a complete tutorial about cron expressions, please refer to
* <a href="http://quartz-scheduler.org/documentation/quartz-2.1.x/tutorials/crontrigger">quartz reference documentation</a>. * <a href="http://quartz-scheduler.org/documentation/quartz-2.1.x/tutorials/crontrigger">quartz reference documentation</a>.
* @throws RulesEngineSchedulerException if unable to schedule the rules engine
*/ */
public void scheduleCron(final RulesEngine engine, final String cronExpression) throws RulesEngineSchedulerException { public void scheduleCron(final RulesEngine engine, final String cronExpression) throws RulesEngineSchedulerException {
checkNotNull(engine, "engine"); checkNotNull(engine, "engine");
@ -230,7 +233,7 @@ public class RulesEngineScheduler {
/** /**
* Stop the scheduler. * Stop the scheduler.
* <p/> *
* <strong>Note: The scheduler cannot be re-started and no more engines can be scheduled.</strong> * <strong>Note: The scheduler cannot be re-started and no more engines can be scheduled.</strong>
* *
* @throws RulesEngineSchedulerException thrown if the scheduler cannot be stopped * @throws RulesEngineSchedulerException thrown if the scheduler cannot be stopped
@ -246,6 +249,7 @@ public class RulesEngineScheduler {
/** /**
* Check if the scheduler is started. * 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 * @throws RulesEngineSchedulerException thrown if the scheduler status cannot be checked
*/ */
public boolean isStarted() throws RulesEngineSchedulerException { public boolean isStarted() throws RulesEngineSchedulerException {
@ -259,6 +263,7 @@ public class RulesEngineScheduler {
/** /**
* Check if the scheduler is stopped. * 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 * @throws RulesEngineSchedulerException thrown if the scheduler status cannot be checked
*/ */
public boolean isStopped() throws RulesEngineSchedulerException { public boolean isStopped() throws RulesEngineSchedulerException {

Write Preview
Loading…
Cancel
Save