jadex.bridge.nonfunctional

Class SNFPropertyProvider

java.lang.Object

jadex.bridge.nonfunctional.SNFPropertyProvider

public class SNFPropertyProvider
extends java.lang.Object

Static helper class for accessing nf properties also remotely.

Constructor Summary

Constructors

Constructor and Description
SNFPropertyProvider()

Method Summary

Modifier and Type	Method and Description
static IFuture<java.lang.Void>	addMethodNFProperty(IExternalAccess component, IServiceIdentifier sid, MethodInfo method, INFProperty<?,?> nfprop) Add a non-functional property.
static IFuture<java.lang.Void>	addNFProperty(IExternalAccess component, INFProperty<?,?> nfprop) Add a non-functional property.
static IFuture<java.lang.Void>	addNFProperty(IExternalAccess component, IServiceIdentifier sid, INFProperty<?,?> nfprop) Add a non-functional property.
static IFuture<java.lang.Void>	addRequiredMethodNFProperty(IExternalAccess component, IServiceIdentifier sid, MethodInfo method, INFProperty<?,?> nfprop) Add a non-functional property.
static IFuture<java.lang.Void>	addRequiredNFProperty(IExternalAccess component, IServiceIdentifier sid, INFProperty<?,?> nfprop) Add a non-functional property.
static IFuture<java.lang.String[]>	getMethodNFAllPropertyNames(IExternalAccess component, IServiceIdentifier sid, MethodInfo method) Returns the names of all non-functional properties of this method.
static IFuture<INFPropertyMetaInfo>	getMethodNFPropertyMetaInfo(IExternalAccess component, IServiceIdentifier sid, MethodInfo method, java.lang.String name) Returns the meta information about a non-functional property of the specified method.
static IFuture<java.util.Map<MethodInfo,java.util.Map<java.lang.String,INFPropertyMetaInfo>>>	getMethodNFPropertyMetaInfos(IExternalAccess component, IServiceIdentifier sid) Returns meta information about a non-functional properties of all methods.
static IFuture<java.util.Map<java.lang.String,INFPropertyMetaInfo>>	getMethodNFPropertyMetaInfos(IExternalAccess component, IServiceIdentifier sid, MethodInfo method) Returns meta information about a non-functional properties of a method.
static IFuture<java.lang.String[]>	getMethodNFPropertyNames(IExternalAccess component, IServiceIdentifier sid, MethodInfo method) Returns the names of all non-functional properties of the specified method.
static <T> IFuture<T>	getMethodNFPropertyValue(IExternalAccess component, IServiceIdentifier sid, MethodInfo method, java.lang.String name) Returns the current value of a non-functional property of the specified method.
static <T,U> IFuture<T>	getMethodNFPropertyValue(IExternalAccess component, IServiceIdentifier sid, MethodInfo method, java.lang.String name, U unit) Returns the current value of a non-functional property of the specified method, performs unit conversion.
static IFuture<java.lang.String[]>	getNFAllPropertyNames(IExternalAccess component) Returns the names of all non-functional properties of this service.
static IFuture<java.lang.String[]>	getNFAllPropertyNames(IExternalAccess component, IServiceIdentifier sid) Returns the names of all non-functional properties of this service.
static IFuture<INFPropertyMetaInfo>	getNFPropertyMetaInfo(IExternalAccess component, IServiceIdentifier sid, java.lang.String name) Returns the meta information about a non-functional property of this service.
static IFuture<INFPropertyMetaInfo>	getNFPropertyMetaInfo(IExternalAccess component, java.lang.String name) Returns the meta information about a non-functional property of this service.
static IFuture<java.util.Map<java.lang.String,INFPropertyMetaInfo>>	getNFPropertyMetaInfos(IExternalAccess component) Returns the meta information about a non-functional property of this service.
static IFuture<java.util.Map<java.lang.String,INFPropertyMetaInfo>>	getNFPropertyMetaInfos(IExternalAccess component, IServiceIdentifier sid) Returns the meta information about a non-functional property of this service.
static IFuture<java.lang.String[]>	getNFPropertyNames(IExternalAccess component) Returns the declared names of all non-functional properties of this service.
static IFuture<java.lang.String[]>	getNFPropertyNames(IExternalAccess component, IServiceIdentifier sid) Returns the declared names of all non-functional properties of this service.
static <T> IFuture<T>	getNFPropertyValue(IExternalAccess component, IServiceIdentifier sid, java.lang.String name) Returns the current value of a non-functional property of this service.
static <T,U> IFuture<T>	getNFPropertyValue(IExternalAccess component, IServiceIdentifier sid, java.lang.String name, U unit) Returns the current value of a non-functional property of this service, performs unit conversion.
static <T> IFuture<T>	getNFPropertyValue(IExternalAccess component, java.lang.String name) Returns the current value of a non-functional property of this service.
static <T,U> IFuture<T>	getNFPropertyValue(IExternalAccess component, java.lang.String name, U unit) Returns the current value of a non-functional property of this service, performs unit conversion.
static IFuture<java.lang.String[]>	getRequiredMethodNFAllPropertyNames(IExternalAccess component, IServiceIdentifier sid, MethodInfo method) Returns the names of all non-functional properties of this method.
static IFuture<INFPropertyMetaInfo>	getRequiredMethodNFPropertyMetaInfo(IExternalAccess component, IServiceIdentifier sid, MethodInfo method, java.lang.String name) Returns the meta information about a non-functional property of the specified method.
static IFuture<java.util.Map<MethodInfo,java.util.Map<java.lang.String,INFPropertyMetaInfo>>>	getRequiredMethodNFPropertyMetaInfos(IExternalAccess component, IServiceIdentifier sid) Returns meta information about a non-functional properties of all methods.
static IFuture<java.util.Map<java.lang.String,INFPropertyMetaInfo>>	getRequiredMethodNFPropertyMetaInfos(IExternalAccess component, IServiceIdentifier sid, MethodInfo method) Returns meta information about a non-functional properties of a method.
static IFuture<java.lang.String[]>	getRequiredMethodNFPropertyNames(IExternalAccess component, IServiceIdentifier sid, MethodInfo method) Returns the names of all non-functional properties of the specified method.
static <T> IFuture<T>	getRequiredMethodNFPropertyValue(IExternalAccess component, IServiceIdentifier sid, MethodInfo method, java.lang.String name) Returns the current value of a non-functional property of the specified method.
static <T,U> IFuture<T>	getRequiredMethodNFPropertyValue(IExternalAccess component, IServiceIdentifier sid, MethodInfo method, java.lang.String name, U unit) Returns the current value of a non-functional property of the specified method, performs unit conversion.
static IFuture<java.lang.String[]>	getRequiredNFAllPropertyNames(IExternalAccess component, IServiceIdentifier sid) Returns the names of all non-functional properties of this service.
static IFuture<INFPropertyMetaInfo>	getRequiredNFPropertyMetaInfo(IExternalAccess component, IServiceIdentifier sid, java.lang.String name) Returns the meta information about a non-functional property of this service.
static IFuture<java.util.Map<java.lang.String,INFPropertyMetaInfo>>	getRequiredNFPropertyMetaInfos(IExternalAccess component, IServiceIdentifier sid) Returns the meta information about a non-functional property of this service.
static IFuture<java.lang.String[]>	getRequiredNFPropertyNames(IExternalAccess component, IServiceIdentifier sid) Returns the declared names of all non-functional properties of this service.
static <T> IFuture<T>	getRequiredNFPropertyValue(IExternalAccess component, IServiceIdentifier sid, java.lang.String name) Returns the current value of a non-functional property of this service.
static <T,U> IFuture<T>	getRequiredNFPropertyValue(IExternalAccess component, IServiceIdentifier sid, java.lang.String name, U unit) Returns the current value of a non-functional property of this service, performs unit conversion.
static IFuture<java.lang.Void>	removeMethodNFProperty(IExternalAccess component, IServiceIdentifier sid, MethodInfo method, java.lang.String name) Remove a non-functional property.
static IFuture<java.lang.Void>	removeNFProperty(IExternalAccess component, IServiceIdentifier sid, java.lang.String name) Remove a non-functional property.
static IFuture<java.lang.Void>	removeNFProperty(IExternalAccess component, java.lang.String name) Remove a non-functional property.
static IFuture<java.lang.Void>	removeRequiredMethodNFProperty(IExternalAccess component, IServiceIdentifier sid, MethodInfo method, java.lang.String name) Remove a non-functional property.
static IFuture<java.lang.Void>	removeRequiredNFProperty(IExternalAccess component, IServiceIdentifier sid, java.lang.String name) Remove a non-functional property.
static IFuture<java.lang.Void>	shutdownNFPropertyProvider(IExternalAccess component) Shutdown the provider.
static IFuture<java.lang.Void>	shutdownNFPropertyProvider(IExternalAccess component, IServiceIdentifier sid) Shutdown the provider.
static IFuture<java.lang.Void>	shutdownRequiredNFPropertyProvider(IExternalAccess component, IServiceIdentifier sid) Shutdown the provider.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SNFPropertyProvider

public SNFPropertyProvider()

Method Detail

getNFPropertyNames

public static IFuture<java.lang.String[]> getNFPropertyNames(IExternalAccess component)

Returns the declared names of all non-functional properties of this service.

Returns:

The names of the non-functional properties of this service.

getNFAllPropertyNames

public static IFuture<java.lang.String[]> getNFAllPropertyNames(IExternalAccess component)

Returns the names of all non-functional properties of this service.

Returns:

The names of the non-functional properties of this service.

getNFPropertyMetaInfos

public static IFuture<java.util.Map<java.lang.String,INFPropertyMetaInfo>> getNFPropertyMetaInfos(IExternalAccess component)

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

public static IFuture<INFPropertyMetaInfo> getNFPropertyMetaInfo(IExternalAccess component,
                                                                 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

public static <T> IFuture<T> getNFPropertyValue(IExternalAccess component,
                                                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

public static <T,U> IFuture<T> getNFPropertyValue(IExternalAccess component,
                                                  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.

addNFProperty

public static IFuture<java.lang.Void> addNFProperty(IExternalAccess component,
                                                    INFProperty<?,?> nfprop)

Add a non-functional property.

Parameters:

nfprop - The property.

removeNFProperty

public static IFuture<java.lang.Void> removeNFProperty(IExternalAccess component,
                                                       java.lang.String name)

Remove a non-functional property.

Parameters:

The - name.

shutdownNFPropertyProvider

public static IFuture<java.lang.Void> shutdownNFPropertyProvider(IExternalAccess component)

Shutdown the provider.

getNFPropertyNames

public static IFuture<java.lang.String[]> getNFPropertyNames(IExternalAccess component,
                                                             IServiceIdentifier sid)

Returns the declared names of all non-functional properties of this service.

Returns:

The names of the non-functional properties of this service.

getNFAllPropertyNames

public static IFuture<java.lang.String[]> getNFAllPropertyNames(IExternalAccess component,
                                                                IServiceIdentifier sid)

Returns the names of all non-functional properties of this service.

Returns:

The names of the non-functional properties of this service.

getNFPropertyMetaInfos

public static IFuture<java.util.Map<java.lang.String,INFPropertyMetaInfo>> getNFPropertyMetaInfos(IExternalAccess component,
                                                                                                  IServiceIdentifier sid)

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

public static IFuture<INFPropertyMetaInfo> getNFPropertyMetaInfo(IExternalAccess component,
                                                                 IServiceIdentifier sid,
                                                                 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

public static <T> IFuture<T> getNFPropertyValue(IExternalAccess component,
                                                IServiceIdentifier sid,
                                                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

public static <T,U> IFuture<T> getNFPropertyValue(IExternalAccess component,
                                                  IServiceIdentifier sid,
                                                  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.

addNFProperty

public static IFuture<java.lang.Void> addNFProperty(IExternalAccess component,
                                                    IServiceIdentifier sid,
                                                    INFProperty<?,?> nfprop)

Add a non-functional property.

Parameters:

nfprop - The property.

removeNFProperty

public static IFuture<java.lang.Void> removeNFProperty(IExternalAccess component,
                                                       IServiceIdentifier sid,
                                                       java.lang.String name)

Remove a non-functional property.

Parameters:

The - name.

shutdownNFPropertyProvider

public static IFuture<java.lang.Void> shutdownNFPropertyProvider(IExternalAccess component,
                                                                 IServiceIdentifier sid)

Shutdown the provider.

getMethodNFPropertyMetaInfos

public static IFuture<java.util.Map<MethodInfo,java.util.Map<java.lang.String,INFPropertyMetaInfo>>> getMethodNFPropertyMetaInfos(IExternalAccess component,
                                                                                                                                  IServiceIdentifier sid)

Returns meta information about a non-functional properties of all methods.

Returns:

The meta information about a non-functional properties.

getMethodNFPropertyNames

public static IFuture<java.lang.String[]> getMethodNFPropertyNames(IExternalAccess component,
                                                                   IServiceIdentifier sid,
                                                                   MethodInfo method)

Returns the names of all non-functional properties of the specified method.

Parameters:

method - The method targeted by this operation.

Returns:

The names of the non-functional properties of the specified method.

getMethodNFAllPropertyNames

public static IFuture<java.lang.String[]> getMethodNFAllPropertyNames(IExternalAccess component,
                                                                      IServiceIdentifier sid,
                                                                      MethodInfo method)

Returns the names of all non-functional properties of this method. This includes the properties of all parent components.

Returns:

The names of the non-functional properties of this method.

getMethodNFPropertyMetaInfos

public static IFuture<java.util.Map<java.lang.String,INFPropertyMetaInfo>> getMethodNFPropertyMetaInfos(IExternalAccess component,
                                                                                                        IServiceIdentifier sid,
                                                                                                        MethodInfo method)

Returns meta information about a non-functional properties of a method.

Returns:

The meta information about a non-functional properties.

getMethodNFPropertyMetaInfo

public static IFuture<INFPropertyMetaInfo> getMethodNFPropertyMetaInfo(IExternalAccess component,
                                                                       IServiceIdentifier sid,
                                                                       MethodInfo method,
                                                                       java.lang.String name)

Returns the meta information about a non-functional property of the specified method.

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.

getMethodNFPropertyValue

public static <T> IFuture<T> getMethodNFPropertyValue(IExternalAccess component,
                                                      IServiceIdentifier sid,
                                                      MethodInfo method,
                                                      java.lang.String name)

Returns the current value of a non-functional property of the specified method.

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 static <T,U> IFuture<T> getMethodNFPropertyValue(IExternalAccess component,
                                                        IServiceIdentifier sid,
                                                        MethodInfo method,
                                                        java.lang.String name,
                                                        U unit)

Returns the current value of a non-functional property of the specified method, performs unit conversion.

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.

addMethodNFProperty

public static IFuture<java.lang.Void> addMethodNFProperty(IExternalAccess component,
                                                          IServiceIdentifier sid,
                                                          MethodInfo method,
                                                          INFProperty<?,?> nfprop)

Add a non-functional property.

Parameters:

method - The method targeted by this operation.

nfprop - The property.

removeMethodNFProperty

public static IFuture<java.lang.Void> removeMethodNFProperty(IExternalAccess component,
                                                             IServiceIdentifier sid,
                                                             MethodInfo method,
                                                             java.lang.String name)

Remove a non-functional property.

Parameters:

method - The method targeted by this operation.

The - name.

getRequiredNFPropertyNames

public static IFuture<java.lang.String[]> getRequiredNFPropertyNames(IExternalAccess component,
                                                                     IServiceIdentifier sid)

Returns the declared names of all non-functional properties of this service.

Returns:

The names of the non-functional properties of this service.

getRequiredNFAllPropertyNames

public static IFuture<java.lang.String[]> getRequiredNFAllPropertyNames(IExternalAccess component,
                                                                        IServiceIdentifier sid)

Returns the names of all non-functional properties of this service.

Returns:

The names of the non-functional properties of this service.

getRequiredNFPropertyMetaInfos

public static IFuture<java.util.Map<java.lang.String,INFPropertyMetaInfo>> getRequiredNFPropertyMetaInfos(IExternalAccess component,
                                                                                                          IServiceIdentifier sid)

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.

getRequiredNFPropertyMetaInfo

public static IFuture<INFPropertyMetaInfo> getRequiredNFPropertyMetaInfo(IExternalAccess component,
                                                                         IServiceIdentifier sid,
                                                                         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.

getRequiredNFPropertyValue

public static <T> IFuture<T> getRequiredNFPropertyValue(IExternalAccess component,
                                                        IServiceIdentifier sid,
                                                        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.

getRequiredNFPropertyValue

public static <T,U> IFuture<T> getRequiredNFPropertyValue(IExternalAccess component,
                                                          IServiceIdentifier sid,
                                                          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.

addRequiredNFProperty

public static IFuture<java.lang.Void> addRequiredNFProperty(IExternalAccess component,
                                                            IServiceIdentifier sid,
                                                            INFProperty<?,?> nfprop)

Add a non-functional property.

Parameters:

nfprop - The property.

removeRequiredNFProperty

public static IFuture<java.lang.Void> removeRequiredNFProperty(IExternalAccess component,
                                                               IServiceIdentifier sid,
                                                               java.lang.String name)

Remove a non-functional property.

Parameters:

The - name.

shutdownRequiredNFPropertyProvider

public static IFuture<java.lang.Void> shutdownRequiredNFPropertyProvider(IExternalAccess component,
                                                                         IServiceIdentifier sid)

Shutdown the provider.

getRequiredMethodNFPropertyMetaInfos

public static IFuture<java.util.Map<MethodInfo,java.util.Map<java.lang.String,INFPropertyMetaInfo>>> getRequiredMethodNFPropertyMetaInfos(IExternalAccess component,
                                                                                                                                          IServiceIdentifier sid)

Returns meta information about a non-functional properties of all methods.

Returns:

The meta information about a non-functional properties.

getRequiredMethodNFPropertyNames

public static IFuture<java.lang.String[]> getRequiredMethodNFPropertyNames(IExternalAccess component,
                                                                           IServiceIdentifier sid,
                                                                           MethodInfo method)

Returns the names of all non-functional properties of the specified method.

Parameters:

method - The method targeted by this operation.

Returns:

The names of the non-functional properties of the specified method.

getRequiredMethodNFAllPropertyNames

public static IFuture<java.lang.String[]> getRequiredMethodNFAllPropertyNames(IExternalAccess component,
                                                                              IServiceIdentifier sid,
                                                                              MethodInfo method)

Returns the names of all non-functional properties of this method. This includes the properties of all parent components.

Returns:

The names of the non-functional properties of this method.

getRequiredMethodNFPropertyMetaInfos

public static IFuture<java.util.Map<java.lang.String,INFPropertyMetaInfo>> getRequiredMethodNFPropertyMetaInfos(IExternalAccess component,
                                                                                                                IServiceIdentifier sid,
                                                                                                                MethodInfo method)

Returns meta information about a non-functional properties of a method.

Returns:

The meta information about a non-functional properties.

getRequiredMethodNFPropertyMetaInfo

public static IFuture<INFPropertyMetaInfo> getRequiredMethodNFPropertyMetaInfo(IExternalAccess component,
                                                                               IServiceIdentifier sid,
                                                                               MethodInfo method,
                                                                               java.lang.String name)

Returns the meta information about a non-functional property of the specified method.

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 static <T> IFuture<T> getRequiredMethodNFPropertyValue(IExternalAccess component,
                                                              IServiceIdentifier sid,
                                                              MethodInfo method,
                                                              java.lang.String name)

Returns the current value of a non-functional property of the specified method.

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 static <T,U> IFuture<T> getRequiredMethodNFPropertyValue(IExternalAccess component,
                                                                IServiceIdentifier sid,
                                                                MethodInfo method,
                                                                java.lang.String name,
                                                                U unit)

Returns the current value of a non-functional property of the specified method, performs unit conversion.

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.

addRequiredMethodNFProperty

public static IFuture<java.lang.Void> addRequiredMethodNFProperty(IExternalAccess component,
                                                                  IServiceIdentifier sid,
                                                                  MethodInfo method,
                                                                  INFProperty<?,?> nfprop)

Add a non-functional property.

Parameters:

method - The method targeted by this operation.

nfprop - The property.

removeRequiredMethodNFProperty

public static IFuture<java.lang.Void> removeRequiredMethodNFProperty(IExternalAccess component,
                                                                     IServiceIdentifier sid,
                                                                     MethodInfo method,
                                                                     java.lang.String name)

Remove a non-functional property.

Parameters:

method - The method targeted by this operation.

The - name.