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

This package is a part of Structure Attributes SPI.

See: Description

Interface Summary

Interface	Description
AggregateAttributeContext	The context interface for aggregate attribute loaders.
AggregateAttributeLoader<T>	Aggregate attributes have values calculated up through the hierarchy.
AttributeContext	An AttributeContext is associated with every attribute request and Structure export request.
AttributeLoader<T>	An AttributeLoader contains code that loads values for a particular attribute, represented by AttributeSpec.
AttributeLoaderContext	This interface adds methods to AttributeContext that are used only by attribute loaders.
AttributeLoaderProvider	Attributes extension point - you can add new attributes and attribute implementations to the system by implementing this interface and declaring the implementation in atlassian-plugin.xml.
AttributeProviderContext	Provides context for the creation of attribute loaders.
DerivedAttributeContext	The context interface for derived attribute loaders.
DerivedAttributeLoader<T>	Derived loaders calculate the attribute value based only on the attribute dependencies.
ItemAttributeContext	The context interface for item attribute loaders.
ItemAttributeLoader<T>	Item loaders calculate attribute value for a particular item, based on ItemIdentity.
MultiRowAttributeLoader<T>	A multi-row loader provide a value for a single row, but also considering the previously calculated value of the same attribute for some other rows in the forest.
PropagateAttributeContext	The context interface for propagate attribute loaders.
PropagateAttributeContext.Parent	The context interface for preparing children loading function by a propagate.
PropagateAttributeLoader<T>	Propagate attributes have values calculated down through the hierarchy.
RowAttributeContext	The base context interface for all row-based attribute loaders.
RowAttributeLoader<T>	Common base interface for all row-based attribute loaders.
ScanningAttributeContext	The context interface for scanning attribute loaders.
ScanningAttributeLoader<T>	Scanning attributes are used to process and aggregate values across all the forest, from top to bottom (depth-first traversal).
SingleRowAttributeContext	The context interface for single row attribute loaders.
SingleRowAttributeLoader<T>	A single row attribute loader provides an attribute value based on a single forest row.
TrailItemSet.ReadVisitor	Alternate visitor interface for reading out the specific items and types.
TrailItemSet.Visitor	Visitor interface for analyzing the set.

Class Summary

Class	Description
AttributeLoaders
SharedAttributeLoaders
TrailItemSet	Abstract class for defining a set of items (by their ItemIdentity).
TrailItemSet.AllItems	Represents a set of all items.
TrailItemSet.Collector	Used to collect specific types and items stored in the TrailItemSet.
TrailItemSet.None	Represents an empty set.
TrailItemSet.OneItem	Represents a set with just one item.
TrailItemSet.OneType	Represents a set of all items of one specific type.
TrailItemSet.SpecificItems	Represents a set of several specific items.
TrailItemSet.SpecificTypes	Represents a set of all items of several specific types.

Enum Summary

Enum	Description
AttributeCachingStrategy	Defines how the values provided by an attribute loader are cached.
AttributeContextDependency	Allows the attribute loader to declare that the value it produces is calculated using some of the values from the context.

Annotation Types Summary

Annotation Type	Description
NonSensitiveInStandardMode	The annotation is used to mark a custom value format as non-sensitive in standard mode.

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

This package is a part of Structure Attributes SPI. It provides the classes necessary to define your own attribute by providing an instance of AttributeLoader.

An app would typically declare an attribute loader by registering a component that implements AttributeLoaderProvider interface.