src/jalview/util/jarInputStreamProvider.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
   3  * Copyright (C) $$Year-Rel$$ The Jalview Authors
   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
  10  * of the License, or (at your option) any later version.
  11  *
  12  * Jalview is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty
  14  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  15  * PURPOSE.  See the GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
  19  * The Jalview Authors are detailed in the 'AUTHORS' file.
  20  */
  21 package jalview.util;
  22
  23 import java.io.File;
  24 import java.io.IOException;
  25 import java.util.jar.JarInputStream;
  26
  27 /**
  28  * input stream provider interface to be implemented by any non-file or URL
  29  * datasources so that all Jar entries can be read from the datasource by
  30  * repeatedly re-opening the JarInputStream.
  31  *
  32  * This is a workaround necessary because castor's unmarshaller will close the
  33  * input stream after an unmarshalling session, which normally closes the whole
  34  * Jar input stream, not just the current JarEntry's stream.
  35  */
  36 public interface jarInputStreamProvider
  37 {
  38   /**
  39    * @return properly initialized jar input stream
  40    */
  41   JarInputStream getJarInputStream() throws IOException;
  42
  43   /**
  44    *
  45    * @return human readable name for datasource used when reporting any problems
  46    *         with it
  47    */
  48   String getFilename();
  49
  50   /**
  51    * @return jarFile name if from SwingJS
  52    */
  53   File getFile();
  54 }