src/jalview/util/jarInputStreamProvider.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8)
   3  * Copyright (C) 2012 J Procter, AM Waterhouse, LM Lui, J Engelhardt, G Barton, M Clamp, S Searle
   4  *
   5  * This file is part of Jalview.
   6  *
   7  * Jalview is free software: you can redistribute it and/or
   8  * modify it under the terms of the GNU General Public License
   9  * as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
  10  *
  11  * Jalview is distributed in the hope that it will be useful, but
  12  * WITHOUT ANY WARRANTY; without even the implied warranty
  13  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  14  * PURPOSE.  See the GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
  17  */
  18 package jalview.util;
  19
  20 import java.io.IOException;
  21 import java.util.jar.JarInputStream;
  22
  23 /**
  24  * input stream provider interface to be implemented by any non-file or URL
  25  * datasources so that all Jar entries can be read from the datasource by
  26  * repeatedly re-opening the JarInputStream.
  27  *
  28  * This is a workaround necessary because castor's unmarshaller will close the
  29  * input stream after an unmarshalling session, which normally closes the whole
  30  * Jar input stream, not just the current JarEntry's stream.
  31  */
  32 public interface jarInputStreamProvider
  33 {
  34   /**
  35    * @return properly initialized jar input stream
  36    */
  37   JarInputStream getJarInputStream() throws IOException;
  38
  39   /**
  40    *
  41    * @return human readable name for datasource used when reporting any problems
  42    *         with it
  43    */
  44   String getFilename();
  45 }