update author list in license for (JAL-826)
[jalview.git] / src / jalview / io / vamsas / LocalDocSyncObject.java
index 2c9eddc..7cdbe58 100644 (file)
@@ -1,20 +1,19 @@
 /*
- * Jalview - A Sequence Alignment Editor and Viewer (Version 2.4)
- * Copyright (C) 2008 AM Waterhouse, J Procter, G Barton, M Clamp, S Searle
+ * Jalview - A Sequence Alignment Editor and Viewer (Version 2.7)
+ * Copyright (C) 2011 J Procter, AM Waterhouse, J Engelhardt, LM Lui, G Barton, M Clamp, S Searle
  * 
- * This program is free software; you can redistribute it and/or
- * modify it under the terms of the GNU General Public License
- * as published by the Free Software Foundation; either version 2
- * of the License, or (at your option) any later version.
+ * This file is part of Jalview.
  * 
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU General Public License for more details.
+ * Jalview is free software: you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License 
+ * as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
  * 
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
+ * Jalview is distributed in the hope that it will be useful, but 
+ * WITHOUT ANY WARRANTY; without even the implied warranty 
+ * of MERCHANTABILITY or FITNESS FOR A PARTICULAR 
+ * PURPOSE.  See the GNU General Public License for more details.
+ * 
+ * You should have received a copy of the GNU General Public License along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
  */
 package jalview.io.vamsas;
 
@@ -22,7 +21,9 @@ import uk.ac.vamsas.client.Vobject;
 
 /**
  * Implement the basic logic for synchronising changes to or from the Vamsas
- * Document
+ * Document. This is a more generic and normalised framework than the one
+ * implemented in DatastoreItem, but probably more tedious to implement. ..
+ * abandoned. Nov 2008
  * 
  * @author JimP
  */
@@ -47,15 +48,13 @@ public abstract class LocalDocSyncObject extends DatastoreItem
 
   /**
    * called if the local object can be safely updated from the bound document
-   * object.
+   * object. public abstract void updateToDoc();
    */
-  public abstract void updateFromDoc();
 
   /**
    * called if the associated document object can be safely updated with the
-   * local changes
+   * local changes public abstract void updateToDoc();
    */
-  public abstract void updateToDoc();
 
   /**
    * @return true if the local object is modified
@@ -80,7 +79,8 @@ public abstract class LocalDocSyncObject extends DatastoreItem
    *         document object
    */
   public abstract LocalDocSyncObject newDocumentObject(); // could make this
-                                                          // constructor(Lobject)
+
+  // constructor(Lobject)
 
   /**
    * 
@@ -88,13 +88,14 @@ public abstract class LocalDocSyncObject extends DatastoreItem
    *         new local object.
    */
   public abstract LocalDocSyncObject newLocalObject(); // make this
-                                                        // constructor(Vobject)
+
+  // constructor(Vobject)
 
   /**
    * apply the update/commit logic as defined in the vamsas paper
    * 
    * @param documentIsUpdated
-   *                true if a document update event is being handled
+   *          true if a document update event is being handled
    */
   public void synchronize(boolean documentIsUpdated)
   {