IInputStreamGenerator


1   /*
2    * @(#)IInputStreamGenerator.java
3    *
4    * Copyright (C) 2001,,2003 2002 Matt Albrecht
5    * groboclown@users.sourceforge.net
6    * http://groboutils.sourceforge.net
7    *
8    *  Permission is hereby granted, free of charge, to any person obtaining a
9    *  copy of this software and associated documentation files (the "Software"),
10   *  to deal in the Software without restriction, including without limitation
11   *  the rights to use, copy, modify, merge, publish, distribute, sublicense,
12   *  and/or sell copies of the Software, and to permit persons to whom the
13   *  Software is furnished to do so, subject to the following conditions:
14   *
15   *  The above copyright notice and this permission notice shall be included in
16   *  all copies or substantial portions of the Software.
17   *
18   *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19   *  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20   *  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
21   *  THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22   *  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
23   *  FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
24   *  DEALINGS IN THE SOFTWARE.
25   */
26  
27  package net.sourceforge.groboutils.util.io.v1;
28  
29  import java.io.InputStream  ;
30  import java.io.IOException  ;
31  
32  
33  
34  /**
35   * A type of class which can generate a new InputStream based on just a
36   * partial name.  Useful if a resource is loaded from a specific location
37   * (classpath resource, file system, URL, etc), and it references other
38   * resources which must be loaded relative to it.
39   * <P>
40   * The generators should be first created using the original full resource
41   * name.  Then, each stream generated is relative to that first resource
42   * location.  If the first resource location is requested, then it should
43   * be considered absolute (not relative to itself).
44   *
45   * @author   Matt Albrecht <a HREF="mailto:groboclown@users.sourceforge.net">groboclown@users.sourceforge.net</a>
46   * @since    0.9.1d Alpha (sometime in 2001)
47   * @version  $Date: 2003/05/19 20:31:47 $
48   */
49  public interface IInputStreamGenerator
50  {
51      public String   getFullName( String   relativeName );
52      
53      public InputStream   createInputStream( String   relativeName )
54              throws IOException  ;
55  }
56
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags