applied LGPLv3 and source code formatting.

[vamsas.git] / src / uk / ac / vamsas / objects / IVorbaBinding.java

diff --git a/src/uk/ac/vamsas/objects/IVorbaBinding.java b/src/uk/ac/vamsas/objects/IVorbaBinding.java
index f70a3dd..bc7198f 100644 (file)
--- a/src/uk/ac/vamsas/objects/IVorbaBinding.java
+++ b/src/uk/ac/vamsas/objects/IVorbaBinding.java
@@ -1,5 +1,23 @@
-/**\r
+/*\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.objects;\r
 \r
@@ -7,39 +25,48 @@ import uk.ac.vamsas.client.Vobject;
 import uk.ac.vamsas.client.VorbaId;\r
 \r
 /**\r
- * Provides methods to map between VorbaIds and arbitrary object references\r
- * for use by a vamsas Application when moving between its own datamodel and the\r
- * Vamsas session objects.\r
- * The implementing class needs a valid client-document instance if it is expected\r
- * to be able to register newly created vObjects. Normally this will be the case if\r
- * the implementing class has been generated by an IClient implementation which will\r
- * also have passed it a reference to the current valid IClientDocument instance for\r
- * that application's document access thread. \r
- * TODO: add remove/clear binding functions - currently you can just pass a null\r
- * to either argument for bindAppsObjectToVamsasObject to remove the binding from memory. \r
+ * Provides methods to map between VorbaIds and arbitrary object references for\r
+ * use by a vamsas Application when moving between its own datamodel and the\r
+ * Vamsas session objects. The implementing class needs a valid client-document\r
+ * instance if it is expected to be able to register newly created vObjects.\r
+ * Normally this will be the case if the implementing class has been generated\r
+ * by an IClient implementation which will also have passed it a reference to\r
+ * the current valid IClientDocument instance for that application's document\r
+ * access thread. TODO: add remove/clear binding functions - currently you can\r
+ * just pass a null to either argument for bindAppsObjectToVamsasObject to\r
+ * remove the binding from memory.\r
+ * \r
  * @author JimP\r
  * \r
  */\r
 public interface IVorbaBinding {\r
-/**\r
- * get the Vamsas session object bound to an internal object.\r
- * @param appObject\r
- * @return valid session object or Null.\r
- */\r
+  /**\r
+   * get the Vamsas session object bound to an internal object.\r
+   * \r
+   * @param appObject\r
+   * @return valid session object or Null.\r
+   */\r
   Vobject getVamsasObjectFor(Object appObject);\r
+\r
   /**\r
    * Get the Application's own object bound to an existing Vamsas session object\r
-   * @param vObject - object in vamsas document\r
+   * \r
+   * @param vObject\r
+   *          - object in vamsas document\r
    * @return apps object bound to the vamsas document object\r
    */\r
   Object getAppsObjectFor(uk.ac.vamsas.client.Vobject vObject);\r
 \r
   /**\r
-   * Record a mapping between a vamsas document object and an application's internal object.\r
-   * If either appObject or vObject parameters are null then any existing \r
-   * binding to the non-null object will be deleted\r
+   * Record a mapping between a vamsas document object and an application's\r
+   * internal object. If either appObject or vObject parameters are null then\r
+   * any existing binding to the non-null object will be deleted\r
+   * \r
    * @param appObject\r
-   * @param vObject - if newly created then it will be registered using the uk.ac.vamsas.client.IClientDocument.registerObject method.\r
+   * @param vObject\r
+   *          - if newly created then it will be registered using the\r
+   *          uk.ac.vamsas.client.IClientDocument.registerObject method.\r
    */\r
-  void bindAppsObjectToVamsasObject(Object appObject, uk.ac.vamsas.client.Vobject vObject);\r
+  void bindAppsObjectToVamsasObject(Object appObject,\r
+      uk.ac.vamsas.client.Vobject vObject);\r
 }\r