T
- The type of signal data to retrieve.public class CommunicationLinkSignalData<T> extends DefinitionalObject
Modifier | Constructor and Description |
---|---|
|
CommunicationLinkSignalData(TypeLiteral<T> typeLiteralT)
Initializes a new instance.
|
protected |
CommunicationLinkSignalData(TypeLiteral<T> typeLiteralT,
CommunicationLinkSignalData<T> existingInstance,
CopyContext context)
Initializes a new instance as a copy of an existing instance.
|
|
CommunicationLinkSignalData(TypeLiteral<T> typeLiteralT,
IServiceProvider communicationLink,
SignalPropagationGraph graph,
IntendedSignalStrategy intendedSignalStrategy)
Initialize a new instance based on the given parameters.
|
Modifier and Type | Method and Description |
---|---|
protected boolean |
checkForSameDefinition(CommunicationLinkSignalData<T> other)
Checks to determine if another instance has the same definition as this instance and
returns
true if it does. |
protected boolean |
checkForSameDefinition(DefinitionalObject other)
Checks to determine if another instance has the same definition as this instance and
returns
true if it does. |
Object |
clone(CopyContext context)
Clones this object using the specified context.
|
protected int |
computeCurrentDefinitionHashCode()
Computes a hash code based on the current properties of this object.
|
void |
enumerateDependencies(DependencyEnumerator enumerator)
Enumerates the dependencies of this object by calling
DependencyEnumerator#enumerate(T) for each object that this object directly depends upon. |
IServiceProvider |
getCommunicationLink()
Gets the object which provides the services needed to compute this scalar.
|
Evaluator<T> |
getEvaluator(EvaluatorGroup group)
Get an evaluator to retrieve the signal data from the propagated
Signal . |
IntendedSignalStrategy |
getIntendedSignalStrategy()
Gets the strategy used to identify the signal to be used when computing this scalar.
|
SignalPropagationGraph |
getPropagationGraph()
Gets the graph of communication links used to propagate signals.
|
void |
setCommunicationLink(IServiceProvider value)
Sets the object which provides the services needed to compute this scalar.
|
void |
setIntendedSignalStrategy(IntendedSignalStrategy value)
Sets the strategy used to identify the signal to be used when computing this scalar.
|
void |
setPropagationGraph(SignalPropagationGraph value)
Sets the graph of communication links used to propagate signals.
|
areSameDefinition, areSameDefinition, areSameDefinition, areSameDefinition, areSameDefinition, collectionItemsAreSameDefinition, collectionItemsAreSameDefinition, collectionItemsAreSameDefinition, dictionaryItemsAreSameDefinition, freeze, freezeAggregatedObjects, getCollectionHashCode, getCollectionHashCode, getCollectionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDictionaryHashCode, getIsFrozen, isSameDefinition, throwIfFrozen
public CommunicationLinkSignalData(TypeLiteral<T> typeLiteralT)
typeLiteralT
- A TypeLiteral object representing the generic type T
.public CommunicationLinkSignalData(TypeLiteral<T> typeLiteralT, IServiceProvider communicationLink, SignalPropagationGraph graph, IntendedSignalStrategy intendedSignalStrategy)
typeLiteralT
- A TypeLiteral object representing the generic type T
.communicationLink
- The object which provides the services needed to compute this scalar.graph
- The graph of communication links used to propagate signals.intendedSignalStrategy
- The strategy used to identify the signal to use when computing the scalar value.protected CommunicationLinkSignalData(TypeLiteral<T> typeLiteralT, @Nonnull CommunicationLinkSignalData<T> existingInstance, @Nonnull CopyContext context)
See ICloneWithContext.clone(CopyContext)
for more information about how to implement this constructor
in a derived class.
typeLiteralT
- A TypeLiteral object representing the generic type T
.existingInstance
- The existing instance to copy.context
- A CopyContext
that controls the depth of the copy.ArgumentNullException
- Thrown when existingInstance
or context
is null
.public Object clone(CopyContext context)
This method should be implemented to call a copy constructor on the class of the
object being cloned. The copy constructor should take the CopyContext
as a parameter
in addition to the existing instance to copy. The copy constructor should first call
CopyContext.addObjectMapping(T, T)
to identify the newly constructed instance
as a copy of the existing instance. It should then copy all fields, using
CopyContext.updateReference(T)
to copy any reference fields.
A typical implementation of ICloneWithContext
:
public static class MyClass implements ICloneWithContext {
public MyClass(MyClass existingInstance, CopyContext context) {
context.addObjectMapping(existingInstance, this);
someReference = context.updateReference(existingInstance.someReference);
}
@Override
public final Object clone(CopyContext context) {
return new MyClass(this, context);
}
private Object someReference;
}
In general, all fields that are reference types should be copied with a call to
CopyContext.updateReference(T)
. There are a couple of exceptions:
If one of these exceptions applies, the CopyContext
should be given an opportunity
to update the reference before the reference is copied explicitly. Use
CopyContext.updateReference(T)
to update the reference. If CopyContext.updateReference(T)
returns
the original object, indicating that the context does not have a replacement registered,
then copy the object manually by invoking a Clone method, a copy constructor, or by manually
constructing a new instance and copying the values.
alwaysCopy = context.updateReference(existingInstance.alwaysCopy);
if (existingInstance.alwaysCopy != null && alwaysCopy == existingInstance.alwaysCopy) {
alwaysCopy = (AlwaysCopy) existingInstance.alwaysCopy.clone(context);
}
If you are implementing an evaluator (a class that implements IEvaluator
), the
IEvaluator.updateEvaluatorReferences(agi.foundation.infrastructure.CopyContext)
method shares some responsibilities with the
copy context constructor. Code duplication can be avoided by doing the following:
CopyContext.updateReference(T)
. You should still call CopyContext.updateReference(T)
on any references to
non-evaluators.
IEvaluator.updateEvaluatorReferences(agi.foundation.infrastructure.CopyContext)
as the last line in the constructor and pass it the
same CopyContext
passed to the constructor.
IEvaluator.updateEvaluatorReferences(agi.foundation.infrastructure.CopyContext)
as normal. See the reference documentation for
IEvaluator.updateEvaluatorReferences(agi.foundation.infrastructure.CopyContext)
for more information on implementing that method.
public MyClass(MyClass existingInstance, CopyContext context) {
super(existingInstance, context);
someReference = context.updateReference(existingInstance.someReference);
evaluatorReference = existingInstance.evaluatorReference;
updateEvaluatorReferences(context);
}
@Override
public void updateEvaluatorReferences(CopyContext context) {
evaluatorReference = context.updateReference(evaluatorReference);
}
@Override
public Object clone(CopyContext context) {
return new MyClass(this, context);
}
private Object someReference;
private IEvaluator evaluatorReference;
clone
in interface ICloneWithContext
clone
in class DefinitionalObject
context
- The context to use to perform the copy.protected final boolean checkForSameDefinition(DefinitionalObject other)
true
if it does. Derived classes MUST override this method and check
all new fields introduced by the derived class for definitional equivalence. It is NOT necessary
to check base class fields because the base class will already have done that. When overriding this method,
you should NOT call the base implementation because it will return false
for all derived-class instances.
Derived classes should check the type of other
to preserve the symmetric nature of IEquatableDefinition.isSameDefinition(java.lang.Object)
.checkForSameDefinition
in class DefinitionalObject
other
- The other instance to compare to this one.true
if the two objects are defined equivalently; otherwise false
.protected boolean checkForSameDefinition(CommunicationLinkSignalData<T> other)
true
if it does. Derived classes MUST override this method and check
all new fields introduced by the derived class for definitional equivalence. It is NOT necessary
to check base class fields because the base class will already have done that. When overriding this method,
you should NOT call the base implementation because it will return false
for all derived-class instances.
Derived classes should check the type of other
to preserve the symmetric nature of IEquatableDefinition.isSameDefinition(java.lang.Object)
.other
- The other instance to compare to this one.true
if the two objects are defined equivalently; otherwise false
.protected int computeCurrentDefinitionHashCode()
CommunicationLinkSignalData.checkForSameDefinition(agi.foundation.infrastructure.DefinitionalObject)
method.computeCurrentDefinitionHashCode
in class DefinitionalObject
public void enumerateDependencies(DependencyEnumerator enumerator)
DependencyEnumerator#enumerate(T)
for each object that this object directly depends upon.
Derived classes which contain additional dependencies MUST override this method, call the base
implementation, and enumerate dependencies introduced by the derived class.enumerateDependencies
in interface IEnumerateDependencies
enumerateDependencies
in class DefinitionalObject
enumerator
- The enumerator that is informed of the dependencies of this object.public final IServiceProvider getCommunicationLink()
public final void setCommunicationLink(IServiceProvider value)
public final SignalPropagationGraph getPropagationGraph()
public final void setPropagationGraph(SignalPropagationGraph value)
public final IntendedSignalStrategy getIntendedSignalStrategy()
public final void setIntendedSignalStrategy(IntendedSignalStrategy value)
public final Evaluator<T> getEvaluator(@Nonnull EvaluatorGroup group)
Signal
.group
- The evaluator group in which to create evaluators.ArgumentNullException
- Thrown when group
is null
.PropertyInvalidException
- Thrown when PropagationGraph
(get
/ set
), IntendedSignalStrategy
(get
/ set
), or CommunicationLink
(get
/ set
) are null
,
or when PropagationGraph
(get
/ set
) does not contain CommunicationLink
(get
/ set
).