org.jwarp.service.configuration
Interface IConfiguration

All Known Subinterfaces:

IFileConfiguration

All Known Implementing Classes:

AConfiguration

public interface IConfiguration

Interface implemented by all classes that represent some configuration information. The whole configuration in JWeb is based on XML. Properties are only used in some rare cases.

Version:

1.0

Author:

ORCA Systems GmbH, Martin Schäfer

Field Summary

static java.lang.String

ELEM_CONFIG xml root element id

Method Summary

org.jdom.Document	getDocument() Return the JDOM document of this configuration.
org.jdom.Element	getRootElement() Return the JDOM root element of this configuration.
boolean	isCheckingModification() Returns true, if the Configuration is checked for modifications and reparsed if needed.
void	setCheckingModification(boolean checkModification) Set if the Configuration should be checked for modifications and reparsed if needed.

Field Detail

ELEM_CONFIG

public static final java.lang.String ELEM_CONFIG

xml root element id

Method Detail

getRootElement

public org.jdom.Element getRootElement()
                                throws ConfigurationException

Return the JDOM root element of this configuration. If checkModification is enabled, the source document will be parsed if it has changed before the root element is returned.

getDocument

public org.jdom.Document getDocument()
                              throws ConfigurationException

Return the JDOM document of this configuration. If checkModification is enabled, the source document will be parsed if it has changed before the document is returned.

isCheckingModification

public boolean isCheckingModification()

Returns true, if the Configuration is checked for modifications and reparsed if needed.

setCheckingModification

public void setCheckingModification(boolean checkModification)

Set if the Configuration should be checked for modifications and reparsed if needed.

Parameters:

checkModification - If set to true, the modifications will be checked.