Package org.openhab.core.sitemap.fileconverter

Interface SitemapParser

All Superinterfaces:

ObjectParser<Sitemap>

@NonNullByDefault
public interface SitemapParser
extends ObjectParser<Sitemap>

SitemapParser is the interface to implement by any Sitemap parser.

Author:

Mark Herwege - Initial contribution

Method Summary

Modifier and Type	Method	Description
Collection<Sitemap>	getParsedObjects(String modelName)	Get a copy of the collection of Sitemap objects that were found when parsing the format.
@Nullable String	startParsingFormat(String syntax, List<String> errors, List<String> warnings)	Parse the provided syntax string without impacting the sitemap registry.

Methods inherited from interface org.openhab.core.converter.ObjectParser

finishParsingFormat, getParserFormat

Method Details

startParsingFormat

@Nullable String startParsingFormat(String syntax,
 List<String> errors,
 List<String> warnings)

Parse the provided syntax string without impacting the sitemap registry.

Specified by:

startParsingFormat in interface ObjectParser<Sitemap>

Parameters:

syntax - the syntax in format.

errors - the List to use to report errors.

warnings - the List to be used to report warnings.

Returns:

The model name used for parsing if the parsing succeeded without errors; null otherwise.

getParsedObjects

Collection<Sitemap> getParsedObjects(String modelName)

Get a copy of the collection of Sitemap objects that were found when parsing the format.

Specified by:

getParsedObjects in interface ObjectParser<Sitemap>

Parameters:

modelName - the model name used when parsing.

Returns:

The Collection of Sitemaps.

Implementation note:

It's important that a copy of the Collection is returned, so that invoking ObjectParser.finishParsingFormat(String) doesn't modify the returned result.