Package jadex.bridge.nonfunctional

Interface INFMethodPropertyProvider

All Known Subinterfaces:

INFMixedPropertyProvider

All Known Implementing Classes:

NFMethodPropertyProvider

public interface INFMethodPropertyProvider

Interface for method-based non-functional property providers such as services.

Method Summary

Modifier and Type	Method	Description
IFuture<java.lang.Void>	addMethodNFProperty(MethodInfo method, INFProperty<?,?> nfprop)	Add a non-functional property.
IFuture<java.lang.String[]>	getMethodNFAllPropertyNames(MethodInfo method)	Returns the names of all non-functional properties of this method.
IFuture<INFPropertyMetaInfo>	getMethodNFPropertyMetaInfo(MethodInfo method, java.lang.String name)	Returns the meta information about a non-functional property of the specified method.
IFuture<java.util.Map<MethodInfo,java.util.Map<java.lang.String,INFPropertyMetaInfo>>>	getMethodNFPropertyMetaInfos()	Returns meta information about a non-functional properties of all methods.
IFuture<java.util.Map<java.lang.String,INFPropertyMetaInfo>>	getMethodNFPropertyMetaInfos(MethodInfo method)	Returns meta information about a non-functional properties of a method.
IFuture<java.lang.String[]>	getMethodNFPropertyNames(MethodInfo method)	Returns the names of all non-functional properties of the specified method.
IFuture<java.lang.String>	getMethodNFPropertyPrettyPrintValue(MethodInfo method, java.lang.String name)	Returns the current value of a non-functional property of this service method.
<T> IFuture<T>	getMethodNFPropertyValue(MethodInfo method, java.lang.String name)	Returns the current value of a non-functional property of the specified method.
<T,U> IFuture<T>	getMethodNFPropertyValue(MethodInfo method, java.lang.String name, U unit)	Returns the current value of a non-functional property of the specified method, performs unit conversion.
IFuture<java.lang.Void>	removeMethodNFProperty(MethodInfo method, java.lang.String name)	Remove a non-functional property.
IFuture<java.lang.Void>	shutdownNFPropertyProvider()	Shutdown the provider.

Method Detail

getMethodNFPropertyMetaInfos

IFuture<java.util.Map<MethodInfo,java.util.Map<java.lang.String,INFPropertyMetaInfo>>> getMethodNFPropertyMetaInfos()

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

Returns:

The meta information about a non-functional properties.

getMethodNFPropertyNames

IFuture<java.lang.String[]> getMethodNFPropertyNames(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

IFuture<java.lang.String[]> getMethodNFAllPropertyNames(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

IFuture<java.util.Map<java.lang.String,INFPropertyMetaInfo>> getMethodNFPropertyMetaInfos(MethodInfo method)

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

Returns:

The meta information about a non-functional properties.

getMethodNFPropertyMetaInfo

IFuture<INFPropertyMetaInfo> getMethodNFPropertyMetaInfo(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

<T> IFuture<T> getMethodNFPropertyValue(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

<T,U> IFuture<T> getMethodNFPropertyValue(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.

getMethodNFPropertyPrettyPrintValue

IFuture<java.lang.String> getMethodNFPropertyPrettyPrintValue(MethodInfo method,
                                                              java.lang.String name)

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

Parameters:

name - Name of the property.

type - Type of the property value.

Returns:

The current value of a non-functional property of this service method.

addMethodNFProperty

IFuture<java.lang.Void> addMethodNFProperty(MethodInfo method,
                                            INFProperty<?,?> nfprop)

Add a non-functional property.

Parameters:

method - The method targeted by this operation.

nfprop - The property.

removeMethodNFProperty

IFuture<java.lang.Void> removeMethodNFProperty(MethodInfo method,
                                               java.lang.String name)

Remove a non-functional property.

Parameters:

method - The method targeted by this operation.

The - name.

shutdownNFPropertyProvider

IFuture<java.lang.Void> shutdownNFPropertyProvider()

Shutdown the provider.