com.almworks.jira.structure.api.attribute.loader.composition

Class CompositeAttributeLoader<T,L extends AttributeLoader<T>>

Object

AbstractAttributeLoader<T>

CompositeAttributeLoader<T,L>

All Implemented Interfaces:

AttributeLoader<T>

public abstract class CompositeAttributeLoader<T,L extends AttributeLoader<T>>
extends AbstractAttributeLoader<T>

Field Summary

Fields inherited from class AbstractAttributeLoader

mySpec

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CompositeAttributeLoader(AttributeSpec<T> spec, Collection<L> loaders)

Method Summary

Modifier and Type	Method and Description
static <T> AttributeLoader<T>	create(AttributeSpec<T> spec, List<AttributeLoader<T>> loaders)
Set<AttributeSpec<?>>	getAttributeDependencies() Returns attributes that need to be loaded prior to calling this loader's loading function.
AttributeCachingStrategy	getCachingStrategy() Indicates how the values provided by this loader should be cached.
static <L extends AttributeLoader<?>> AttributeCachingStrategy	getCompositeCachingStrategy(AttributeSpec<?> spec, Collection<L> loaders)
static <L extends AttributeLoader<?>> Set<AttributeContextDependency>	getCompositeContextDependencies(Collection<L> loaders)
static <L extends AttributeLoader<?>> Set<AttributeSpec<?>>	getCompositeDependencies(Collection<L> loaders)
static <L extends AttributeLoader<?>> TrailItemSet	getCompositeGlobalTrail(Collection<L> loaders)
Set<AttributeContextDependency>	getContextDependencies() Indicates which context values are used to calculate the value of the attribute.
TrailItemSet	getGlobalTrail() Returns global trail.
static List<Class<?>>	getLoaderClasses(AttributeLoader<?> loader)

Methods inherited from class AbstractAttributeLoader

getAttributeSpec, toString

Methods inherited from class Object

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

Constructor Detail

CompositeAttributeLoader

protected CompositeAttributeLoader(AttributeSpec<T> spec,
                                   @NotNull
                                   Collection<L> loaders)

Method Detail

create

public static <T> AttributeLoader<T> create(AttributeSpec<T> spec,
                                            List<AttributeLoader<T>> loaders)

getCachingStrategy

@NotNull
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.

Returns:

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

getAttributeDependencies

@NotNull
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.

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

@NotNull
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.

Returns:

the set of context dependencies or null if there are none

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.

Returns:

global trail set, or null if none

getCompositeCachingStrategy

public static <L extends AttributeLoader<?>> AttributeCachingStrategy getCompositeCachingStrategy(AttributeSpec<?> spec,
                                                                                                  Collection<L> loaders)

getCompositeDependencies

public static <L extends AttributeLoader<?>> Set<AttributeSpec<?>> getCompositeDependencies(Collection<L> loaders)

getCompositeContextDependencies

public static <L extends AttributeLoader<?>> Set<AttributeContextDependency> getCompositeContextDependencies(Collection<L> loaders)

getCompositeGlobalTrail

public static <L extends AttributeLoader<?>> TrailItemSet getCompositeGlobalTrail(Collection<L> loaders)

getLoaderClasses

public static List<Class<?>> getLoaderClasses(AttributeLoader<?> loader)