Package jadex.bridge.nonfunctional

Interface INFPropertyProvider

    • Method Detail

      • getNFPropertyNames

        IFuture<java.lang.String[]> getNFPropertyNames()
        Returns the declared names of all non-functional properties of this service.
        Returns:
        The names of the non-functional properties of this service.

      • getNFAllPropertyNames

        IFuture<java.lang.String[]> getNFAllPropertyNames()
        Returns the names of all non-functional properties of this service.
        Returns:
        The names of the non-functional properties of this service.

      • getNFPropertyMetaInfos

        IFuture<java.util.Map<java.lang.String,​INFPropertyMetaInfo>> getNFPropertyMetaInfos()
        Returns the meta information about a non-functional property of this service.
        Parameters:
        name - Name of the property.
        Returns:
        The meta information about a non-functional property of this service.

      • getNFPropertyMetaInfo

        IFuture<INFPropertyMetaInfo> getNFPropertyMetaInfo​(java.lang.String name)
        Returns the meta information about a non-functional property of this service.
        Parameters:
        name - Name of the property.
        Returns:
        The meta information about a non-functional property of this service.

      • getNFPropertyValue

        <T> IFuture<T> getNFPropertyValue​(java.lang.String name)
        Returns the current value of a non-functional property of this service.
        Parameters:
        name - Name of the property.
        type - Type of the property value.
        Returns:
        The current value of a non-functional property of this service.

      • getNFPropertyValue

        <T,​U> IFuture<T> getNFPropertyValue​(java.lang.String name,
                                          U unit)
        Returns the current value of a non-functional property of this service, performs unit conversion.
        Parameters:
        name - Name of the property.
        type - Type of the property value.
        unit - Unit of the property value.
        Returns:
        The current value of a non-functional property of this service.

      • getNFPropertyPrettyPrintValue

        IFuture<java.lang.String> getNFPropertyPrettyPrintValue​(java.lang.String name)
        Returns the current value of a non-functional property of this service.
        Parameters:
        name - Name of the property.
        type - Type of the property value.
        Returns:
        The current value of a non-functional property of this service.

      • addNFProperty

        IFuture<java.lang.Void> addNFProperty​(INFProperty<?,​?> nfprop)
        Add a non-functional property.
        Parameters:
        nfprop - The property.

      • removeNFProperty

        IFuture<java.lang.Void> removeNFProperty​(java.lang.String name)
        Remove a non-functional property.
        Parameters:
        The - name.

      • shutdownNFPropertyProvider

        IFuture<java.lang.Void> shutdownNFPropertyProvider()
        Shutdown the provider.