org.igfay.jfig
Interface JFigLocatorIF

All Known Implementing Classes:

JFigLocator

public interface JFigLocatorIF

Author:

conrad4 Locate the intial Configuration file. Users may write their own implementation of JFigLocatorIF with their own scheme of finding the initial configuration file. Best method may be to subclass the JFig implementation. Then, initialize JFig via: getInstance(JFigLocatorIF), passing your implementation.

Method Summary

java.lang.String	getConfigFileName() Return the config fileName.
java.lang.String	getConfigLocation()
java.lang.String	getDefaultConfigFileName() Return a default config file name.
java.io.InputStream	getInputStream()
void	setConfigFileName(java.lang.String value)
void	setConfigLocation(java.lang.String value) Set the config location; must be FILE or CLASSPATH.
void	setDefaultConfigFileName(java.lang.String value)

Method Detail

getConfigFileName

public java.lang.String getConfigFileName()

Return the config fileName. This will be the last file processed.

setConfigFileName

public void setConfigFileName(java.lang.String value)

getConfigLocation

public java.lang.String getConfigLocation()
                                   throws JFigException

Throws:

JFigException

setConfigLocation

public void setConfigLocation(java.lang.String value)
                       throws JFigException

Set the config location; must be FILE or CLASSPATH. If not, throw exception

Parameters:

value -

Throws:

JFigException

getDefaultConfigFileName

public java.lang.String getDefaultConfigFileName()

Return a default config file name. Can be modified by any JFigLocatorIF implementation.

Returns:

setDefaultConfigFileName

public void setDefaultConfigFileName(java.lang.String value)

getInputStream

public java.io.InputStream getInputStream()
                                   throws JFigException

Throws:

JFigException