Package org.openhab.core.config.core.status

Class ConfigStatusInfo

java.lang.Object
org.openhab.core.config.core.status.ConfigStatusInfo
@NonNullByDefault public final class ConfigStatusInfo extends Object
The ConfigStatusInfo contains ConfigStatusMessages to represent the current configuration status of an entity. Furthermore it provides some convenience operations to filter for specific ConfigStatusMessages.
Author:
Thomas Höfer - Initial contribution

  • Constructor Details

    • ConfigStatusInfo

      public ConfigStatusInfo()
      Creates a new ConfigStatusInfo.

    • ConfigStatusInfo

      public ConfigStatusInfo(Collection<ConfigStatusMessage> configStatusMessages)
      Creates a new ConfigStatusInfo with the given ConfigStatusMessages.
      Parameters:
      configStatusMessages - the configuration status messages to be added

  • Method Details

    • getConfigStatusMessages

      public Collection<ConfigStatusMessage> getConfigStatusMessages()
      Retrieves all configuration status messages.
      Returns:
      an unmodifiable collection of available configuration status messages

    • getConfigStatusMessages

      public Collection<ConfigStatusMessage> getConfigStatusMessages(ConfigStatusMessage.Type... types)
      Retrieves all configuration status messages that have one of the given types.
      Parameters:
      types - the types to be filtered for; if empty then all messages are delivered
      Returns:
      an unmodifiable collection of the corresponding configuration status messages

    • getConfigStatusMessages

      public Collection<ConfigStatusMessage> getConfigStatusMessages(String... parameterNames)
      Retrieves all configuration status messages that have one of the given parameter names.
      Parameters:
      parameterNames - the parameter names to be filtered for; if empty then all messages are delivered
      Returns:
      an unmodifiable collection of the corresponding configuration status messages

    • getConfigStatusMessages

      public Collection<ConfigStatusMessage> getConfigStatusMessages(Collection<ConfigStatusMessage.Type> types, Collection<String> parameterNames)
      Retrieves all configuration status messages that have one of the given parameter names or types.
      Parameters:
      types - the types to be filtered for (must not be null)
      parameterNames - the parameter names to be filtered for (must not be null)
      Returns:
      an unmodifiable collection of the corresponding configuration status messages
      Throws:
      NullPointerException - if one of types or parameter names collection is empty

    • add

      public void add(ConfigStatusMessage configStatusMessage)
      Adds the given ConfigStatusMessage.
      Parameters:
      configStatusMessage - the configuration status message to be added
      Throws:
      IllegalArgumentException - if given configuration status message is null

    • add

      public void add(Collection<ConfigStatusMessage> configStatusMessages)
      Adds the given given ConfigStatusMessages.
      Parameters:
      configStatusMessages - the configuration status messages to be added
      Throws:
      IllegalArgumentException - if given collection is null

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public boolean equals(@Nullable Object obj)
      Overrides:
      equals in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object