src/uk/ac/vamsas/client/IClientAppdata.java

   1 /*\r
   2  * This file is part of the Vamsas Client version 0.1. \r
   3  * Copyright 2009 by Jim Procter, Iain Milne, Pierre Marguerite, \r
   4  *  Andrew Waterhouse and Dominik Lindner.\r
   5  * \r
   6  * Earlier versions have also been incorporated into Jalview version 2.4 \r
   7  * since 2008, and TOPALi version 2 since 2007.\r
   8  * \r
   9  * The Vamsas Client is free software: you can redistribute it and/or modify\r
  10  * it under the terms of the GNU Lesser General Public License as published by\r
  11  * the Free Software Foundation, either version 3 of the License, or\r
  12  * (at your option) any later version.\r
  13  *  \r
  14  * The Vamsas Client is distributed in the hope that it will be useful,\r
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of\r
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r
  17  * GNU Lesser General Public License for more details.\r
  18  * \r
  19  * You should have received a copy of the GNU Lesser General Public License\r
  20  * along with the Vamsas Client.  If not, see <http://www.gnu.org/licenses/>.\r
  21  */\r
  22 package uk.ac.vamsas.client;\r
  23 \r
  24 /**\r
  25  * Object for accessing Client and User specific data in an IClientDocument\r
  26  * instance.\r
  27  * \r
  28  */\r
  29 public interface IClientAppdata {\r
  30   /**\r
  31    * @return true if Client's non-user specific application data is non-zero\r
  32    *         length.\r
  33    */\r
  34   boolean hasClientAppdata();\r
  35 \r
  36   /**\r
  37    * @return true if User's Client Application data is non-zero length\r
  38    */\r
  39   boolean hasUserAppdata();\r
  40 \r
  41   /**\r
  42    * \r
  43    * @return byte array containing the Client's non-user specific application\r
  44    *         data\r
  45    */\r
  46   byte[] getClientAppdata();\r
  47 \r
  48   /**\r
  49    * \r
  50    * @return byte array containing the Client's user specific application data\r
  51    */\r
  52   byte[] getUserAppdata();\r
  53 \r
  54   /**\r
  55    * set the non-User-specific application data\r
  56    * \r
  57    * @param data\r
  58    *          - the new non-user-specific data\r
  59    */\r
  60   void setClientAppdata(byte[] data);\r
  61 \r
  62   /**\r
  63    * set the User-specific application data\r
  64    * \r
  65    * @param data\r
  66    *          - the new user-specific data\r
  67    */\r
  68   void setUserAppdata(byte[] data);\r
  69 \r
  70   /**\r
  71    * @return non-user specific data output stream\r
  72    */\r
  73   AppDataOutputStream getClientOutputStream();\r
  74 \r
  75   /**\r
  76    * @return non-user specific data input stream\r
  77    */\r
  78   AppDataInputStream getClientInputStream();\r
  79 \r
  80   /**\r
  81    * \r
  82    * @return user specific data output stream\r
  83    */\r
  84   AppDataOutputStream getUserOutputStream();\r
  85 \r
  86   /**\r
  87    * \r
  88    * @return user specific data input stream\r
  89    */\r
  90   AppDataInputStream getUserInputStream();\r
  91 }\r