rebuilding head
[mir.git] / source / mir / bundle / BundleLoader.java
1 /*
2  * Copyright (C) 2001, 2002 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  * The Sun (tm) Java Advanced Imaging library (JAI), The Sun JIMI library
23  * (or with modified versions of the above that use the same license as the above),
24  * and distribute linked combinations including the two.  You must obey the
25  * GNU General Public License in all respects for all of the code used other than
26  * the above mentioned libraries.  If you modify this file, you may extend this
27  * exception to your version of the file, but you are not obligated to do so.
28  * If you do not wish to do so, delete this exception statement from your version.
29  */
30 package mir.bundle;
31
32 /**
33  * <p>
34  * The BundleLoader is responsible for the physical loading of (abstract)
35  * {@link Bundle}s. A <code>Bundle</code> is identified by a directory
36  * and a set of parameters. The directory typically denotes the base of
37  * a set of <code>Bundles</code>, the parameters stand for a particular
38  * instance. E.g. the directory might stand for the purpose of the bundles,
39  * the parameters for the locale.
40  * </p>
41  * <p>
42  * <code>BundleLoader</code>s should not do any caching, since that's the
43  * responsibility of the {@link BasicBundleFactory}.
44  * </p>
45  */
46 public interface BundleLoader {
47   /**
48    * Loads the bundle specified by <code>aDirectory</code> and
49    * <code>aParameters</code>.
50    */
51   public Bundle loadBundle(String aDirectory, String[] aParameters);
52 }