Package me.datafox.dfxengine.dependencies

Class DependencyDependent

java.lang.Object

me.datafox.dfxengine.dependencies.AbstractDependency

me.datafox.dfxengine.dependencies.DependencyDependent

All Implemented Interfaces:

Dependency, Dependent

Direct Known Subclasses:

AbstractModifier, ValueImpl

public abstract class DependencyDependent
extends AbstractDependency
implements Dependent

A class with values that values of other classes depend on. A class with values depending on the implementing class should implement Dependent, and all dependencies should be added to the class implementing this interface with AbstractDependency.addDependent(Dependent) or AbstractDependency.addDependents(Collection). The implementation of these methods must check for cyclic dependencies and throw IllegalArgumentException if one would be caused by the operation.

This class also implements Dependent. Calls Dependency.invalidateDependents() when the implemented Dependent.invalidate() is called. This class is the recommended way to create dependency graphs spanning multiple levels.

The cyclic dependency detection in this class will only detect dependent dependencies that implement both Dependency and Dependent.

Field Summary

Fields inherited from class me.datafox.dfxengine.dependencies.AbstractDependency

dependents, logger

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	DependencyDependent(org.slf4j.Logger logger)

Method Summary

Modifier and Type	Method	Description
void	invalidate()	Invalidates the class implementing this interface.
protected abstract void	onInvalidate()	This method should be treated as the equivalent of Dependent.invalidate() for classes extending DependencyDependent.

Methods inherited from class me.datafox.dfxengine.dependencies.AbstractDependency

addDependent, addDependents, containsDependent, containsDependentRecursive, containsDependents, containsDependentsRecursive, dependentStream, getDependents, invalidateDependents, recursiveDependentStream, removeDependent, removeDependents

Methods inherited from class java.lang.Object

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

Constructor Details

DependencyDependent

protected DependencyDependent(org.slf4j.Logger logger)

Parameters:

logger - Logger for this dependent

Method Details

invalidate

public void invalidate()

Invalidates the class implementing this interface. In practice, this should invalidate the caches of any values that are dependent on values of other classes. Because this method may be called multiple times, it is not recommended to recalculate the cached value in this method, and instead create an invalidated flag that is set in this method, and recalculate the value in its getter method if the flag is set. Instead of overriding this method, onInvalidate() should be overridden instead.

Specified by:

invalidate in interface Dependent

onInvalidate

protected abstract void onInvalidate()

This method should be treated as the equivalent of Dependent.invalidate() for classes extending DependencyDependent. This exists to avoid the need for calling super.invalidate() or AbstractDependency.invalidateDependents() which may cause hidden or hard to find bugs when forgotten.