Package org.openhab.core.items.fileconverter

Interface ItemParser

All Superinterfaces:

ObjectParser<Item>

@NonNullByDefault
public interface ItemParser
extends ObjectParser<Item>

ItemParser is the interface to implement by any file parser for Item object.

Author:

Laurent Garnier - Initial contribution

Method Summary

Modifier and Type	Method	Description
Collection<Metadata>	getParsedMetadata(String modelName)	Get the Metadata objects found when parsing the format.
Collection<Item>	getParsedObjects(String modelName)	Get a copy of the collection Item objects that were found when parsing the format.
Map<String,String>	getParsedStateFormatters(String modelName)	Get the state formatters found when parsing the format.
@Nullable String	startParsingFormat(String syntax, List<String> errors, List<String> warnings)	Parse the provided syntax string without impacting the item and metadata registries.

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 item and metadata registries.

Specified by:

startParsingFormat in interface ObjectParser<Item>

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

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

Specified by:

getParsedObjects in interface ObjectParser<Item>

Parameters:

modelName - the model name used when parsing.

Returns:

The Collection of Items.

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.

getParsedMetadata

Collection<Metadata> getParsedMetadata(String modelName)

Get the Metadata objects found when parsing the format.

Parameters:

modelName - the model name used when parsing.

Returns:

The Collection of Metadata.

getParsedStateFormatters

Map<String,String> getParsedStateFormatters(String modelName)

Get the state formatters found when parsing the format.

Parameters:

modelName - the model name used when parsing.

Returns:

the state formatters as a Map per item name.