forked from eclipse-archived/smarthome
/
SitemapProvider.java
50 lines (42 loc) · 1.42 KB
/
SitemapProvider.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
/**
* Copyright (c) 2014,2018 Contributors to the Eclipse Foundation
*
* See the NOTICE file(s) distributed with this work for additional
* information regarding copyright ownership.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License 2.0 which is available at
* http://www.eclipse.org/legal/epl-2.0
*
* SPDX-License-Identifier: EPL-2.0
*/
package org.eclipse.smarthome.model.sitemap;
import java.util.Set;
import org.eclipse.smarthome.model.core.ModelRepositoryChangeListener;
public interface SitemapProvider {
/**
* This method provides access to sitemap model files, loads them and returns the object model tree.
*
* @param sitemapName the name of the sitemap to load
* @return the object model tree, null if it is not found
*/
Sitemap getSitemap(String sitemapName);
/**
* Returns the names of all available sitemaps
*
* @return names of provided sitemaps
*/
Set<String> getSitemapNames();
/**
* Add a listener which will be informed subsequently once a model has changed
*
* @param listener
*/
void addModelChangeListener(ModelRepositoryChangeListener listener);
/**
* Remove a model change listener again
*
* @param listener
*/
void removeModelChangeListener(ModelRepositoryChangeListener listener);
}