Package org.openhab.core.config.core.xml

Class ConfigXmlConfigDescriptionProvider

java.lang.Object

org.openhab.core.config.core.xml.AbstractXmlBasedProvider<URI,ConfigDescription>

org.openhab.core.config.core.xml.AbstractXmlConfigDescriptionProvider

org.openhab.core.config.core.xml.ConfigXmlConfigDescriptionProvider

All Implemented Interfaces:

ConfigDescriptionProvider, XmlDocumentProviderFactory<List<ConfigDescription>>

@NonNullByDefault
public class ConfigXmlConfigDescriptionProvider
extends AbstractXmlConfigDescriptionProvider
implements XmlDocumentProviderFactory<List<ConfigDescription>>

Provides ConfigDescriptions for configurations which are read from XML files.

Author:

Simon Kaufmann - Initial contribution

Field Summary

Fields

Modifier and Type	Field	Description
static final String	READY_MARKER

Constructor Summary

Constructors

Constructor	Description
ConfigXmlConfigDescriptionProvider(ConfigI18nLocalizationService configI18nService, ReadyService readyService)

Method Summary

Modifier and Type	Method	Description
void	activate(org.osgi.service.component.ComponentContext componentContext)
XmlDocumentProvider<List<ConfigDescription>>	createDocumentProvider(org.osgi.framework.Bundle bundle)	Creates an XML document provider for the specified module which is used to process any result objects from the XML conversion.
void	deactivate()
protected ConfigI18nLocalizationService	getConfigI18nLocalizerService()

Methods inherited from class org.openhab.core.config.core.xml.AbstractXmlConfigDescriptionProvider

getConfigDescription, getConfigDescriptions, localize

Methods inherited from class org.openhab.core.config.core.xml.AbstractXmlBasedProvider

add, addAll, get, getAll, removeAll

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

READY_MARKER

public static final String READY_MARKER

See Also:

• Constant Field Values

Constructor Details

ConfigXmlConfigDescriptionProvider

public ConfigXmlConfigDescriptionProvider(ConfigI18nLocalizationService configI18nService,
 ReadyService readyService)

Method Details

activate

public void activate(org.osgi.service.component.ComponentContext componentContext)

deactivate

public void deactivate()

getConfigI18nLocalizerService

protected ConfigI18nLocalizationService getConfigI18nLocalizerService()

Specified by:

getConfigI18nLocalizerService in class AbstractXmlConfigDescriptionProvider

createDocumentProvider

public XmlDocumentProvider<List<ConfigDescription>> createDocumentProvider(org.osgi.framework.Bundle bundle)

Description copied from interface: XmlDocumentProviderFactory

Creates an XML document provider for the specified module which is used to process any result objects from the XML conversion.

Specified by:

createDocumentProvider in interface XmlDocumentProviderFactory<List<ConfigDescription>>

Parameters:

bundle - the module for which the provider must be created (must not be null)

Returns:

the created provider for the specified module (must not be null)