+/*\r
+ * This file is part of the Vamsas Client version 0.1. \r
+ * Copyright 2009 by Jim Procter, Iain Milne, Pierre Marguerite, \r
+ * Andrew Waterhouse and Dominik Lindner.\r
+ * \r
+ * Earlier versions have also been incorporated into Jalview version 2.4 \r
+ * since 2008, and TOPALi version 2 since 2007.\r
+ * \r
+ * The Vamsas Client is free software: you can redistribute it and/or modify\r
+ * it under the terms of the GNU Lesser General Public License as published by\r
+ * the Free Software Foundation, either version 3 of the License, or\r
+ * (at your option) any later version.\r
+ * \r
+ * The Vamsas Client is distributed in the hope that it will be useful,\r
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of\r
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\r
+ * GNU Lesser General Public License for more details.\r
+ * \r
+ * You should have received a copy of the GNU Lesser General Public License\r
+ * along with the Vamsas Client. If not, see <http://www.gnu.org/licenses/>.\r
+ */\r
package uk.ac.vamsas.client;\r
\r
/**\r
* Methods implemented by a Vamsas Application's Object Update handler\r
- * @author vamsas\r
- * Introduced November 2006 Vamsas Meeting\r
- * TODO: verify this is sufficient for the per-object update event mechanism\r
+ * \r
+ * @author vamsas Introduced November 2006 Vamsas Meeting TODO: verify this is\r
+ * sufficient for the per-object update event mechanism\r
*/\r
public interface IObjectUpdate {\r
/**\r
- * Called by the library to find out which vamsas document object this update handler is interested in\r
+ * Called by the library to find out which vamsas document object this update\r
+ * handler is interested in\r
+ * \r
* @return class that extends org.vamsas.Vobject\r
*/\r
Class getRootVobject();\r
+\r
/**\r
- * Called to test if this handler is to be called for updates to any Vobjects below the Root Vobject in the vamsas document.\r
- * @return false means IObjectUpdate.update(updated, cdoc) will only be called with instances of type getRootVobject(). \r
+ * Called to test if this handler is to be called for updates to any Vobjects\r
+ * below the Root Vobject in the vamsas document.\r
+ * \r
+ * @return false means IObjectUpdate.update(updated, cdoc) will only be called\r
+ * with instances of type getRootVobject().\r
*/\r
boolean handlesSubtreeUpdates();\r
+\r
/**\r
- * Method called by Vamsas Client Library for all updated objects that the handler is registered for.\r
+ * Method called by Vamsas Client Library for all updated objects that the\r
+ * handler is registered for.\r
+ * \r
* @param updated\r
* @param cdoc\r
*/\r
- void update(uk.ac.vamsas.client.Vobject updated, uk.ac.vamsas.client.IClientDocument cdoc);\r
+ void update(uk.ac.vamsas.client.Vobject updated,\r
+ uk.ac.vamsas.client.IClientDocument cdoc);\r
}\r