KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > igfay > jfig > JFigLocatorIF


1 package org.igfay.jfig;
2
3 import java.io.InputStream JavaDoc;
4
5 /**
6  * @author conrad4
7  *
8  * Locate the intial Configuration file.
9  * Users may write their own implementation of JFigLocatorIF with
10  * their own scheme of finding the initial configuration file.
11  *
12  * Best method may be to subclass the JFig implementation.
13  * Then, initialize JFig via: getInstance(JFigLocatorIF), passing your implementation.
14  */

15 public interface JFigLocatorIF {
16     /**
17      * Return the config fileName. This will be the last file processed.
18      */

19     public String JavaDoc getConfigFileName();
20     public void setConfigFileName(String JavaDoc value);
21     
22     public String JavaDoc getConfigLocation() throws JFigException;
23
24     /**
25      * Set the config location; must be FILE or CLASSPATH.
26      * If not, throw exception
27      *
28      * @param value
29      * @throws JFigException
30      */

31     public void setConfigLocation(String JavaDoc value) throws JFigException;
32
33     /**
34      * Return a default config file name.
35      * Can be modified by any JFigLocatorIF implementation.
36      * @return
37      */

38     public String JavaDoc getDefaultConfigFileName();
39     public void setDefaultConfigFileName(String JavaDoc value);
40
41     public InputStream JavaDoc getInputStream() throws JFigException;
42
43 }
Popular Tags