From: jprocter <Jim Procter>
Date: Fri, 27 Apr 2007 10:46:49 +0000 (+0000)
Subject: documentation and getProperties method
X-Git-Tag: Release_2_3~140
X-Git-Url: http://source.jalview.org/gitweb/?a=commitdiff_plain;h=a0b666f6b2b220b28baf6022a41ecf3c50db7d0c;p=jalview.git

documentation and getProperties method
---

diff --git a/src/jalview/datamodel/Alignment.java b/src/jalview/datamodel/Alignment.java
index 34cc78f..abaa80f 100755
--- a/src/jalview/datamodel/Alignment.java
+++ b/src/jalview/datamodel/Alignment.java
@@ -720,5 +720,9 @@ public class Alignment
       return null;
   }
 
+  public Hashtable getProperties()
+  {
+    return alignmentProperties;
+  }
 
 }
diff --git a/src/jalview/datamodel/AlignmentI.java b/src/jalview/datamodel/AlignmentI.java
index 96b1972..f937bd3 100755
--- a/src/jalview/datamodel/AlignmentI.java
+++ b/src/jalview/datamodel/AlignmentI.java
@@ -244,7 +244,23 @@ public interface AlignmentI
    */
   public CigarArray getCompactAlignment();
 
+  /**
+   * Set an arbitrary key value pair for an alignment.
+   * Note: both key and value objects should return a 
+   * meaningful, human readable response to .toString()
+   * @param key
+   * @param value
+   */
   public void setProperty(Object key, Object value);
-
+  /**
+   * Get a named property from the alignment. 
+   * @param key
+   * @return value of property
+   */
   public Object getProperty(Object key);
+  /**
+   * Get the property hashtable.
+   * @return hashtable of alignment properties (if any)
+   */
+  public Hashtable getProperties();
 }