agi.foundation.segmentpropagation

(agi.foundation.segmentpropagation-2025r1.jar)

Class ReturnSegmentConfiguration

java.lang.Object

agi.foundation.segmentpropagation.SegmentConfiguration

agi.foundation.segmentpropagation.ReturnSegmentConfiguration

All Implemented Interfaces:

ICloneWithContext

public class ReturnSegmentConfiguration
extends SegmentConfiguration

The configuration for a ReturnSegment.

Constructor Summary

Constructors

Modifier	Constructor and Description
	ReturnSegmentConfiguration(ReturnSegmentBehavior behavior) Initializes a new instance.
protected	ReturnSegmentConfiguration(ReturnSegmentConfiguration existingInstance, CopyContext context) Initializes a new instance as a copy of an existing instance.

Method Summary

Modifier and Type	Method and Description
boolean	actuallyEnabled() Gets if this segment is actually enabled or not.
Object	clone(CopyContext context) Clones this object using the specified context.
boolean	getIsNonNominalRunDifferent() Gets a value indicating whether the associated SegmentPropagator will behave differently if it is being run nominally or not.
ReturnSegmentBehavior	getReturnSegmentBehavior() Gets if the ReturnSegment that this configuration is for will actually return or not.
void	setReturnSegmentBehavior(ReturnSegmentBehavior value) Sets if the ReturnSegment that this configuration is for will actually return or not.

Methods inherited from class agi.foundation.segmentpropagation.SegmentConfiguration

getDefaultInitialState, getNominalRun, setDefaultInitialState, setNominalRun

Methods inherited from class java.lang.Object

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

Constructor Detail

ReturnSegmentConfiguration

public ReturnSegmentConfiguration(@Nonnull
                                  ReturnSegmentBehavior behavior)

Initializes a new instance.

Parameters:

behavior - If the ReturnSegment that this is a configuration will actually return or not.

ReturnSegmentConfiguration

protected ReturnSegmentConfiguration(@Nonnull
                                     ReturnSegmentConfiguration existingInstance,
                                     @Nonnull
                                     CopyContext context)

Initializes a new instance as a copy of an existing instance.

See ICloneWithContext.clone(CopyContext) for more information about how to implement this constructor in a derived class.

Parameters:

existingInstance - The existing instance to copy.

context - A CopyContext that controls the depth of the copy.

Throws:

ArgumentNullException - Thrown when existingInstance or context is null.

Method Detail

clone

public Object clone(CopyContext context)

Clones this object using the specified 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:

1. Fields that are aggregate parts of the object should always be copied. A referenced object is an aggregate if properties or methods on the object being copied can modify the externally-visible value of the referenced object.
2. If the semantics of the referenced object require that it have a single parent, owner, context, etc., and the object being copied is that parent, owner, or context, then the referenced object should always be copied.

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:

1. For references to other evaluators ONLY, simply assign the reference in the constructor instead of calling CopyContext.updateReference(T). You should still call CopyContext.updateReference(T) on any references to non-evaluators.
2. Call IEvaluator.updateEvaluatorReferences(agi.foundation.infrastructure.CopyContext) as the last line in the constructor and pass it the same CopyContext passed to the constructor.
3. Implement 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;

Specified by:

clone in interface ICloneWithContext

Specified by:

clone in class SegmentConfiguration

Parameters:

context - The context to use to perform the copy.

Returns:

A new instance which is a copy of this object.

actuallyEnabled

public final boolean actuallyEnabled()

Gets if this segment is actually enabled or not. This will check both the ReturnSegmentBehavior (get / set) and NominalRun (get / set), and return true if the appropriate combination of them would have the ReturnSegment actually return; otherwise false.

Returns:

true if the ReturnSegment should actually return, false if it should not.

getReturnSegmentBehavior

@Nonnull
public final ReturnSegmentBehavior getReturnSegmentBehavior()

Gets if the ReturnSegment that this configuration is for will actually return or not. Note that the ReturnSegment can behave differently if it is being run in a TargetedSegmentListOperator or not, you should always check the NominalRun (get / set) when checking this property. Or, use the ReturnSegmentConfiguration.actuallyEnabled() instead of getting this property.

setReturnSegmentBehavior

public final void setReturnSegmentBehavior(@Nonnull
                                           ReturnSegmentBehavior value)

Sets if the ReturnSegment that this configuration is for will actually return or not. Note that the ReturnSegment can behave differently if it is being run in a TargetedSegmentListOperator or not, you should always check the NominalRun (get / set) when checking this property. Or, use the ReturnSegmentConfiguration.actuallyEnabled() instead of getting this property.

getIsNonNominalRunDifferent

public boolean getIsNonNominalRunDifferent()

Gets a value indicating whether the associated SegmentPropagator will behave differently if it is being run nominally or not. You should overload this property to return true if the specific segment type might behave differently in an unofficial propagation. By default this returns false indicating that there is no difference.

Overrides:

getIsNonNominalRunDifferent in class SegmentConfiguration

Returns:

true if the SegmentPropagator will behave differently based on the NominalRun (get / set) settings; otherwise false.