agi.foundation.infrastructure

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

Class ObjectExtension

java.lang.Object

agi.foundation.infrastructure.DefinitionalObject

agi.foundation.infrastructure.ObjectExtension

All Implemented Interfaces:

ICloneWithContext, IEnumerateDependencies, IEquatableDefinition, IFreezable, IServiceProvider

Direct Known Subclasses:

AccessConstraintsExtension, AccessResultExtension, AzimuthElevationMaskExtension, AzimuthElevationMaskGraphicsExtension, AzimuthElevationMaskGraphicsExtension, BaseReceivingAntennaExtension, BaseTransmittingAntennaExtension, BillboardGraphicsExtension, CentralBodySurfaceCurve, CentralBodySurfaceCurveGraphicsExtension, CentralBodySurfaceCurveGraphicsExtension, CentralBodySurfaceRegion, CentralBodySurfaceRegionGraphicsExtension, CentralBodySurfaceRegionGraphicsExtension, CesiumAvailabilityExtension, CesiumCustomPropertiesExtension, CesiumDeleteExtension, CesiumDeleteFanDirectionsExtension, CesiumDeleteOrientationExtension, CesiumDeletePolygonHolesExtension, CesiumDeletePolygonPositionsExtension, CesiumDeletePolylinePositionsExtension, CesiumDeletePositionExtension, CesiumDeleteVectorDirectionExtension, CesiumFixedStepExtension, CesiumOrientationExtension, CesiumPositionExtension, CesiumReferenceFrameExtension, ChildrenExtension, DescriptionExtension, DynamicFieldOfViewExtension, EllipsoidGraphicsExtension, FieldOfViewCentralBodyProjectionGraphicsExtension, FieldOfViewExtension, FieldOfViewGraphicsExtension, GpsReceiverExtension, GpsSatelliteExtension, GpsSatelliteInformationExtension, IdentifiableTransmitterExtension, IdentifierExtension, ImagingDeviceExtension, LabelGraphicsExtension, LinkGraphicsExtension, LinkGraphicsExtension, LocationPointCovarianceExtension, LocationPointCovarianceGraphicsExtension, LocationPointExtension, MarkerGraphicsExtension, ModelGraphicsExtension, ModelGraphicsExtension, NameExtension, NavigationTransmitterExtension, OrientationAxesExtension, ParentExtension, PathGraphicsExtension, PointGraphicsExtension, PointGraphicsExtension, PointScattererExtension, ProcessedRadarWaveformOutputExtension, ReferenceFrameGraphicsExtension, SignalOutputExtension, TextGraphicsExtension, TilesetGraphicsExtension, ViewFromExtension, WeightedLinkExtension, WirelessLinkExtension

public abstract class ObjectExtension
extends DefinitionalObject
implements IServiceProvider

The base class for extensions that can be added at run-time to ExtensibleObject instances in order to give them additional properties and behaviors.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ObjectExtension() Initializes a new instance.
protected	ObjectExtension(ObjectExtension 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(DefinitionalObject other) Checks to determine if another instance has the same definition as this instance and returns true if it does.
protected abstract boolean	checkForSameDefinition(ObjectExtension other) Checks to determine if another instance has the same definition as this instance and returns true if it does.
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.
ExtensibleObject	getOwner() Gets the owner of this extension.
Object	getService(Class<?> serviceType) Gets the service object of the specified type.

Methods inherited from class agi.foundation.infrastructure.DefinitionalObject

areSameDefinition, areSameDefinition, areSameDefinition, areSameDefinition, areSameDefinition, clone, collectionItemsAreSameDefinition, collectionItemsAreSameDefinition, collectionItemsAreSameDefinition, dictionaryItemsAreSameDefinition, freeze, freezeAggregatedObjects, getCollectionHashCode, getCollectionHashCode, getCollectionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDictionaryHashCode, getIsFrozen, isSameDefinition, throwIfFrozen

Methods inherited from class java.lang.Object

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

Constructor Detail

ObjectExtension

protected ObjectExtension()

Initializes a new instance.

ObjectExtension

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

checkForSameDefinition

protected final boolean checkForSameDefinition(DefinitionalObject 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).

Specified by:

checkForSameDefinition in class DefinitionalObject

Parameters:

other - The other instance to compare to this one.

Returns:

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

checkForSameDefinition

protected abstract boolean checkForSameDefinition(ObjectExtension 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 ObjectExtension.checkForSameDefinition(agi.foundation.infrastructure.DefinitionalObject) method.

Overrides:

computeCurrentDefinitionHashCode in class DefinitionalObject

Returns:

The computed hash code.

enumerateDependencies

public void enumerateDependencies(DependencyEnumerator enumerator)

Enumerates the dependencies of this object by calling 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.

Specified by:

enumerateDependencies in interface IEnumerateDependencies

Overrides:

enumerateDependencies in class DefinitionalObject

Parameters:

enumerator - The enumerator that is informed of the dependencies of this object.

getOwner

public final ExtensibleObject getOwner()

Gets the owner of this extension.

getService

@Nullable
public Object getService(@Nonnull
                                    Class<?> serviceType)

Gets the service object of the specified type.

Specified by:

getService in interface IServiceProvider

Parameters:

serviceType - An object that specifies the type of service object to get.

Returns:

The found service, or null if the service does not exist.

Throws:

ArgumentNullException - Thrown when serviceType is null.