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

Class ItemClassAttributeLoader<T,A>

Object

AbstractAttributeLoader<T>

AbstractItemAttributeLoader<A>

ItemTypeAttributeLoader<A>

ItemClassAttributeLoader<T,A>

All Implemented Interfaces:

AttributeLoader<A>, ItemAttributeLoader<A>

Direct Known Subclasses:

IssueAttributeLoader

public abstract class ItemClassAttributeLoader<T,A>
extends ItemTypeAttributeLoader<A>

Field Summary

Fields inherited from class ItemTypeAttributeLoader

myItemTypes

Fields inherited from class AbstractAttributeLoader

mySpec

Constructor Summary

Constructors

Constructor and Description
ItemClassAttributeLoader(AttributeSpec<A> spec, Class<T> itemClass, String... itemTypes)

Method Summary

Modifier and Type	Method and Description
protected abstract AttributeValue<A>	getValue(T item, ItemAttributeContext context)
AttributeValue<A>	loadValue(ItemIdentity itemId, ItemAttributeContext context) The loading function.

Methods inherited from class ItemTypeAttributeLoader

isItemTypeSupported

Methods inherited from class AbstractAttributeLoader

getAttributeSpec, toString

Methods inherited from class Object

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

Methods inherited from interface ItemAttributeLoader

preload

Methods inherited from interface AttributeLoader

getAttributeDependencies, getAttributeSpec, getCachingStrategy, getContextDependencies, getGlobalTrail

Constructor Detail

ItemClassAttributeLoader

public ItemClassAttributeLoader(AttributeSpec<A> spec,
                                Class<T> itemClass,
                                String... itemTypes)

Method Detail

loadValue

public AttributeValue<A> loadValue(@NotNull
                                   ItemIdentity itemId,
                                   @NotNull
                                   ItemAttributeContext context)

Description copied from interface: ItemAttributeLoader

The loading function. The implementation is expected to take itemId or the item object (see ItemAttributeContext.getItem(java.lang.Class<I>)) and provide a value.

Attribute system's contract:

• Before this method is called, ItemAttributeLoader.isItemTypeSupported(java.lang.String) method has been called at least once for the type of the passed item, and this loader has returned true.
• Before this method is called, ItemAttributeLoader.preload(java.util.Collection<com.almworks.jira.structure.api.item.ItemIdentity>, com.almworks.jira.structure.api.attribute.loader.AttributeContext) has been called for a set of items that included itemId, and that was a part of the same loading process, sharing the same context (so all values put into the context are still there).

If the value is missing or empty, the loader should return AttributeValue.undefined(). If for some reason this loader is not applicable for the given item, it should return null.

Parameters:

itemId - item to load the value for

context - loading context

Returns:

attribute value, or null to pass on loading a value for this item

getValue

@Nullable
protected abstract AttributeValue<A> getValue(@NotNull
                                                        T item,
                                                        @NotNull
                                                        ItemAttributeContext context)