Package org.openhab.core.model.sitemap

Interface SitemapProvider

@NonNullByDefault
public interface SitemapProvider

Method Summary

Modifier and Type	Method	Description
void	addModelChangeListener(ModelRepositoryChangeListener listener)	Add a listener which will be informed subsequently once a model has changed
@Nullable Sitemap	getSitemap(String sitemapName)	This method provides access to sitemap model files, loads them and returns the object model tree.
Set<String>	getSitemapNames()	Returns the names of all available sitemaps
void	removeModelChangeListener(ModelRepositoryChangeListener listener)	Remove a model change listener again

Method Details

getSitemap

@Nullable Sitemap getSitemap(String sitemapName)

This method provides access to sitemap model files, loads them and returns the object model tree.

Parameters:

sitemapName - the name of the sitemap to load

Returns:

the object model tree, null if it is not found

getSitemapNames

Set<String> getSitemapNames()

Returns the names of all available sitemaps

Returns:

names of provided sitemaps

addModelChangeListener

void addModelChangeListener(ModelRepositoryChangeListener listener)

Add a listener which will be informed subsequently once a model has changed

Parameters:

listener -

removeModelChangeListener

void removeModelChangeListener(ModelRepositoryChangeListener listener)

Remove a model change listener again

Parameters:

listener -