io.sarl.sre.services.probing

Class AbstractProbe<T>

java.lang.Object

io.sarl.sre.services.probing.AbstractProbe<T>

All Implemented Interfaces:

Probe<T>

public abstract class AbstractProbe<T>
extends Object
implements Probe<T>

Abstract probe implementation. A probe is thread-safe.

Since:

0.10

Version:

0.12.0-SNAPSHOT 2020-06-30 17:45:08

Author:

Stéphane Galland

Maven Group Id:

io.janusproject

Maven Artifact Id:

io.janusproject.plugin

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	active

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractProbe(manager : IProbeReleaseListener, name : String, uri : URI, type : Class<T>, listenerCollectionProvider : javax.inject.Provider<SmartListenerCollection<?>>) Constructor.

Method Summary

Modifier and Type	Method and Description
void	addProbeListener(listener : IProbeListener) Add listener on probe changes.
void	addProbeReleaseListener(listener : IProbeReleaseListener) Add listener on probe release.
protected void	fireRelease() Notify the listener that the probe has been released.
protected void	fireValueChanged() Notify the listener that the probe's value has changed.
String	getName() Replies the name of the probe
Class<T>	getType() The type of the value.
URI	getUri() Replies the probed component.
boolean	isActive() Replies if this probe is active.
void	release() Releases any resource associated to the probe.
void	removeProbeListener(listener : IProbeListener) Remove listener on probe changes.
void	removeProbeReleaseListener(listener : IProbeReleaseListener) Remove listener on probe release.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.sarl.sre.services.probing.Probe

getValue, isInvalid, setValue, sync

Field Detail

active

protected var active : boolean

Constructor Detail

AbstractProbe

protected new(manager : IProbeReleaseListener,
              name : String,
              uri : URI,
              type : Class<T>,
              listenerCollectionProvider : javax.inject.Provider<SmartListenerCollection<?>>)

Constructor.

Parameters:

manager - the creator of this probe, and its manager.

name - the name of the probe

uri - the UI of the field.

type - the expected type of the probed value.

listenerCollectionProvider - the provider of listener collections.

lockProvider - the provider of synchronization locks.

Method Detail

isActive

@Pure
public def isActive() : boolean 

Description copied from interface: Probe

Replies if this probe is active. When a probe is active, it could be synchronized to the probed element.

Specified by:

isActive in interface Probe<T>

Returns:

true if the probe is active.

release

public def release() : void 

Description copied from interface: Probe

Releases any resource associated to the probe.

Specified by:

release in interface Probe<T>

fireValueChanged

protected def fireValueChanged() : void 

Description copied from class: AbstractProbe

Notify the listener that the probe's value has changed.

addProbeListener

public def addProbeListener(listener : IProbeListener) : void 

Description copied from interface: Probe

Add listener on probe changes.

Specified by:

addProbeListener in interface Probe<T>

removeProbeListener

public def removeProbeListener(listener : IProbeListener) : void 

Description copied from interface: Probe

Remove listener on probe changes.

Specified by:

removeProbeListener in interface Probe<T>

fireRelease

protected def fireRelease() : void 

Description copied from class: AbstractProbe

Notify the listener that the probe has been released.

addProbeReleaseListener

public def addProbeReleaseListener(listener : IProbeReleaseListener) : void 

Description copied from interface: Probe

Add listener on probe release.

Specified by:

addProbeReleaseListener in interface Probe<T>

removeProbeReleaseListener

public def removeProbeReleaseListener(listener : IProbeReleaseListener) : void 

Description copied from interface: Probe

Remove listener on probe release.

Specified by:

removeProbeReleaseListener in interface Probe<T>

getName

@Pure
public def getName() : String 

Description copied from interface: Probe

Replies the name of the probe

Specified by:

getName in interface Probe<T>

getUri

@Pure
public def getUri() : URI 

Description copied from interface: Probe

Replies the probed component.

Specified by:

getUri in interface Probe<T>

getType

@Pure
public def getType() : Class<T> 

Description copied from interface: Probe

The type of the value.

Specified by:

getType in interface Probe<T>