Package jadex.bridge.component

Interface IExternalNFPropertyComponentFeature

All Superinterfaces:

IExternalComponentFeature

All Known Subinterfaces:

IBDIAgent, IExternalAccess, IInternalAccess, INFPropertyComponentFeature

All Known Implementing Classes:

ComponentPlanBDI, HelloWorldBDI, HelloWorldPlan2, IndexChangeBDI, InterfaceInjectionBDI, PlanMethodInjectionBDI, PlanReasonInjectionBDI, SayHelloBDI

public interface IExternalNFPropertyComponentFeature
extends IExternalComponentFeature

External perspective of the monitoring feature.

Method Summary

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

Method Detail

getNFPropertyNames

IFuture<java.lang.String[]> getNFPropertyNames()

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

Returns:

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

getNFAllPropertyNames

IFuture<java.lang.String[]> getNFAllPropertyNames()

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

Returns:

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

getNFPropertyMetaInfos

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

Returns the meta information about a non-functional property of this component.

Parameters:

name - Name of the property.

Returns:

The meta information about a non-functional property of this component.

getNFPropertyMetaInfo

IFuture<INFPropertyMetaInfo> getNFPropertyMetaInfo(java.lang.String name)

Returns the meta information about a non-functional property of this component.

Parameters:

name - Name of the property.

Returns:

The meta information about a non-functional property of this component.

getNFPropertyValue

<T> IFuture<T> getNFPropertyValue(java.lang.String name)

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

Parameters:

name - Name of the property.

type - Type of the property value.

Returns:

The current value of a non-functional property of this component.

getNFPropertyValue

<T,U> IFuture<T> getNFPropertyValue(java.lang.String name,
                                          U unit)

Returns the current value of a non-functional property of this component, 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 component.

getNFPropertyPrettyPrintValue

IFuture<java.lang.String> getNFPropertyPrettyPrintValue(java.lang.String name)

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

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.

addNFProperty

IFuture<java.lang.Void> addNFProperty(INFProperty<?,?> nfprop)

Add a non-functional property.

Parameters:

nfprop - The property.

removeNFProperty

IFuture<java.lang.Void> removeNFProperty(java.lang.String name)

Remove a non-functional property.

Parameters:

The - name.

shutdownNFPropertyProvider

IFuture<java.lang.Void> shutdownNFPropertyProvider()

Shutdown the provider.

getNFPropertyNames

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

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

IFuture<java.util.Map<java.lang.String,INFPropertyMetaInfo>> getNFPropertyMetaInfos(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

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

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

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

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

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.

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.

addNFProperty

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

Add a non-functional property.

Parameters:

nfprop - The property.

removeNFProperty

IFuture<java.lang.Void> removeNFProperty(IServiceIdentifier sid,
                                         java.lang.String name)

Remove a non-functional property.

Parameters:

The - name.

shutdownNFPropertyProvider

IFuture<java.lang.Void> shutdownNFPropertyProvider(IServiceIdentifier sid)

Shutdown the provider.

getMethodNFPropertyMetaInfos

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

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(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

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

IFuture<java.util.Map<java.lang.String,INFPropertyMetaInfo>> getMethodNFPropertyMetaInfos(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

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

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

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

getMethodNFPropertyPrettyPrintValue

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

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

IFuture<java.lang.Void> addMethodNFProperty(IServiceIdentifier sid,
                                            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(IServiceIdentifier sid,
                                               MethodInfo method,
                                               java.lang.String name)

Remove a non-functional property.

Parameters:

method - The method targeted by this operation.

The - name.

getRequiredNFPropertyNames

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

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

IFuture<java.util.Map<java.lang.String,INFPropertyMetaInfo>> getRequiredNFPropertyMetaInfos(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

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

<T> IFuture<T> getRequiredNFPropertyValue(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.

getRequiredNFPropertyPrettyPrintValue

IFuture<java.lang.String> getRequiredNFPropertyPrettyPrintValue(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

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

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

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

Add a non-functional property.

Parameters:

nfprop - The property.

removeRequiredNFProperty

IFuture<java.lang.Void> removeRequiredNFProperty(IServiceIdentifier sid,
                                                 java.lang.String name)

Remove a non-functional property.

Parameters:

The - name.

shutdownRequiredNFPropertyProvider

IFuture<java.lang.Void> shutdownRequiredNFPropertyProvider(IServiceIdentifier sid)

Shutdown the provider.

getRequiredMethodNFPropertyMetaInfos

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

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

Returns:

The meta information about a non-functional properties.

getRequiredMethodNFPropertyNames

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

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

IFuture<java.util.Map<java.lang.String,INFPropertyMetaInfo>> getRequiredMethodNFPropertyMetaInfos(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

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

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

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

getRequiredMethodNFPropertyPrettyPrintValue

IFuture<java.lang.String> getRequiredMethodNFPropertyPrettyPrintValue(IServiceIdentifier sid,
                                                                      MethodInfo method,
                                                                      java.lang.String name)

addRequiredMethodNFProperty

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

Add a non-functional property.

Parameters:

method - The method targeted by this operation.

nfprop - The property.

removeRequiredMethodNFProperty

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

Remove a non-functional property.

Parameters:

method - The method targeted by this operation.

The - name.