com.almworks.jira.structure.api.attribute

Class AttributeTrail.EmptyTrail

java.lang.Object

com.almworks.jira.structure.api.attribute.AttributeTrail.EmptyTrail

All Implemented Interfaces:

AttributeTrail

Enclosing interface:

AttributeTrail

public static class AttributeTrail.EmptyTrail
extends Object
implements AttributeTrail

Empty trail implementation

Nested Class Summary

Nested classes/interfaces inherited from interface com.almworks.jira.structure.api.attribute.AttributeTrail

AttributeTrail.EmptyTrail

Field Summary

Fields inherited from interface com.almworks.jira.structure.api.attribute.AttributeTrail

EMPTY

Constructor Summary

Constructors

Constructor and Description
EmptyTrail()

Method Summary

Modifier and Type	Method and Description
TrailItemSet	getAdditionalItemDependencies(Long row) Returns a set of additional items that need to be tracked.
Set<ForestDependencyType>	getTrailMode() Returns all types of in-forest dependencies that were used to calculate this value.
boolean	isCacheable(Long row) Returns true if the value for the row can be reliably cached and invalidated, by observing forest changes (according to trail mode), and item changes (according to row's item and additional dependencies).

Methods inherited from class java.lang.Object

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

Constructor Detail

EmptyTrail

public EmptyTrail()

Method Detail

getTrailMode

@NotNull
public Set<ForestDependencyType> getTrailMode()

Description copied from interface: AttributeTrail

Returns all types of in-forest dependencies that were used to calculate this value.

An attribute value may be calculated using only the row requested (ForestDependencyType.INDEPENDENT), or all sub-rows in the forest (ForestDependencyType.AGGREGATE), or in "top-down" manner (ForestDependencyType.PROPAGATE), or a combination of these calculations. Depending on the type, forest change and other items need to be tracked for correct invalidation.

Specified by:

getTrailMode in interface AttributeTrail

getAdditionalItemDependencies

@Nullable
public TrailItemSet getAdditionalItemDependencies(Long row)

Description copied from interface: AttributeTrail

Returns a set of additional items that need to be tracked. If an item in the set is changed, then the value for given row needs recalculation.

Specified by:

getAdditionalItemDependencies in interface AttributeTrail

Parameters:

row - row ID for which the trail is retrieved

Returns:

an item set which should be tracked for correct invalidation of the value for the given row, or null if there's no value

isCacheable

public boolean isCacheable(Long row)

Description copied from interface: AttributeTrail

Returns true if the value for the row can be reliably cached and invalidated, by observing forest changes (according to trail mode), and item changes (according to row's item and additional dependencies). false is returned only when the row has been mapped to another row, and so correct invalidation according to forest updates is impossible

Specified by:

isCacheable in interface AttributeTrail