Package org.openhab.core.thing.fileconverter

Interface ThingParser

All Superinterfaces:

ObjectParser<Thing>

@NonNullByDefault
public interface ThingParser
extends ObjectParser<Thing>

ThingParser is the interface to implement by any Thing parser.

Author:

Laurent Garnier - Initial contribution

Method Summary

Modifier and Type	Method	Description
Collection<ItemChannelLink>	getParsedChannelLinks(String modelName)	Get the ItemChannelLink objects found when parsing the format.
Collection<Thing>	getParsedObjects(String modelName)	Get a copy of the collection of Thing 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 thing 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 thing registry.

Specified by:

startParsingFormat in interface ObjectParser<Thing>

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<Thing> getParsedObjects(String modelName)

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

Specified by:

getParsedObjects in interface ObjectParser<Thing>

Parameters:

modelName - the model name used when parsing.

Returns:

The Collection of Things.

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.

getParsedChannelLinks

Collection<ItemChannelLink> getParsedChannelLinks(String modelName)

Get the ItemChannelLink objects found when parsing the format.

Parameters:

modelName - the model name used when parsing.

Returns:

The Collection of ItemChannelLinks.