Package me.datafox.dfxengine.values.modifier

Class AbstractModifier

java.lang.Object

me.datafox.dfxengine.dependencies.AbstractDependency

me.datafox.dfxengine.dependencies.DependencyDependent

me.datafox.dfxengine.values.modifier.AbstractModifier

All Implemented Interfaces:

Comparable<Modifier>, Function<Numeral,Numeral>, Dependency, Dependent, Modifier

Direct Known Subclasses:

OperationModifier

public abstract class AbstractModifier
extends DependencyDependent
implements Modifier

An abstract implementation of Modifier. Adds itself as a Dependent to parameter Values on instantiation.

Field Summary

Fields

Modifier and Type	Field	Description
protected final int	priority	Priority for this operation

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

dependents, logger

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractModifier(org.slf4j.Logger logger, int priority, Value... parameters)

Method Summary

Modifier and Type	Method	Description
protected Value	getParameter(int index)
protected Value[]	getParameters()
protected 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.DependencyDependent

invalidate

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

Methods inherited from interface me.datafox.dfxengine.dependencies.Dependency

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

Methods inherited from interface me.datafox.dfxengine.dependencies.Dependent

invalidate

Methods inherited from interface java.util.function.Function

andThen, apply, compose

Methods inherited from interface me.datafox.dfxengine.values.api.Modifier

compareTo, getPriority

Field Details

priority

protected final int priority

Priority for this operation

Constructor Details

AbstractModifier

protected AbstractModifier(org.slf4j.Logger logger,
 int priority,
 Value... parameters)

Parameters:

logger - Logger for this modifier

priority - priority for this modifier

parameters - parameter Values for this modifier

Method Details

onInvalidate

protected 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.

Specified by:

onInvalidate in class DependencyDependent

getParameter

protected Value getParameter(int index)

Parameters:

index - parameter index

Returns:

parameter Value for the specified index

Throws:

ArrayIndexOutOfBoundsException - if the index is out of bounds

getParameters

protected Value[] getParameters()

Returns:

array of parameter Values