jadex.bridge.nonfunctional

Class NFMethodPropertyProvider

java.lang.Object

jadex.bridge.nonfunctional.NFPropertyProvider

jadex.bridge.nonfunctional.NFMethodPropertyProvider

All Implemented Interfaces:

INFMethodPropertyProvider, INFMixedPropertyProvider, INFPropertyProvider

Direct Known Subclasses:

BasicService

public abstract class NFMethodPropertyProvider
extends NFPropertyProvider
implements INFMixedPropertyProvider

Default implementation for a method property provider.

Constructor Summary

Constructors

Constructor and Description
NFMethodPropertyProvider(INFPropertyProvider parent) Create a new provider.

Method Summary

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

Methods inherited from class jadex.bridge.nonfunctional.NFPropertyProvider

addNFProperty, getInternalAccess, getNFAllPropertyNames, getNFPropertyMetaInfo, getNFPropertyMetaInfos, getNFPropertyNames, getNFPropertyValue, getNFPropertyValue, getParent, removeNFProperty, setParent

Methods inherited from class java.lang.Object

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

Methods inherited from interface jadex.bridge.nonfunctional.INFPropertyProvider

addNFProperty, getNFAllPropertyNames, getNFPropertyMetaInfo, getNFPropertyMetaInfos, getNFPropertyNames, getNFPropertyValue, getNFPropertyValue, removeNFProperty

Constructor Detail

NFMethodPropertyProvider

public NFMethodPropertyProvider(INFPropertyProvider parent)

Create a new provider.

Method Detail

getMethodNFPropertyMetaInfos

public IFuture<Map<MethodInfo,Map<String,INFPropertyMetaInfo>>> getMethodNFPropertyMetaInfos()

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

Specified by:

getMethodNFPropertyMetaInfos in interface INFMethodPropertyProvider

Returns:

The meta information about a non-functional properties.

getMethodNFPropertyMetaInfos

public IFuture<Map<String,INFPropertyMetaInfo>> getMethodNFPropertyMetaInfos(MethodInfo method)

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

Specified by:

getMethodNFPropertyMetaInfos in interface INFMethodPropertyProvider

Returns:

The meta information about a non-functional properties.

getMethodNFPropertyNames

public IFuture<String[]> getMethodNFPropertyNames(MethodInfo method)

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

Specified by:

getMethodNFPropertyNames in interface INFMethodPropertyProvider

Parameters:

method - The method targeted by this operation.

Returns:

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

getMethodNFAllPropertyNames

public IFuture<String[]> getMethodNFAllPropertyNames(MethodInfo method)

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

Specified by:

getMethodNFAllPropertyNames in interface INFMethodPropertyProvider

Returns:

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

getMethodNFPropertyMetaInfo

public IFuture<INFPropertyMetaInfo> getMethodNFPropertyMetaInfo(MethodInfo method,
                                                                String name)

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

Specified by:

getMethodNFPropertyMetaInfo in interface INFMethodPropertyProvider

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 <T> IFuture<T> getMethodNFPropertyValue(MethodInfo method,
                                               String name)

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

Specified by:

getMethodNFPropertyValue in interface INFMethodPropertyProvider

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> IFuture<T> getMethodNFPropertyValue(MethodInfo method,
                                                 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 INFMethodPropertyProvider

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 IFuture<Void> addMethodNFProperty(MethodInfo method,
                                         INFProperty<?,?> nfprop)

Add a non-functional property.

Specified by:

addMethodNFProperty in interface INFMethodPropertyProvider

Parameters:

method - The method targeted by this operation.

nfprop - The property.

removeMethodNFProperty

public IFuture<Void> removeMethodNFProperty(MethodInfo method,
                                            String name)

Remove a non-functional property.

Specified by:

removeMethodNFProperty in interface INFMethodPropertyProvider

Parameters:

method - The method targeted by this operation.

The - name.

shutdownNFPropertyProvider

public IFuture<Void> shutdownNFPropertyProvider()

Shutdown the provider.

Specified by:

shutdownNFPropertyProvider in interface INFMethodPropertyProvider

Specified by:

shutdownNFPropertyProvider in interface INFPropertyProvider

Overrides:

shutdownNFPropertyProvider in class NFPropertyProvider