jadex.bridge.nonfunctional

Class NFPropertyProvider

java.lang.Object

jadex.bridge.nonfunctional.NFPropertyProvider

All Implemented Interfaces:

INFPropertyProvider

Direct Known Subclasses:

NFMethodPropertyProvider

public class NFPropertyProvider
extends java.lang.Object
implements INFPropertyProvider

Base impl for nf property property provider.

Field Summary

Fields

Modifier and Type	Field and Description
protected IInternalAccess	component The component.
protected java.util.Map<java.lang.String,INFProperty<?,?>>	nfproperties Non-functional properties.
protected IComponentIdentifier	parent The parent.

Constructor Summary

Constructors

Constructor and Description
NFPropertyProvider(IComponentIdentifier parent, IInternalAccess component) Create a new provider.

Method Summary

Modifier and Type	Method and Description
IFuture<java.lang.Void>	addNFProperty(INFProperty<?,?> nfprop) Add a non-functional property.
IInternalAccess	getInternalAccess() Get the internal access.
IFuture<java.lang.String[]>	getNFAllPropertyNames() Returns the names of all non-functional properties of this service.
IFuture<INFPropertyMetaInfo>	getNFPropertyMetaInfo(java.lang.String name) Returns the meta information about a non-functional property of this service.
IFuture<java.util.Map<java.lang.String,INFPropertyMetaInfo>>	getNFPropertyMetaInfos() Returns the meta information about a non-functional property of this service.
IFuture<java.lang.String[]>	getNFPropertyNames() Returns the names of all non-functional properties of this service.
<T> IFuture<T>	getNFPropertyValue(java.lang.String name) Returns the current value of a non-functional property of this service, performs unit conversion.
<T,U> IFuture<T>	getNFPropertyValue(java.lang.String name, U unit) Returns the current value of a non-functional property of this service, performs unit conversion.
IComponentIdentifier	getParentId() Get the parent.
IFuture<java.lang.Void>	removeNFProperty(java.lang.String name) Remove a non-functional property.
IFuture<java.lang.Void>	shutdownNFPropertyProvider() Shutdown the provider.

Methods inherited from class java.lang.Object

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

Field Detail

parent

protected IComponentIdentifier parent

The parent.

component

protected IInternalAccess component

The component.

nfproperties

protected java.util.Map<java.lang.String,INFProperty<?,?>> nfproperties

Non-functional properties.

Constructor Detail

NFPropertyProvider

public NFPropertyProvider(IComponentIdentifier parent,
                          IInternalAccess component)

Create a new provider.

Method Detail

getNFPropertyNames

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

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

Specified by:

getNFPropertyNames in interface INFPropertyProvider

Returns:

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

getNFAllPropertyNames

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

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

Specified by:

getNFAllPropertyNames in interface INFPropertyProvider

Returns:

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

getNFPropertyMetaInfos

public 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 INFPropertyProvider

Parameters:

name - Name of the property.

Returns:

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

getNFPropertyMetaInfo

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

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

Specified by:

getNFPropertyMetaInfo in interface INFPropertyProvider

Parameters:

name - Name of the property.

Returns:

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

getNFPropertyValue

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

Returns the current value of a non-functional property of this service, performs unit conversion.

Specified by:

getNFPropertyValue in interface INFPropertyProvider

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

Parameters:

name - Name of the property.

unit - Unit of the property value.

Returns:

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

addNFProperty

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

Add a non-functional property.

Specified by:

addNFProperty in interface INFPropertyProvider

Parameters:

metainfo - The metainfo.

removeNFProperty

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

Remove a non-functional property.

Specified by:

removeNFProperty in interface INFPropertyProvider

Parameters:

The - name.

getParentId

public IComponentIdentifier getParentId()

Get the parent. return The parent.

shutdownNFPropertyProvider

public IFuture<java.lang.Void> shutdownNFPropertyProvider()

Shutdown the provider.

Specified by:

shutdownNFPropertyProvider in interface INFPropertyProvider

getInternalAccess

public IInternalAccess getInternalAccess()

Get the internal access.