Package com.inductiveautomation.perspective.gateway.driven

Class LockGuardedDrivenValueCollection<T,U,V extends DrivenValue<U>>

java.lang.Object

com.inductiveautomation.perspective.gateway.driven.LockGuardedDrivenValue<T>

com.inductiveautomation.perspective.gateway.driven.LockGuardedDrivenValueCollection<T,U,V>

Type Parameters:

T - The type of the driven value

U - The type of the driven values managed in the collection

V - The type of the driven value which extends DrivenValue

All Implemented Interfaces:

DrivenValue<T>

public abstract class LockGuardedDrivenValueCollection<T,U,V extends DrivenValue<U>>
extends LockGuardedDrivenValue<T>

A LockGuardedDrivenValueCollection is a LockGuardedDrivenValue which provides implementations for isReadyInternal(), isDirtyInternal(), startup(), and shutdown() common to a managed Collection of DrivenValues.

Field Summary

Fields inherited from class com.inductiveautomation.perspective.gateway.driven.LockGuardedDrivenValue

lock

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	LockGuardedDrivenValueCollection(java.lang.Object lock)

Method Summary

Modifier and Type	Method	Description
protected abstract java.util.Collection<V>	getCollection()	Fetch the managed Collection of DrivenValues
protected boolean	isDirtyInternal()	Called after asserting that the calling thread holds the injected lock.
protected boolean	isReadyInternal()	Called after asserting that the calling thread holds the injected lock.
protected java.util.Collection<PropertyReference>	resolveReferencesInternal()
void	shutdown()	Lifecycle hook to shut down the driven value
void	startup()	Lifecycle hook to start up the driven value

Methods inherited from class com.inductiveautomation.perspective.gateway.driven.LockGuardedDrivenValue

getAndClear, getAndClearInternal, isDirty, isReady, resolveReferences

Methods inherited from class java.lang.Object

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

Constructor Detail

LockGuardedDrivenValueCollection

protected LockGuardedDrivenValueCollection(@Nonnull
                                           java.lang.Object lock)

Method Detail

getCollection

@Nonnull
protected abstract java.util.Collection<V> getCollection()

Fetch the managed Collection of DrivenValues

Returns:

The managed Collection of DrivenValues

isReadyInternal

protected boolean isReadyInternal()

Description copied from class: LockGuardedDrivenValue

Called after asserting that the calling thread holds the injected lock.

Specified by:

isReadyInternal in class LockGuardedDrivenValue<T>

See Also:

LockGuardedDrivenValue.isReady()

isDirtyInternal

protected boolean isDirtyInternal()

Description copied from class: LockGuardedDrivenValue

Called after asserting that the calling thread holds the injected lock.

Specified by:

isDirtyInternal in class LockGuardedDrivenValue<T>

See Also:

LockGuardedDrivenValue.isDirty()

startup

public void startup()

Description copied from interface: DrivenValue

Lifecycle hook to start up the driven value

resolveReferencesInternal

protected java.util.Collection<PropertyReference> resolveReferencesInternal()

Specified by:

resolveReferencesInternal in class LockGuardedDrivenValue<T>

shutdown

public void shutdown()

Description copied from interface: DrivenValue

Lifecycle hook to shut down the driven value