1 /*
2 * IncludeModuleCfg.java
3 * Created on September 19, 2003
4 *
5 * The Blues Framework - A lightweight application framework
6 * Copyright (C) 2003 Lonnie Pryor
7 * http://blues.lonniepryor.com
8 *
9 * This library is free software; you can redistribute it and/or modify it under the
10 * terms of the GNU Lesser General Public License as published by the Free Software
11 * Foundation; either version 2.1 of the License, or (at your option) any later
12 * version.
13 *
14 * This library is distributed in the hope that it will be useful, but WITHOUT ANY
15 * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
16 * PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
17 *
18 * You should have received a copy of the GNU Lesser General Public License along
19 * with this library; if not, write to:
20 *
21 * The Free Software Foundation, Inc.
22 * 59 Temple Place, Suite 330
23 * Boston, MA 02111-1307 USA
24 *
25 */
26 package com.lonniepryor.blues.cfg;
27
28 /***
29 * Defines the requirements for a Blues include configuration.
30 *
31 * @author Lonnie Pryor
32 * @version $Revision: 1.1 $
33 */
34 public interface IncludeCfg {
35 /***
36 * Returns the name of this include.
37 *
38 * @return The name of this include.
39 */
40 String getName ();
41
42 /***
43 * Returns the path to the module configuration file.
44 *
45 * @return The path to the module configuration file.
46 */
47 String getModulePath ();
48
49 /***
50 * Returns all of the variable names declared in this include.
51 *
52 * @return All of the variable names declared in this include.
53 */
54 public String[] getVariableNames ();
55
56 /***
57 * Returns the refrence to use for the specified variable name.
58 *
59 * @param variableName The name of the variable to resolve.
60 *
61 * @return The refrence to use for the specified variable name.
62 */
63 public String getVariableRefrence (String variableName);
64
65 /***
66 * Initalizes the refrence to the included module once it is loaded.
67 *
68 * @param module The included module.
69 */
70 void initIncludedModule (ModuleCfg module);
71
72 /***
73 * Returns the included module.
74 *
75 * @return The included module.
76 */
77 ModuleCfg getIncludedModule ();
78 }
This page was automatically generated by Maven