Class NFPropertyComponentFeature

    • Method Detail

      • hasUserBody

        public boolean hasUserBody()
        Check if the feature potentially executed user code in body. Allows blocking operations in user bodies by using separate steps for each feature. Non-user-body-features are directly executed for speed. If unsure just return true. ;-)
        Specified by:
        hasUserBody in interface IComponentFeature
        Overrides:
        hasUserBody in class AbstractComponentFeature
      • initNFProperties

        public jadex.commons.future.IFuture<java.lang.Void> initNFProperties​(IInternalService ser,
                                                                             java.lang.Class<?> impltype)
        Init the service and method nf properties.
      • addNFProperties

        public jadex.commons.future.IFuture<java.lang.Void> addNFProperties​(NFProperties nfprops,
                                                                            IService ser)
        Add nf properties from a type.
      • addTags

        public jadex.commons.future.IFuture<java.lang.Void> addTags​(Tags tags,
                                                                    IService ser)
        Add nf properties from a type.
      • addNFMethodProperties

        public jadex.commons.future.IFuture<java.lang.Void> addNFMethodProperties​(NFProperties nfprops,
                                                                                  IService ser,
                                                                                  jadex.commons.MethodInfo mi)
        Add nf properties from a type.
      • getNFPropertyNames

        public jadex.commons.future.IFuture<java.lang.String[]> getNFPropertyNames()
        Returns the declared names of all non-functional properties of this service.
        Specified by:
        getNFPropertyNames in interface IExternalNFPropertyComponentFeature
        Returns:
        The names of the non-functional properties of this service.
      • getNFAllPropertyNames

        public jadex.commons.future.IFuture<java.lang.String[]> getNFAllPropertyNames()
        Returns the names of all non-functional properties of this service.
        Specified by:
        getNFAllPropertyNames in interface IExternalNFPropertyComponentFeature
        Returns:
        The names of the non-functional properties of this service.
      • getNFPropertyMetaInfos

        public jadex.commons.future.IFuture<java.util.Map<java.lang.String,​INFPropertyMetaInfo>> getNFPropertyMetaInfos()
        Returns the meta information about a non-functional property of this service.
        Specified by:
        getNFPropertyMetaInfos in interface IExternalNFPropertyComponentFeature
        Parameters:
        name - Name of the property.
        Returns:
        The meta information about a non-functional property of this service.
      • getNFPropertyMetaInfo

        public jadex.commons.future.IFuture<INFPropertyMetaInfo> getNFPropertyMetaInfo​(java.lang.String name)
        Returns the meta information about a non-functional property of this service.
        Specified by:
        getNFPropertyMetaInfo in interface IExternalNFPropertyComponentFeature
        Parameters:
        name - Name of the property.
        Returns:
        The meta information about a non-functional property of this service.
      • getNFPropertyValue

        public <T> jadex.commons.future.IFuture<T> getNFPropertyValue​(java.lang.String name)
        Returns the current value of a non-functional property of this service.
        Specified by:
        getNFPropertyValue in interface IExternalNFPropertyComponentFeature
        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

        public <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.
        Specified by:
        getNFPropertyValue in interface IExternalNFPropertyComponentFeature
        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

        public jadex.commons.future.IFuture<java.lang.String> getNFPropertyPrettyPrintValue​(java.lang.String name)
        Returns the current value of a non-functional property of this component.
        Specified by:
        getNFPropertyPrettyPrintValue in interface IExternalNFPropertyComponentFeature
        Parameters:
        name - Name of the property.
        type - Type of the property value.
        Returns:
        The current value of a non-functional property of this component as string.
      • removeNFProperty

        public jadex.commons.future.IFuture<java.lang.Void> removeNFProperty​(java.lang.String name)
        Remove a non-functional property.
        Specified by:
        removeNFProperty in interface IExternalNFPropertyComponentFeature
        Parameters:
        The - name.
      • getNFPropertyNames

        public jadex.commons.future.IFuture<java.lang.String[]> getNFPropertyNames​(IServiceIdentifier sid)
        Returns the declared names of all non-functional properties of this service.
        Specified by:
        getNFPropertyNames in interface IExternalNFPropertyComponentFeature
        Returns:
        The names of the non-functional properties of this service.
      • getNFPropertyValue

        public <T> jadex.commons.future.IFuture<T> getNFPropertyValue​(IServiceIdentifier sid,
                                                                      java.lang.String name)
        Returns the current value of a non-functional property of this service.
        Specified by:
        getNFPropertyValue in interface IExternalNFPropertyComponentFeature
        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

        public <T,​U> jadex.commons.future.IFuture<T> getNFPropertyValue​(IServiceIdentifier sid,
                                                                              java.lang.String name,
                                                                              U unit)
        Returns the current value of a non-functional property of this service, performs unit conversion.
        Specified by:
        getNFPropertyValue in interface IExternalNFPropertyComponentFeature
        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

        public jadex.commons.future.IFuture<java.lang.String> getNFPropertyPrettyPrintValue​(IServiceIdentifier sid,
                                                                                            java.lang.String name)
        Returns the current value of a non-functional property of this service, performs unit conversion.
        Specified by:
        getNFPropertyPrettyPrintValue in interface IExternalNFPropertyComponentFeature
        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 as string.
      • getMethodNFPropertyNames

        public jadex.commons.future.IFuture<java.lang.String[]> getMethodNFPropertyNames​(IServiceIdentifier sid,
                                                                                         jadex.commons.MethodInfo method)
        Returns the names of all non-functional properties of the specified method.
        Specified by:
        getMethodNFPropertyNames in interface IExternalNFPropertyComponentFeature
        Parameters:
        method - The method targeted by this operation.
        Returns:
        The names of the non-functional properties of the specified method.
      • getMethodNFAllPropertyNames

        public jadex.commons.future.IFuture<java.lang.String[]> getMethodNFAllPropertyNames​(IServiceIdentifier sid,
                                                                                            jadex.commons.MethodInfo method)
        Returns the names of all non-functional properties of this method. This includes the properties of all parent components.
        Specified by:
        getMethodNFAllPropertyNames in interface IExternalNFPropertyComponentFeature
        Returns:
        The names of the non-functional properties of this method.
      • getMethodNFPropertyMetaInfo

        public jadex.commons.future.IFuture<INFPropertyMetaInfo> getMethodNFPropertyMetaInfo​(IServiceIdentifier sid,
                                                                                             jadex.commons.MethodInfo method,
                                                                                             java.lang.String name)
        Returns the meta information about a non-functional property of the specified method.
        Specified by:
        getMethodNFPropertyMetaInfo in interface IExternalNFPropertyComponentFeature
        Parameters:
        method - The public IFuture getMethodNFPropertyPrettyPrintValue(IServiceIdentifier sid, MethodInfo method, String name) { } method targeted by this operation.
        name - Name of the property.
        Returns:
        The meta information about a non-functional property of the specified method.
      • getMethodNFPropertyValue

        public <T> jadex.commons.future.IFuture<T> getMethodNFPropertyValue​(IServiceIdentifier sid,
                                                                            jadex.commons.MethodInfo method,
                                                                            java.lang.String name)
        Returns the current value of a non-functional property of the specified method.
        Specified by:
        getMethodNFPropertyValue in interface IExternalNFPropertyComponentFeature
        Parameters:
        method - The method targeted by this operation.
        name - Name of the property.
        type - Type of the property value.
        Returns:
        The current value of a non-functional property of the specified method.
      • getMethodNFPropertyValue

        public <T,​U> jadex.commons.future.IFuture<T> getMethodNFPropertyValue​(IServiceIdentifier sid,
                                                                                    jadex.commons.MethodInfo method,
                                                                                    java.lang.String name,
                                                                                    U unit)
        Returns the current value of a non-functional property of the specified method, performs unit conversion.
        Specified by:
        getMethodNFPropertyValue in interface IExternalNFPropertyComponentFeature
        Parameters:
        method - The method targeted by this operation.
        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 the specified method.
      • getMethodNFPropertyPrettyPrintValue

        public jadex.commons.future.IFuture<java.lang.String> getMethodNFPropertyPrettyPrintValue​(IServiceIdentifier sid,
                                                                                                  jadex.commons.MethodInfo method,
                                                                                                  java.lang.String name)
        Description copied from interface: IExternalNFPropertyComponentFeature
        Returns the current value of a non-functional property of the specified method, performs unit conversion.
        Specified by:
        getMethodNFPropertyPrettyPrintValue in interface IExternalNFPropertyComponentFeature
        method - The method targeted by this operation.
        name - Name of the property.
        Returns:
        The current value of a non-functional property of the specified method.
      • removeMethodNFProperty

        public jadex.commons.future.IFuture<java.lang.Void> removeMethodNFProperty​(IServiceIdentifier sid,
                                                                                   jadex.commons.MethodInfo method,
                                                                                   java.lang.String name)
        Remove a non-functional property.
        Specified by:
        removeMethodNFProperty in interface IExternalNFPropertyComponentFeature
        Parameters:
        method - The method targeted by this operation.
        The - name.
      • getRequiredNFPropertyValue

        public <T> jadex.commons.future.IFuture<T> getRequiredNFPropertyValue​(IServiceIdentifier sid,
                                                                              java.lang.String name)
        Returns the current value of a non-functional property of this service.
        Specified by:
        getRequiredNFPropertyValue in interface IExternalNFPropertyComponentFeature
        Parameters:
        name - Name of the property.
        type - Type of the property value.
        Returns:
        The current value of a non-functional property of this service.
      • getRequiredNFPropertyValue

        public <T,​U> jadex.commons.future.IFuture<T> getRequiredNFPropertyValue​(IServiceIdentifier sid,
                                                                                      java.lang.String name,
                                                                                      U unit)
        Returns the current value of a non-functional property of this service, performs unit conversion.
        Specified by:
        getRequiredNFPropertyValue in interface IExternalNFPropertyComponentFeature
        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.
      • getRequiredNFPropertyPrettyPrintValue

        public jadex.commons.future.IFuture<java.lang.String> getRequiredNFPropertyPrettyPrintValue​(IServiceIdentifier sid,
                                                                                                    java.lang.String name)
        Returns the current value of a non-functional property of this service.
        Specified by:
        getRequiredNFPropertyPrettyPrintValue in interface IExternalNFPropertyComponentFeature
        Parameters:
        name - Name of the property.
        type - Type of the property value.
        Returns:
        The current value of a non-functional property of this service.
      • getRequiredMethodNFPropertyNames

        public jadex.commons.future.IFuture<java.lang.String[]> getRequiredMethodNFPropertyNames​(IServiceIdentifier sid,
                                                                                                 jadex.commons.MethodInfo method)
        Returns the names of all non-functional properties of the specified method.
        Specified by:
        getRequiredMethodNFPropertyNames in interface IExternalNFPropertyComponentFeature
        Parameters:
        method - The method targeted by this operation.
        Returns:
        The names of the non-functional properties of the specified method.
      • getRequiredMethodNFAllPropertyNames

        public jadex.commons.future.IFuture<java.lang.String[]> getRequiredMethodNFAllPropertyNames​(IServiceIdentifier sid,
                                                                                                    jadex.commons.MethodInfo method)
        Returns the names of all non-functional properties of this method. This includes the properties of all parent components.
        Specified by:
        getRequiredMethodNFAllPropertyNames in interface IExternalNFPropertyComponentFeature
        Returns:
        The names of the non-functional properties of this method.
      • getRequiredMethodNFPropertyMetaInfo

        public jadex.commons.future.IFuture<INFPropertyMetaInfo> getRequiredMethodNFPropertyMetaInfo​(IServiceIdentifier sid,
                                                                                                     jadex.commons.MethodInfo method,
                                                                                                     java.lang.String name)
        Returns the meta information about a non-functional property of the specified method.
        Specified by:
        getRequiredMethodNFPropertyMetaInfo in interface IExternalNFPropertyComponentFeature
        Parameters:
        method - The method targeted by this operation.
        name - Name of the property.
        Returns:
        The meta information about a non-functional property of the specified method.
      • getRequiredMethodNFPropertyValue

        public <T> jadex.commons.future.IFuture<T> getRequiredMethodNFPropertyValue​(IServiceIdentifier sid,
                                                                                    jadex.commons.MethodInfo method,
                                                                                    java.lang.String name)
        Returns the current value of a non-functional property of the specified method.
        Specified by:
        getRequiredMethodNFPropertyValue in interface IExternalNFPropertyComponentFeature
        Parameters:
        method - The method targeted by this operation.
        name - Name of the property.
        type - Type of the property value.
        Returns:
        The current value of a non-functional property of the specified method.
      • getRequiredMethodNFPropertyValue

        public <T,​U> jadex.commons.future.IFuture<T> getRequiredMethodNFPropertyValue​(IServiceIdentifier sid,
                                                                                            jadex.commons.MethodInfo method,
                                                                                            java.lang.String name,
                                                                                            U unit)
        Returns the current value of a non-functional property of the specified method, performs unit conversion.
        Specified by:
        getRequiredMethodNFPropertyValue in interface IExternalNFPropertyComponentFeature
        Parameters:
        method - The method targeted by this operation.
        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 the specified method.
      • getRequiredMethodNFPropertyPrettyPrintValue

        public jadex.commons.future.IFuture<java.lang.String> getRequiredMethodNFPropertyPrettyPrintValue​(IServiceIdentifier sid,
                                                                                                          jadex.commons.MethodInfo method,
                                                                                                          java.lang.String name)
        Returns the current value of a non-functional property of the specified method, performs unit conversion.
        Specified by:
        getRequiredMethodNFPropertyPrettyPrintValue in interface IExternalNFPropertyComponentFeature
        Parameters:
        method - The method targeted by this operation.
        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 the specified method.