Package com.almworks.jira.structure.api.attribute.loader.builder

Class BaseAttributeLoader<T>

Object

BaseAttributeLoader<T>

All Implemented Interfaces:

AttributeLoader<T>

Direct Known Subclasses:

BaseDerivedAttributeLoader, BaseItemAttributeLoader, BaseSingleRowAttributeLoader

public abstract class BaseAttributeLoader<T>
extends Object
implements AttributeLoader<T>

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BaseAttributeLoader(AttributeSpec<T> attributeSpec, Set<AttributeSpec<?>> dependencies, Set<AttributeContextDependency> contextDependencies, AttributeCachingStrategy cachingStrategy, TrailItemSet globalTrail)	Creates the loader.

Method Summary

Modifier and Type	Method	Description
Set<AttributeSpec<?>>	getAttributeDependencies()	Returns attributes that need to be loaded prior to calling this loader's loading function.
AttributeSpec<T>	getAttributeSpec()	Returns the spec for which this loader loads values.
AttributeCachingStrategy	getCachingStrategy()	Indicates how the values provided by this loader should be cached.
Set<AttributeContextDependency>	getContextDependencies()	Indicates which context values are used to calculate the value of the attribute.
TrailItemSet	getGlobalTrail()	Returns global trail.

Methods inherited from class Object

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

Constructor Details

BaseAttributeLoader

protected BaseAttributeLoader(@NotNull
 AttributeSpec<T> attributeSpec,
 @Nullable
 Set<AttributeSpec<?>> dependencies,
 @Nullable
 Set<AttributeContextDependency> contextDependencies,
 @Nullable
 AttributeCachingStrategy cachingStrategy,
 @Nullable
 TrailItemSet globalTrail)

Creates the loader. All collections passed must be immutable.

Method Details

getAttributeSpec

@NotNull
public AttributeSpec<T> getAttributeSpec()

Description copied from interface: AttributeLoader

Returns the spec for which this loader loads values.

The returned value must be the same throughout the lifetime of the object.

Specified by:

getAttributeSpec in interface AttributeLoader<T>

Returns:

spec being loaded

getAttributeDependencies

@Nullable
public Set<AttributeSpec<?>> getAttributeDependencies()

Description copied from interface: AttributeLoader

Returns attributes that need to be loaded prior to calling this loader's loading function.

The returned value must be the same throughout the lifetime of the object.

Specified by:

getAttributeDependencies in interface AttributeLoader<T>

Returns:

the set of attribute dependencies, or null if there are none

See Also:

• AttributeLoaderContext.getDependencyValue(com.almworks.jira.structure.api.attribute.AttributeSpec<V>)

getContextDependencies

@Nullable
public Set<AttributeContextDependency> getContextDependencies()

Description copied from interface: AttributeLoader

Indicates which context values are used to calculate the value of the attribute.

For example, if the calculated value depends on the current user, the return value from this method must include AttributeContextDependency.USER.

The returned value must be the same throughout the lifetime of the object.

Specified by:

getContextDependencies in interface AttributeLoader<T>

Returns:

the set of context dependencies or null if there are none

getCachingStrategy

@Nullable
public AttributeCachingStrategy getCachingStrategy()

Description copied from interface: AttributeLoader

Indicates how the values provided by this loader should be cached.

The returned value must be the same throughout the lifetime of the object.

Specified by:

getCachingStrategy in interface AttributeLoader<T>

Returns:

caching strategy, null has the same effect as AttributeCachingStrategy.MAY

getGlobalTrail

@Nullable
public TrailItemSet getGlobalTrail()

Description copied from interface: AttributeLoader

Returns global trail. When an item from a global trail changes, all values calculated for this attribute will be invalidated and will need to be recalculated.

The returned value must be the same throughout the lifetime of the object.

Specified by:

getGlobalTrail in interface AttributeLoader<T>

Returns:

global trail set, or null if none