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

Interface RootUIComponentParser

All Superinterfaces:

ObjectParser<UIComponent>, UIComponentParser

@NonNullByDefault
public interface RootUIComponentParser
extends UIComponentParser

RootUIComponentParser is the interface to implement by any format parser for RootUIComponent objects.

Author:

Ravi Nadahar - Initial contribution

Method Summary

Modifier and Type	Method	Description
Collection<? extends RootUIComponent>	getParsedObjects(String modelName)	Get a copy of the collection of RootUIComponent objects that were found when parsing the format.

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

finishParsingFormat, getParserFormat

Methods inherited from interface org.openhab.core.ui.components.converter.UIComponentParser

startParsingFormat

Method Details

getParsedObjects

Collection<? extends RootUIComponent> getParsedObjects(String modelName)

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

Specified by:

getParsedObjects in interface ObjectParser<UIComponent>

Specified by:

getParsedObjects in interface UIComponentParser

Parameters:

modelName - the model name used when parsing.

Returns:

The Collection of RootUIComponents.

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.