001: /*
002: * Copyright (C) 2005 Jeff Tassin
003: *
004: * This library is free software; you can redistribute it and/or
005: * modify it under the terms of the GNU Lesser General Public
006: * License as published by the Free Software Foundation; either
007: * version 2.1 of the License, or (at your option) any later version.
008: *
009: * This library is distributed in the hope that it will be useful,
010: * but WITHOUT ANY WARRANTY; without even the implied warranty of
011: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
012: * Lesser General Public License for more details.
013: *
014: * You should have received a copy of the GNU Lesser General Public
015: * License along with this library; if not, write to the Free Software
016: * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
017: */
018:
019: package com.jeta.swingbuilder.interfaces.resources;
020:
021: import java.io.IOException;
022: import java.io.InputStream;
023: import java.io.OutputStream;
024: import java.io.Reader;
025: import java.io.Writer;
026:
027: import javax.swing.ImageIcon;
028:
029: /**
030: * This interface is used to load resources for applications or applets
031: *
032: * @author Jeff Tassin
033: */
034: public interface ResourceLoader {
035: public static final String COMPONENT_ID = "jeta.ResourceLoader";
036:
037: /**
038: * Creates a resource(file) relative to the application directory e.g.
039: * createResource( "keybindings/emacs.xml" ); will create the file emacs.xml
040: * in the keybindings directory off of the main subdirectory
041: *
042: * @param resourceName
043: * a path and file name of the file to create.
044: */
045: public void createResource(String resourceName) throws IOException;
046:
047: /**
048: * @returns true if the given resource exists
049: */
050: public boolean exists(String resourceName) throws IOException;
051:
052: /**
053: * Creates a set of subdirectories under the main resources directory. e.g.
054: * createDirectories( "data/application" ); This will create the directory
055: * structure: TS_HOME/resources/data/application
056: */
057: public void createSubdirectories(String directories)
058: throws IOException;
059:
060: /**
061: * Deletes a named resource from disk or store
062: */
063: public void deleteResource(String resourceName) throws IOException;
064:
065: /**
066: * @return an output stream for the given resource name
067: */
068: public OutputStream getOutputStream(String resourceName)
069: throws IOException;
070:
071: /**
072: * @return an input stream for the given resource name
073: */
074: public InputStream getInputStream(String resourceName)
075: throws IOException;
076:
077: /**
078: * Opens and returns an input stream for the given resourceName. The
079: * resourceName is relative to the application CLASSPATH (i.e. JAR file).
080: *
081: * @param resourceName
082: * the relative name of the resource to open
083: * @return an input stream for the given resourceName.
084: */
085: public InputStream getPackagedInputStream(String resourceName)
086: throws IOException;
087:
088: /**
089: * @return a string reader for the given resource name
090: */
091: public Reader getReader(String resourceName) throws IOException;
092:
093: /**
094: * @return a string writer for the given resource name
095: */
096: public Writer getWriter(String resourceName) throws IOException;
097:
098: /**
099: * Used to provide a custom class loader for certain cases. This is
100: * especially useful during development when we want the resource bundles to
101: * be loaded from the source directories
102: */
103: public ClassLoader getClassLoader();
104:
105: /**
106: * @return the home directory for the application
107: */
108: public String getHomeDirectory();
109:
110: /**
111: * Lists all files that are found in the given subdirectory. The
112: * subdirectory is relative to the main application directory.
113: *
114: * @param subdirectory
115: * the subdirectory whose file names we are going to return. Only
116: * the name of the file is returned (no path information)
117: * @param regexFilter
118: * this is a regular expression filter that you can use to locate
119: * the files
120: */
121: public String[] listFiles(String subdirectory, String regexFilter)
122: throws IOException;
123:
124: /**
125: * Utility method that loads an image.
126: *
127: * @param imageName
128: * the subdirectory and name of image file (i.e.
129: * images/edit16.png )
130: */
131: public ImageIcon loadImage(String imageName);
132:
133: /**
134: * Used to provide a custom class loader for certain cases. This is
135: * especially useful during development when we want the resource bundles to
136: * be loaded from the source directories
137: */
138: public void setClassLoader(ClassLoader loader);
139:
140: }
|