KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > objectweb > kilim > repository > Repository


1 /**
2  * Copyright (C) 2002 Kelua SA
3  *
4  * This library is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU Lesser General Public
6  * License as published by the Free Software Foundation; either
7  * version 2 of the License, or (at your option) any later version.
8  *
9  * This library is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12  * Lesser General Public License for more details.
13  *
14  * You should have received a copy of the GNU Lesser General Public
15  * License along with this library; if not, write to the Free Software
16  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17  */
18
19 package org.objectweb.kilim.repository;
20
21 import org.objectweb.kilim.KilimException;
22 import org.objectweb.kilim.description.TemplateDescription;
23
24
25 /**
26  * Kilim template repository. The interface implemented by all tools reading template descriptions.
27  * @author horn
28  */
29 public interface Repository {
30     
31     /** The file extension of XML Kilim configuration files */
32     public static final String JavaDoc KILIM_FILES_EXTENSION = ".kilim";
33     
34     /**
35      * Sets the repository resourceLoader.
36      * @param aResourceLoader : The resourceLoader to set
37      */
38     void setResourceLoader(ResourceLoader aResourceLoader);
39     
40     /**
41      * Returns the current repository resourceLoader.
42      * @return ResourceLoader
43      */
44     ResourceLoader getResourceLoader();
45
46    /**
47     * Method getTemplateDescription.
48     * @param resourceName : the name of the template to be loaded
49     * @return Template the loaded description template
50     * @throws ResourceNotFoundException if a required template can't be found
51     * @throws KilimException :
52     */
53    TemplateDescription getTemplateDescription(String JavaDoc resourceName) throws ResourceNotFoundException, KilimException;
54 }
55
Popular Tags