AttributeProviderContext (Structure API 17.26.0 API)

All Superinterfaces:: AttributeContext

@PublicApi public interface AttributeProviderContext extends AttributeContext

Provides context for the creation of attribute loaders.

See Also:

AttributeLoaderProvider

Method Summary

Modifier and Type

Method

Description

boolean

isItemAttribute(AttributeSpec<?> attribute)

Checks if the attribute is based only on items, which means the value will not depend on a particular position of the item in the forest.

void

mustNotCacheLoader()

Tells the system to avoid caching the loader produced by the provider.

Methods inherited from interface AttributeContext
getBaseStructureId, getBaseUrl, getI18n, getI18nHelper, getLoadTimeMillis, getLoadTimeNanos, getLocale, getObject, getTimeZone, getUser, putObject

Method Details
- mustNotCacheLoader
  
  void mustNotCacheLoader()
  
  Tells the system to avoid caching the loader produced by the provider.
- isItemAttribute
  
  boolean isItemAttribute(@Nullable AttributeSpec<?> attribute)
  
  Checks if the attribute is based only on items, which means the value will not depend on a particular position of the item in the forest. Such attributes may be used with StructureAttributeService.getItemValues(java.util.Collection<com.almworks.jira.structure.api.item.ItemIdentity>, java.util.Collection<? extends com.almworks.jira.structure.api.attribute.AttributeSpec<?>>).
  
  An attribute may change to item-based or to forest-based during runtime, if extension apps are installed.
  
  This method is the same as StructureAttributeService.isItemAttribute(com.almworks.jira.structure.api.attribute.AttributeSpec<?>) and is supposed to be used by the providers to adjust the loaders based on whether dependent attributes are item based or not.
  
  Parameters:
  
  attribute - attribute
  
  Returns:
  
  true if the attribute is item-based