public abstract class FollowSegmentBeginningPropagator extends Object implements IThreadAware, IDisposable
propagator
of a FollowSegment.| Modifier | Constructor and Description |
|---|---|
protected |
FollowSegmentBeginningPropagator()
Initializes a new instance.
|
protected |
FollowSegmentBeginningPropagator(FollowSegmentBeginningPropagator existingInstance,
CopyContext context)
Initializes a new instance as a copy of an existing instance.
|
| Modifier and Type | Method and Description |
|---|---|
abstract Object |
clone(CopyContext context)
Clones this object using the specified context.
|
void |
dispose()
Releases any resources associated with this instance.
|
protected abstract void |
dispose(boolean disposing)
Releases any resources associated with this instance.
|
abstract ITimeBasedState |
evaluateInitialState(SegmentPropagator basePropagateSegmentPropagator,
PropagateSegmentConfiguration propagatorConfiguration,
SegmentListResults previousResults,
IntegrationSense direction)
Computes the initial state that the segment will propagate from.
|
abstract boolean |
getIsThreadSafe()
Gets a value indicating whether the methods on this instance are safe to call from
multiple threads simultaneously.
|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitcloseprotected FollowSegmentBeginningPropagator()
protected FollowSegmentBeginningPropagator(@Nonnull FollowSegmentBeginningPropagator 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 abstract 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 final void dispose()
dispose in interface IDisposableprotected abstract void dispose(boolean disposing)
disposing - true to release both managed and unmanaged resources;
false to release only unmanaged resources.public abstract boolean getIsThreadSafe()
If this property is true, all methods and properties are guaranteed to be thread safe.
Conceptually, an object that returns true for this method acts as if there is a lock
protecting each method and property such that only one thread at a time can be inside any method or
property in the class. In reality, such locks are generally not used and are in fact discouraged. However,
the user must not experience any exceptions or inconsistent behavior that would not be experienced if such
locks were used.
If this property is false, the behavior when using this class from multiple threads
simultaneously is undefined and may include inconsistent results and exceptions. Clients wishing to use
multiple threads should call CopyForAnotherThread.copy(T) to get a separate instance of the
object for each thread.
getIsThreadSafe in interface IThreadAware@Nonnull public abstract ITimeBasedState evaluateInitialState(SegmentPropagator basePropagateSegmentPropagator, PropagateSegmentConfiguration propagatorConfiguration, @Nullable SegmentListResults previousResults, @Nonnull IntegrationSense direction)
SegmentPropagator is passed in, the only result that matters is the
state that the parent FollowSegment
should start propagating from.basePropagateSegmentPropagator - The SegmentPropagator that can be propagated to
produce the FollowSegment's initial state.propagatorConfiguration - The configuration needed to run the
basePropagateSegmentPropagator. Only needed if the
basePropagateSegmentPropagator will be propagated.previousResults - The cumulative results of propagation up to this point
to use when running the basePropagateSegmentPropagator. Only needed
if the basePropagateSegmentPropagator will be propagated.direction - The direction of propagation.state that the FollowSegment
should start propagating from.