Package org.openhab.core.semantics

Interface SemanticTag

All Superinterfaces:
Identifiable<String>
All Known Implementing Classes:
SemanticTagImpl
@NonNullByDefault public interface SemanticTag extends Identifiable<String>
This interface defines the core features of an openHAB semantic tag.
Author:
Laurent Garnier - Initial contribution

  • Method Details

    • getName

      String getName()
      Returns the name of the semantic tag.
      Returns:
      the name of the semantic tag

    • getParentUID

      String getParentUID()
      Returns the UID of the parent tag.
      Returns:
      the UID of the parent tag

    • getLabel

      String getLabel()
      Returns the label of the semantic tag.
      Returns:
      semantic tag label or an empty string if undefined

    • getDescription

      String getDescription()
      Returns the description of the semantic tag.
      Returns:
      semantic tag description or an empty string if undefined

    • getSynonyms

      List<String> getSynonyms()
      Returns the synonyms of the semantic tag.
      Returns:
      semantic tag synonyms as a List

    • localized

      SemanticTag localized(Locale locale)
      Returns the localized semantic tag.
      Parameters:
      locale - the locale to be used
      Returns:
      the localized semantic tag