Merge branch 'spotless_2' into JAL-1551_2_11_3_spotlett
[jalview.git] / 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.IOException;
24 import java.util.jar.JarInputStream;
25
26 /**
27  * input stream provider interface to be implemented by any non-file or URL
28  * datasources so that all Jar entries can be read from the datasource by
29  * repeatedly re-opening the JarInputStream.
30  * 
31  * This is a workaround necessary because castor's unmarshaller will close the
32  * input stream after an unmarshalling session, which normally closes the whole
33  * Jar input stream, not just the current JarEntry's stream.
34  */
35 public interface jarInputStreamProvider
36 {
37   /**
38    * @return properly initialized jar input stream
39    */
40   JarInputStream getJarInputStream() throws IOException;
41
42   /**
43    * 
44    * @return human readable name for datasource used when reporting any problems
45    *         with it
46    */
47   String getFilename();
48 }