KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > jicengine > BuildContext


1 package org.jicengine;
2 import org.jicengine.io.Resource;
3 import java.util.Map JavaDoc;
4 import java.io.IOException JavaDoc;
5
6 /**
7  * <p>
8  * An interface for accessing the current build-context within
9  * JIC-files. An instance of this class is available by default in
10  * all JIC-files under the name 'buildContext'.
11  * </p>
12  * <p>
13  * BuildContext makes it possible to reference the current JIC-file,
14  * the build-attributes, etc. (in the future, this interface could be
15  * used for letting the JIC-files also customize their environment.)
16  * </p>
17  *
18  * <p>
19  * Copyright (C) 2004 Timo Laitinen
20  * </p>
21  *
22  * @author Timo Laitinen
23  * @created 2004-09-20
24  * @since JICE-0.10
25  *
26  */
27
28 public interface BuildContext {
29
30     public static final String JavaDoc VARIABLE_NAME = "jic::buildContext";
31
32     public Resource getResource(String JavaDoc relativePath) throws IOException JavaDoc;
33
34     public Resource getCurrentFile();
35
36     /**
37      *
38      */
39     public Map JavaDoc getParameters();
40
41     /**
42      *
43      */
44     public Object JavaDoc getParameter(String JavaDoc name) throws JICException;
45
46 }
47
Popular Tags