Class BindingInfo

    • Field Detail

      • DEFAULT_SERVICE_ID_PREFIX

        public static final String DEFAULT_SERVICE_ID_PREFIX
        The default service ID prefix.
        See Also:
        Constant Field Values
    • Constructor Detail

      • BindingInfo

        public BindingInfo​(String id,
                           String name,
                           @Nullable String description,
                           @Nullable String author,
                           @Nullable String serviceId,
                           @Nullable URI configDescriptionURI)
                    throws IllegalArgumentException
        Creates a new instance of this class with the specified parameters.
        Parameters:
        id - the identifier for the binding (must neither be null, nor empty)
        name - a human readable name for the binding (must neither be null, nor empty)
        description - a human readable description for the binding (could be null or empty)
        author - the author of the binding (could be null or empty)
        serviceId - the service id of the main service of the binding (can be null)
        configDescriptionURI - the link to a concrete ConfigDescription (could be null)
        Throws:
        IllegalArgumentException - if the identifier or the name are null or empty
    • Method Detail

      • getUID

        public String getUID()
        Returns an identifier for the binding (e.g. "hue").
        Specified by:
        getUID in interface Identifiable<String>
        Returns:
        an identifier for the binding (neither null, nor empty)
      • getName

        public String getName()
        Returns a human readable name for the binding (e.g. "HUE Binding").
        Returns:
        a human readable name for the binding (neither null, nor empty)
      • getDescription

        public @Nullable String getDescription()
        Returns a human readable description for the binding (e.g. "Discovers and controls HUE bulbs").
        Returns:
        a human readable description for the binding (could be null or empty)
      • getAuthor

        public @Nullable String getAuthor()
        Returns the author of the binding (e.g. "Max Mustermann").
        Returns:
        the author of the binding (could be null or empty)
      • getServiceId

        public String getServiceId()
        Returns the service ID of the bindings main service, that can be configured.
        Returns:
        service ID
      • getConfigDescriptionURI

        public @Nullable URI getConfigDescriptionURI()
        Returns the link to a concrete ConfigDescription.
        Returns:
        the link to a concrete ConfigDescription (could be null)