JAL-2808 small tweaks to api / Javadoc

[jalview.git] / src / jalview / datamodel / features / FeatureMatcherSetI.java

diff --git a/src/jalview/datamodel/features/FeatureMatcherSetI.java b/src/jalview/datamodel/features/FeatureMatcherSetI.java
index 8a9d675..90c2986 100644 (file)
--- a/src/jalview/datamodel/features/FeatureMatcherSetI.java
+++ b/src/jalview/datamodel/features/FeatureMatcherSetI.java
@@ -20,14 +20,13 @@ public interface FeatureMatcherSetI
   boolean matches(SequenceFeature feature);
 
   /**
-   * Answers a new object that matches the logical AND of this and m
+   * Adds (ANDs) match condition m to this object's matcher set
    * 
    * @param m
-   * @return
    * @throws IllegalStateException
    *           if an attempt is made to AND to existing OR-ed conditions
    */
-  FeatureMatcherSetI and(FeatureMatcherI m);
+  void and(FeatureMatcherI m);
 
   /**
    * Answers true if any second condition is AND-ed with this one, false if it
@@ -38,14 +37,13 @@ public interface FeatureMatcherSetI
   boolean isAnded();
 
   /**
-   * Answers a new object that matches the logical OR of this and m
+   * Adds (ORs) the given condition to this object's match conditions
    * 
    * @param m
-   * @return
    * @throws IllegalStateException
    *           if an attempt is made to OR to existing AND-ed conditions
    */
-  FeatureMatcherSetI or(FeatureMatcherI m);
+  void or(FeatureMatcherI m);
 
   /**
    * Answers an iterator over the combined match conditions
@@ -63,8 +61,8 @@ public interface FeatureMatcherSetI
 
   /**
    * Answers a string representation of this object suitable for use when
-   * persisting data, in a format that should not change so can be reliably read
-   * back.
+   * persisting data, in a format that can be reliably read back. Any changes to
+   * the format should be backwards compatible.
    */
   String toStableString();
 }