Package jadex.bridge.nonfunctional

Interface INFPropertyProvider

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      jadex.commons.future.IFuture<java.lang.Void> addNFProperty​(INFProperty<?,​?> nfprop)
      Add a non-functional property.
      jadex.commons.future.IFuture<java.lang.String[]> getNFAllPropertyNames()
      Returns the names of all non-functional properties of this service.
      jadex.commons.future.IFuture<INFPropertyMetaInfo> getNFPropertyMetaInfo​(java.lang.String name)
      Returns the meta information about a non-functional property of this service.
      jadex.commons.future.IFuture<java.util.Map<java.lang.String,​INFPropertyMetaInfo>> getNFPropertyMetaInfos()
      Returns the meta information about a non-functional property of this service.
      jadex.commons.future.IFuture<java.lang.String[]> getNFPropertyNames()
      Returns the declared names of all non-functional properties of this service.
      jadex.commons.future.IFuture<java.lang.String> getNFPropertyPrettyPrintValue​(java.lang.String name)
      Returns the current value of a non-functional property of this service.
      <T> jadex.commons.future.IFuture<T> getNFPropertyValue​(java.lang.String name)
      Returns the current value of a non-functional property of this service.
      <T,​U>
      jadex.commons.future.IFuture<T>      		 getNFPropertyValue​(java.lang.String name, U unit)
      Returns the current value of a non-functional property of this service, performs unit conversion.
      jadex.commons.future.IFuture<java.lang.Void> removeNFProperty​(java.lang.String name)
      Remove a non-functional property.
      jadex.commons.future.IFuture<java.lang.Void> shutdownNFPropertyProvider()
      Shutdown the provider.

    • Method Detail

      • getNFPropertyNames

        jadex.commons.future.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

        jadex.commons.future.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

        jadex.commons.future.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

        jadex.commons.future.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> jadex.commons.future.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> jadex.commons.future.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

        jadex.commons.future.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

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

      • removeNFProperty

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

      • shutdownNFPropertyProvider

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