From 366e342ff28a64ddd4c80b257d9b0325c29f8828 Mon Sep 17 00:00:00 2001 From: Mahmoud Ben Hassine Date: Sun, 17 Dec 2017 23:25:06 +0100 Subject: [PATCH] update javadoc --- easy-rules-core/src/main/java/org/jeasy/rules/api/Rule.java | 2 +- .../main/java/org/jeasy/rules/core/InferenceRulesEngine.java | 2 +- .../java/org/jeasy/rules/core/RuleDefinitionValidator.java | 2 +- .../java/org/jeasy/rules/core/RulesEngineParameters.java | 4 ++-- .../test/java/org/jeasy/rules/core/CompositeRuleTest.java | 5 ----- .../java/org/jeasy/rules/core/CustomRuleOrderingTest.java | 5 ----- .../java/org/jeasy/rules/core/DefaultRulesEngineTest.java | 5 ----- .../src/test/java/org/jeasy/rules/core/RuleListenerTest.java | 5 ----- .../java/org/jeasy/rules/core/RulePriorityThresholdTest.java | 5 ----- .../java/org/jeasy/rules/core/RulesEngineListenerTest.java | 5 ----- .../org/jeasy/rules/core/SkipOnFirstAppliedRuleTest.java | 5 ----- .../java/org/jeasy/rules/core/SkipOnFirstFailedRuleTest.java | 5 ----- .../jeasy/rules/core/SkipOnFirstNonTriggeredRuleTest.java | 5 ----- .../src/main/java/org/jeasy/rules/mvel/MVELRuleFactory.java | 1 + 14 files changed, 6 insertions(+), 50 deletions(-) diff --git a/easy-rules-core/src/main/java/org/jeasy/rules/api/Rule.java b/easy-rules-core/src/main/java/org/jeasy/rules/api/Rule.java index 3da313f0..75337441 100644 --- a/easy-rules-core/src/main/java/org/jeasy/rules/api/Rule.java +++ b/easy-rules-core/src/main/java/org/jeasy/rules/api/Rule.java @@ -26,7 +26,7 @@ /** * Abstraction for a rule that can be fired by the rules engine. * - * Rules are registered in the rules engine registry and must have a unique name. + * Rules are registered in a rule set of type Rules in which they must have a unique name. * * @author Mahmoud Ben Hassine (mahmoud.benhassine@icloud.com) */ diff --git a/easy-rules-core/src/main/java/org/jeasy/rules/core/InferenceRulesEngine.java b/easy-rules-core/src/main/java/org/jeasy/rules/core/InferenceRulesEngine.java index 62a98458..8b407719 100644 --- a/easy-rules-core/src/main/java/org/jeasy/rules/core/InferenceRulesEngine.java +++ b/easy-rules-core/src/main/java/org/jeasy/rules/core/InferenceRulesEngine.java @@ -34,7 +34,7 @@ * * Rules are selected based on given facts and fired according to their natural order which is priority by default. * - * The engine continuously select and fire rules until no more rules are applicable. + * The engine continuously selects and fires rules until no more rules are applicable. * * @author Mahmoud Ben Hassine (mahmoud.benhassine@icloud.com) */ diff --git a/easy-rules-core/src/main/java/org/jeasy/rules/core/RuleDefinitionValidator.java b/easy-rules-core/src/main/java/org/jeasy/rules/core/RuleDefinitionValidator.java index 738f109c..8d2c3270 100644 --- a/easy-rules-core/src/main/java/org/jeasy/rules/core/RuleDefinitionValidator.java +++ b/easy-rules-core/src/main/java/org/jeasy/rules/core/RuleDefinitionValidator.java @@ -38,7 +38,7 @@ import org.jeasy.rules.api.Facts; /** - * Validate that an annotated rule object is well defined. + * This component validates that an annotated rule object is well defined. * * @author Mahmoud Ben Hassine (mahmoud.benhassine@icloud.com) */ diff --git a/easy-rules-core/src/main/java/org/jeasy/rules/core/RulesEngineParameters.java b/easy-rules-core/src/main/java/org/jeasy/rules/core/RulesEngineParameters.java index df95e577..7b0857c8 100644 --- a/easy-rules-core/src/main/java/org/jeasy/rules/core/RulesEngineParameters.java +++ b/easy-rules-core/src/main/java/org/jeasy/rules/core/RulesEngineParameters.java @@ -27,8 +27,8 @@ * Parameters of a rules engine. * * * * @author Mahmoud Ben Hassine (mahmoud.benhassine@icloud.com) diff --git a/easy-rules-core/src/test/java/org/jeasy/rules/core/CompositeRuleTest.java b/easy-rules-core/src/test/java/org/jeasy/rules/core/CompositeRuleTest.java index 2d421e23..6f757cc7 100644 --- a/easy-rules-core/src/test/java/org/jeasy/rules/core/CompositeRuleTest.java +++ b/easy-rules-core/src/test/java/org/jeasy/rules/core/CompositeRuleTest.java @@ -32,11 +32,6 @@ import static org.assertj.core.api.Assertions.assertThat; import static org.mockito.Mockito.*; -/** - * Test class for composite rule execution. - * - * @author Mahmoud Ben Hassine (mahmoud.benhassine@icloud.com) - */ public class CompositeRuleTest extends AbstractTest { private CompositeRule compositeRule; diff --git a/easy-rules-core/src/test/java/org/jeasy/rules/core/CustomRuleOrderingTest.java b/easy-rules-core/src/test/java/org/jeasy/rules/core/CustomRuleOrderingTest.java index 0586a17a..ba972499 100644 --- a/easy-rules-core/src/test/java/org/jeasy/rules/core/CustomRuleOrderingTest.java +++ b/easy-rules-core/src/test/java/org/jeasy/rules/core/CustomRuleOrderingTest.java @@ -33,11 +33,6 @@ import static org.mockito.Mockito.inOrder; import static org.mockito.Mockito.when; -/** - * Test class for custom rule ordering. - * - * @author Mahmoud Ben Hassine (mahmoud.benhassine@icloud.com) - */ @RunWith(MockitoJUnitRunner.class) public class CustomRuleOrderingTest extends AbstractTest { diff --git a/easy-rules-core/src/test/java/org/jeasy/rules/core/DefaultRulesEngineTest.java b/easy-rules-core/src/test/java/org/jeasy/rules/core/DefaultRulesEngineTest.java index b1dd7bc2..55e83f35 100644 --- a/easy-rules-core/src/test/java/org/jeasy/rules/core/DefaultRulesEngineTest.java +++ b/easy-rules-core/src/test/java/org/jeasy/rules/core/DefaultRulesEngineTest.java @@ -44,11 +44,6 @@ import org.mockito.InOrder; import org.mockito.Mock; -/** - * Test class for {@link DefaultRulesEngine}. - * - * @author Mahmoud Ben Hassine (mahmoud.benhassine@icloud.com) - */ public class DefaultRulesEngineTest extends AbstractTest { @Mock diff --git a/easy-rules-core/src/test/java/org/jeasy/rules/core/RuleListenerTest.java b/easy-rules-core/src/test/java/org/jeasy/rules/core/RuleListenerTest.java index 240ebc84..d247783c 100644 --- a/easy-rules-core/src/test/java/org/jeasy/rules/core/RuleListenerTest.java +++ b/easy-rules-core/src/test/java/org/jeasy/rules/core/RuleListenerTest.java @@ -31,11 +31,6 @@ import static org.mockito.Mockito.*; -/** - * Test class of the execution of rule listeners. - * - * @author Mahmoud Ben Hassine (mahmoud.benhassine@icloud.com) - */ public class RuleListenerTest extends AbstractTest { @Mock diff --git a/easy-rules-core/src/test/java/org/jeasy/rules/core/RulePriorityThresholdTest.java b/easy-rules-core/src/test/java/org/jeasy/rules/core/RulePriorityThresholdTest.java index 7e09d496..59754f42 100644 --- a/easy-rules-core/src/test/java/org/jeasy/rules/core/RulePriorityThresholdTest.java +++ b/easy-rules-core/src/test/java/org/jeasy/rules/core/RulePriorityThresholdTest.java @@ -30,11 +30,6 @@ import static org.mockito.Mockito.verify; import static org.mockito.Mockito.when; -/** - * Test class of rules priority comparison. - * - * @author Mahmoud Ben Hassine (mahmoud.benhassine@icloud.com) - */ public class RulePriorityThresholdTest extends AbstractTest { @Before diff --git a/easy-rules-core/src/test/java/org/jeasy/rules/core/RulesEngineListenerTest.java b/easy-rules-core/src/test/java/org/jeasy/rules/core/RulesEngineListenerTest.java index 36247a45..8c602cf8 100644 --- a/easy-rules-core/src/test/java/org/jeasy/rules/core/RulesEngineListenerTest.java +++ b/easy-rules-core/src/test/java/org/jeasy/rules/core/RulesEngineListenerTest.java @@ -32,11 +32,6 @@ import static java.util.Arrays.asList; import static org.mockito.Mockito.*; -/** - * Test class of the execution of rules engine listeners. - * - * @author Mahmoud Ben Hassine (mahmoud.benhassine@icloud.com) - */ public class RulesEngineListenerTest extends AbstractTest { @Mock diff --git a/easy-rules-core/src/test/java/org/jeasy/rules/core/SkipOnFirstAppliedRuleTest.java b/easy-rules-core/src/test/java/org/jeasy/rules/core/SkipOnFirstAppliedRuleTest.java index 6afd9f67..8ab92dd4 100644 --- a/easy-rules-core/src/test/java/org/jeasy/rules/core/SkipOnFirstAppliedRuleTest.java +++ b/easy-rules-core/src/test/java/org/jeasy/rules/core/SkipOnFirstAppliedRuleTest.java @@ -28,11 +28,6 @@ import static org.mockito.Mockito.*; -/** - * Test class of "skip on first applied rule" parameter of Easy Rules default engine. - * - * @author Mahmoud Ben Hassine (mahmoud.benhassine@icloud.com) - */ public class SkipOnFirstAppliedRuleTest extends AbstractTest { @Before diff --git a/easy-rules-core/src/test/java/org/jeasy/rules/core/SkipOnFirstFailedRuleTest.java b/easy-rules-core/src/test/java/org/jeasy/rules/core/SkipOnFirstFailedRuleTest.java index e391b639..b079232f 100644 --- a/easy-rules-core/src/test/java/org/jeasy/rules/core/SkipOnFirstFailedRuleTest.java +++ b/easy-rules-core/src/test/java/org/jeasy/rules/core/SkipOnFirstFailedRuleTest.java @@ -28,11 +28,6 @@ import static org.mockito.Mockito.*; -/** - * Test class of "skip on first failed rule" parameter of Easy Rules default engine. - * - * @author Mahmoud Ben Hassine (mahmoud.benhassine@icloud.com) - */ public class SkipOnFirstFailedRuleTest extends AbstractTest { @Before diff --git a/easy-rules-core/src/test/java/org/jeasy/rules/core/SkipOnFirstNonTriggeredRuleTest.java b/easy-rules-core/src/test/java/org/jeasy/rules/core/SkipOnFirstNonTriggeredRuleTest.java index 07e89b60..09b6892c 100644 --- a/easy-rules-core/src/test/java/org/jeasy/rules/core/SkipOnFirstNonTriggeredRuleTest.java +++ b/easy-rules-core/src/test/java/org/jeasy/rules/core/SkipOnFirstNonTriggeredRuleTest.java @@ -28,11 +28,6 @@ import static org.mockito.Mockito.*; -/** - * Test class of "skip on first non triggered rule" parameter of Easy Rules default engine. - * - * @author Krzysztof Kozlowski (krzysztof.kozlowski@coderion.pl) - */ public class SkipOnFirstNonTriggeredRuleTest extends AbstractTest { @Before diff --git a/easy-rules-mvel/src/main/java/org/jeasy/rules/mvel/MVELRuleFactory.java b/easy-rules-mvel/src/main/java/org/jeasy/rules/mvel/MVELRuleFactory.java index 29329fad..0162aeb4 100644 --- a/easy-rules-mvel/src/main/java/org/jeasy/rules/mvel/MVELRuleFactory.java +++ b/easy-rules-mvel/src/main/java/org/jeasy/rules/mvel/MVELRuleFactory.java @@ -37,6 +37,7 @@ public class MVELRuleFactory { /** * Create a new {@link MVELRule} from a rule descriptor. + * * @param ruleDescriptor in yaml format * @return a new rule * @throws FileNotFoundException if the rule descriptor cannot be found