Merge branch 'develop' into features/JAL-2094_colourInterface

[jalview.git] / src / jalview / datamodel / SequenceI.java

diff --git a/src/jalview/datamodel/SequenceI.java b/src/jalview/datamodel/SequenceI.java
index 55c59db..b7a291e 100755 (executable)
--- a/src/jalview/datamodel/SequenceI.java
+++ b/src/jalview/datamodel/SequenceI.java
@@ -289,16 +289,18 @@ public interface SequenceI extends ASequenceI
   public Vector<PDBEntry> getAllPDBEntries();
 
   /**
-   * add entry to the *normalised* vector of PDBIds.
+   * Adds the entry to the *normalised* list of PDBIds.
    * 
-   * If a PDBEntry is passed with an entry.getID() string, as one already in the
-   * list, or one is added that appears to be the same but has a chain ID
+   * If a PDBEntry is passed with the same entry.getID() string as one already
+   * in the list, or one is added that appears to be the same but has a chain ID
    * appended, then the existing PDBEntry will be updated with the new
-   * attributes.
+   * attributes instead, unless the entries have distinct chain codes or
+   * associated structure files.
    * 
    * @param entry
+   * @return true if the entry was added, false if updated
    */
-  public void addPDBId(PDBEntry entry);
+  public boolean addPDBId(PDBEntry entry);
 
   /**
    * update the list of PDBEntrys to include any DBRefEntrys citing structural