From 00722223904df9c8138c72d759676a204ce3d27d Mon Sep 17 00:00:00 2001 From: Mahmoud Ben Hassine Date: Tue, 24 Nov 2020 21:35:37 +0100 Subject: [PATCH] Update Javadoc about rule comparison --- easy-rules-core/src/main/java/org/jeasy/rules/api/Rules.java | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/easy-rules-core/src/main/java/org/jeasy/rules/api/Rules.java b/easy-rules-core/src/main/java/org/jeasy/rules/api/Rules.java index 0d9f89d..0d10591 100644 --- a/easy-rules-core/src/main/java/org/jeasy/rules/api/Rules.java +++ b/easy-rules-core/src/main/java/org/jeasy/rules/api/Rules.java @@ -34,6 +34,10 @@ import java.util.TreeSet; /** * This class encapsulates a set of rules and represents a rules namespace. * Rules must have a unique name within a rules namespace. + * + * Rules will be compared to each other based on {@link Rule#compareTo(Object)} + * method, so {@link Rule}'s implementations are expected to correctly implement + * {@code compareTo} to ensure unique rule names within a single namespace. * * @author Mahmoud Ben Hassine (mahmoud.benhassine@icloud.com) */