Update Javadoc about rule comparison

pull/324/head
Mahmoud Ben Hassine 4 years ago
parent 2a37e7b9d2
commit 0072222390
No known key found for this signature in database
GPG Key ID: 2B4156D07E8A1737

@ -35,6 +35,10 @@ import java.util.TreeSet;
* This class encapsulates a set of rules and represents a rules namespace. * This class encapsulates a set of rules and represents a rules namespace.
* Rules must have a unique name within 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) * @author Mahmoud Ben Hassine (mahmoud.benhassine@icloud.com)
*/ */
public class Rules implements Iterable<Rule> { public class Rules implements Iterable<Rule> {

Loading…
Cancel
Save