public class SignalPropagationGraph extends Object implements ICloneWithContext, IServiceProvider, IFreezable
| Modifier | Constructor and Description |
|---|---|
|
SignalPropagationGraph()
Initializes a new instance.
|
protected |
SignalPropagationGraph(SignalPropagationGraph existingInstance,
CopyContext context)
Initializes a new instance as a copy of an existing instance.
|
| Modifier and Type | Method and Description |
|---|---|
void |
addLink(IServiceProvider linkObject)
Add a link to the graph.
|
Object |
clone(CopyContext context)
Clones this object using the specified context.
|
boolean |
containsLinkOrNode(IServiceProvider linkOrNode)
Searches the graph for the given link or node and returns true if the object
exists in the graph.
|
void |
freeze()
Freezes this object.
|
boolean |
getIsFrozen()
Gets a value indicating whether this object is frozen.
|
LinkGraph |
getLinkGraph()
Construct a
LinkGraph from all the links in the propagation graph. |
List<IServiceProvider> |
getLinks()
Gets the links in the graph.
|
Object |
getService(Class<?> serviceType)
Gets the service object of the specified type.
|
public SignalPropagationGraph()
protected SignalPropagationGraph(@Nonnull SignalPropagationGraph existingInstance, @Nonnull CopyContext context)
See ICloneWithContext.clone(CopyContext) for more information about how to implement this constructor
in a derived class.
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 ICloneWithContextcontext - The context to use to perform the copy.public void freeze()
ObjectFrozenException.freeze in interface IFreezablepublic boolean getIsFrozen()
ObjectFrozenException will be thrown if an attempt is made to do so.getIsFrozen in interface IFreezable@Nullable public final Object getService(@Nonnull Class<?> serviceType)
getService in interface IServiceProviderserviceType - An object that specifies the type of service object to get.null if the service does not exist.ArgumentNullException - Thrown when serviceType is null.public void addLink(@Nonnull IServiceProvider linkObject)
linkObject - The link to add.ArgumentNullException - Thrown if the linkObject is null.@Nonnull public List<IServiceProvider> getLinks()
@Nonnull public LinkGraph getLinkGraph()
LinkGraph from all the links in the propagation graph.LinkGraph representation of this graph.public boolean containsLinkOrNode(IServiceProvider linkOrNode)
linkOrNode - The link or node object to search for.