01: /*
02: * Copyright (c) 2004 JETA Software, Inc. All rights reserved.
03: *
04: * Redistribution and use in source and binary forms, with or without modification,
05: * are permitted provided that the following conditions are met:
06: *
07: * o Redistributions of source code must retain the above copyright notice,
08: * this list of conditions and the following disclaimer.
09: *
10: * o Redistributions in binary form must reproduce the above copyright notice,
11: * this list of conditions and the following disclaimer in the documentation
12: * and/or other materials provided with the distribution.
13: *
14: * o Neither the name of JETA Software nor the names of its contributors may
15: * be used to endorse or promote products derived from this software without
16: * specific prior written permission.
17: *
18: * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
19: * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20: * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
21: * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
22: * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
23: * INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
24: * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
25: * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26: * INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
27: * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28: */
29:
30: package com.jeta.open.resources;
31:
32: import java.io.IOException;
33: import java.io.InputStream;
34:
35: import javax.swing.ImageIcon;
36:
37: /**
38: * Defines a set of methods used to load resources such as images, property
39: * files, and other types of files from the CLASSPATH. It provides a layer of
40: * abstraction so the application is not bound to a particular loading stategy.
41: * Note that a full ClassLoader could be used instead, but this is a little
42: * easier to code with.
43: *
44: * @author Jeff Tassin
45: */
46: public interface ResourceLoader {
47: public static final String COMPONENT_ID = "jeta.resourceloader";
48:
49: /**
50: * Opens and returns an input stream for the given resourceName. The
51: * resourceName is relative to the application CLASSPATH (i.e. JAR file).
52: *
53: * @param resourceName
54: * the relative name of the resource to open
55: * @return an input stream for the given resourceName.
56: */
57: public InputStream getResourceAsStream(String resourceName)
58: throws IOException;
59:
60: /**
61: * Used to provide a custom class loader for certain cases. This is
62: * especially useful during development when we want the resource bundles to
63: * be loaded from the source directories or if you want to provide a custom
64: * class loader.
65: */
66: public ClassLoader getClassLoader();
67:
68: /**
69: * Utility method that loads an image from the CLASSPATH.
70: *
71: * @param imageName
72: * the subdirectory and name of image file (i.e.
73: * images/edit16.gif )
74: */
75: public ImageIcon loadImage(String imageName);
76:
77: /**
78: * Used to provide a custom class loader for certain cases. This is
79: * especially useful during development when we want the resource bundles to
80: * be loaded from the source directories
81: */
82: public void setClassLoader(ClassLoader loader);
83:
84: }
|