agi.foundation.communications

(agi.foundation.communications-2024r2.jar)

Class SignalDataCollection

java.lang.Object

agi.foundation.compatibility.BaseCollection<T>

agi.foundation.infrastructure.DefinitionalObjectCollection<Object>

agi.foundation.communications.SignalDataCollection

All Implemented Interfaces:

ICloneWithContext, IEnumerateDependencies, IEquatableDefinition, IFreezable, Iterable<Object>, Collection<Object>, List<Object>

public class SignalDataCollection
extends DefinitionalObjectCollection<Object>

A collection of Signal data.

Constructor Summary

Constructors

Modifier	Constructor and Description
	SignalDataCollection() Initializes a new instance.
	SignalDataCollection(Iterable<? extends Object> data) Initializes a new instance.
protected	SignalDataCollection(SignalDataCollection existingInstance, CopyContext context) Initializes a new instance as a copy of an existing instance.

Method Summary

Modifier and Type	Method and Description
protected boolean	checkForSameDefinition(DefinitionalObjectCollection<Object> other) Checks to determine if another instance has the same definition as this instance and returns true if it does.
protected boolean	checkForSameDefinition(SignalDataCollection 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.
<T> boolean	contains(TypeLiteral<T> typeLiteralT) Determines whether this collection contains data of the specified type.
boolean	containsByType(Class<?> type) Determines whether this collection contains data of the specified type.
Object	getByType(Class<?> type) Get the first object of the given type in this collection.
<T> T	getByType(TypeLiteral<T> typeLiteralT) Get the first object of the given type in this collection.
<T> void	removeAll(TypeLiteral<T> typeLiteralT) Remove all objects of the given type from this collection.

Methods inherited from class agi.foundation.infrastructure.DefinitionalObjectCollection

addRange, clearItems, enumerateDependencies, freeze, freezeAggregatedObjects, getDefinitionHashCode, getIsFrozen, insertItem, isSameDefinition, removeItem, setItem, throwIfFrozen

Methods inherited from class agi.foundation.compatibility.BaseCollection

add, add, addAll, addAll, clear, contains, containsAll, get, getItems, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, retainAll, set, size, subList, toArray, toArray

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.List

equals, hashCode, replaceAll, sort, spliterator

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

Constructor Detail

SignalDataCollection

public SignalDataCollection()

Initializes a new instance.

SignalDataCollection

public SignalDataCollection(@Nullable
                            Iterable<? extends Object> data)

Initializes a new instance.

Parameters:

data - Objects that will be added to the new signal data collection. If null, will be ignored.

SignalDataCollection

protected SignalDataCollection(@Nonnull
                               SignalDataCollection 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

Overrides:

clone in class DefinitionalObjectCollection<Object>

Parameters:

context - The context to use to perform the copy.

Returns:

A new instance which is a copy of this object.

checkForSameDefinition

protected final boolean checkForSameDefinition(DefinitionalObjectCollection<Object> other)

Description copied from class: DefinitionalObjectCollection

Checks to determine if another instance has the same definition as this instance and returns 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).

Overrides:

checkForSameDefinition in class DefinitionalObjectCollection<Object>

Parameters:

other - The other instance to compare to this one.

Returns:

true if the two objects are defined equivalently; otherwise false.

checkForSameDefinition

protected boolean checkForSameDefinition(SignalDataCollection other)

Checks to determine if another instance has the same definition as this instance and returns 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).

Parameters:

other - The other instance to compare to this one.

Returns:

true if the two objects are defined equivalently; otherwise false.

computeCurrentDefinitionHashCode

protected int computeCurrentDefinitionHashCode()

Computes a hash code based on the current properties of this object. Derived classes MUST override this method and compute a hash code that combines: a unique hash code seed, the base implementation result, and the hash codes of all new fields introduced by the derived class which are used in the SignalDataCollection.checkForSameDefinition(agi.foundation.infrastructure.DefinitionalObjectCollection<java.lang.Object>) method.

Overrides:

computeCurrentDefinitionHashCode in class DefinitionalObjectCollection<Object>

Returns:

The computed hash code.

removeAll

public final <T> void removeAll(TypeLiteral<T> typeLiteralT)

Remove all objects of the given type from this collection.

Type Parameters:

T - The type of data to remove.

Parameters:

typeLiteralT - A TypeLiteral object representing the generic type T.

getByType

@Nullable
public final <T> T getByType(TypeLiteral<T> typeLiteralT)

Get the first object of the given type in this collection.

Type Parameters:

T - The type of data to retrieve.

Parameters:

typeLiteralT - A TypeLiteral object representing the generic type T.

Returns:

The data, or null if there is no data of the given type.

contains

public final <T> boolean contains(TypeLiteral<T> typeLiteralT)

Determines whether this collection contains data of the specified type.

Type Parameters:

T - The type of data to check for.

Parameters:

typeLiteralT - A TypeLiteral object representing the generic type T.

Returns:

true if this collection contains data of the specified type; otherwise false.

getByType

@Nullable
public final Object getByType(@Nonnull
                                         Class<?> type)

Get the first object of the given type in this collection.

Parameters:

type - The type of data to retrieve.

Returns:

The data, or null if there is no data of the given type.

Throws:

ArgumentNullException - Thrown when type is null.

containsByType

public final boolean containsByType(@Nonnull
                                    Class<?> type)

Determines whether this collection contains data of the specified type.

Parameters:

type - The type of data to check for.

Returns:

true if this collection contains data of the specified type; otherwise false.