Package org.openhab.core.ui.components.converter

Interface UIComponentParser

All Superinterfaces:

ObjectParser<UIComponent>

All Known Subinterfaces:

RootUIComponentParser

@NonNullByDefault
public interface UIComponentParser
extends ObjectParser<UIComponent>

UIComponentParser is the interface to implement by any format parser for UIComponent objects.

Author:

Ravi Nadahar - Initial contribution

Method Summary

Modifier and Type	Method	Description
Collection<? extends UIComponent>	getParsedObjects(String modelName)	Get a copy of the collection of UIComponent 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 model.

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 model.

Specified by:

startParsingFormat in interface ObjectParser<UIComponent>

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<? extends UIComponent> getParsedObjects(String modelName)

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

Specified by:

getParsedObjects in interface ObjectParser<UIComponent>

Parameters:

modelName - the model name used when parsing.

Returns:

The Collection of UIComponents.

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.