aab8e20cd1e985c47e44f7fc701b8863fa64ddae
[mir.git] / source / mir / bundle / BundleLoader.java
1 /*
2  * Copyright (C) 2005 The Mir-coders group
3  *
4  * This file is part of Mir.
5  *
6  * Mir is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 2 of the License, or
9  * (at your option) any later version.
10  *
11  * Mir is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with Mir; if not, write to the Free Software
18  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
19  *
20  * In addition, as a special exception, The Mir-coders gives permission to link
21  * the code of this program with  any library licensed under the Apache Software License.
22  * You must obey the GNU General Public License in all respects for all of the code used
23  * other than the above mentioned libraries.  If you modify this file, you may extend this
24  * exception to your version of the file, but you are not obligated to do so.
25  * If you do not wish to do so, delete this exception statement from your version.
26  */
27 package mir.bundle;
28
29 /**
30  * <p>
31  * The BundleLoader is responsible for the physical loading of (abstract)
32  * {@link Bundle}s. A <code>Bundle</code> is identified by a directory
33  * and a set of parameters. The directory typically denotes the base of
34  * a set of <code>Bundles</code>, the parameters stand for a particular
35  * instance. E.g. the directory might stand for the purpose of the bundles,
36  * the parameters for the locale.
37  * </p>
38  * <p>
39  * <code>BundleLoader</code>s should not do any caching, since that's the
40  * responsibility of the {@link BasicBundleFactory}.
41  * </p>
42  */
43 public interface BundleLoader {
44   /**
45    * Loads the bundle specified by <code>aDirectory</code> and
46    * <code>aParameters</code>.
47    */
48   public Bundle loadBundle(String aDirectory, String[] aParameters);
49 }