applied LGPLv3 and source code formatting.
[vamsas.git] / src / uk / ac / vamsas / client / IClientAppdata.java
index 4df6abb..2099995 100644 (file)
@@ -1,60 +1,91 @@
-/**
- * 
- */
-package uk.ac.vamsas.client;
-
-
-
-/**
- * Object for accessing Client and User specific data
- * in an IClientDocument instance. 
- *
- */
-public interface IClientAppdata {
-  /**
-   * @return true if Client's non-user specific application data is non-zero length.
-   */
-  boolean hasClientAppdata();
-  /**
-   * @return true if User's Client Application data is non-zero length
-   */
-  boolean hasUserAppdata();
-  /**
-   * 
-   * @return byte array containing the Client's non-user specific application data
-   */
-  byte[] getClientAppdata();
-  /**
-   * 
-   * @return byte array containing the Client's user specific application data
-   */
-  byte[] getUserAppdata();
-  /**
-   * set the non-User-specific application data
-   * @param data - the new non-user-specific data
-   */
-  void setClientAppdata(byte[] data);
-  /**
-   * set the User-specific application data
-   * @param data - the new user-specific data
-   */
-  void setUserAppdata(byte[] data);
-  /**
-   * @return non-user specific data output stream 
-   */
-  AppDataOutputStream getClientOutputStream();
-  /**
-   * @return non-user specific data input stream 
-   */
-  AppDataInputStream getClientInputStream();
-  /**
-   * 
-   * @return user specific data output stream
-   */
-  AppDataOutputStream getUserOutputStream();
-  /**
-   * 
-   * @return user specific data input stream
-   */
-  AppDataInputStream getUserInputStream();
-}
+/*\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
+ * Object for accessing Client and User specific data in an IClientDocument\r
+ * instance.\r
+ * \r
+ */\r
+public interface IClientAppdata {\r
+  /**\r
+   * @return true if Client's non-user specific application data is non-zero\r
+   *         length.\r
+   */\r
+  boolean hasClientAppdata();\r
+\r
+  /**\r
+   * @return true if User's Client Application data is non-zero length\r
+   */\r
+  boolean hasUserAppdata();\r
+\r
+  /**\r
+   * \r
+   * @return byte array containing the Client's non-user specific application\r
+   *         data\r
+   */\r
+  byte[] getClientAppdata();\r
+\r
+  /**\r
+   * \r
+   * @return byte array containing the Client's user specific application data\r
+   */\r
+  byte[] getUserAppdata();\r
+\r
+  /**\r
+   * set the non-User-specific application data\r
+   * \r
+   * @param data\r
+   *          - the new non-user-specific data\r
+   */\r
+  void setClientAppdata(byte[] data);\r
+\r
+  /**\r
+   * set the User-specific application data\r
+   * \r
+   * @param data\r
+   *          - the new user-specific data\r
+   */\r
+  void setUserAppdata(byte[] data);\r
+\r
+  /**\r
+   * @return non-user specific data output stream\r
+   */\r
+  AppDataOutputStream getClientOutputStream();\r
+\r
+  /**\r
+   * @return non-user specific data input stream\r
+   */\r
+  AppDataInputStream getClientInputStream();\r
+\r
+  /**\r
+   * \r
+   * @return user specific data output stream\r
+   */\r
+  AppDataOutputStream getUserOutputStream();\r
+\r
+  /**\r
+   * \r
+   * @return user specific data input stream\r
+   */\r
+  AppDataInputStream getUserInputStream();\r
+}\r