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

Interface AttributeContext

All Known Subinterfaces:

AttributeLoader.AggregateContext<T>, AttributeLoader.Context, AttributeLoader.PropagateContext<T>, ExportRenderContext, ExportRequestContext

@PublicApi
public interface AttributeContext

An AttributeContext is associated with every attribute request and Structure export request. The context contains some basic information, like the current user and JIRA base URL, and it can also contain other data associated with the current request by Structure or other plug-ins. The current context is passed into every call to AttributeLoaderProvider, AttributeLoader, ExportRendererProvider, and ExportRenderer.

Please note that the context key space is shared by all plug-ins, so we advise you to use plugin-private keys (e.g. singleton objects or custom enums) to avoid conflicts.

See Also:

ExportContextKeys, ExportRequestContext, ExportRenderContext

Method Summary

Modifier and Type	Method and Description
ForestSpec	getBaseForestSpec() Returns the base forest spec, for which the attribute is being calculated.
default long	getBaseStructureId()
String	getBaseUrl()
com.atlassian.jira.util.I18nHelper	getI18nHelper()
Locale	getLocale()
<T> T	getObject(Object key) Retrieve the value associated with a key.
com.atlassian.jira.user.ApplicationUser	getUser()
void	putObject(Object key, Object value) Associate an arbitrary value with the given request.

Method Detail

getUser

@Nullable
com.atlassian.jira.user.ApplicationUser getUser()

Returns:

The logged-in user, or null if anonymous.

getI18nHelper

@NotNull
com.atlassian.jira.util.I18nHelper getI18nHelper()

Returns:

The I18nHelper instance for the current user.

getLocale

@NotNull
Locale getLocale()

Returns:

The current user's Locale.

getBaseUrl

@NotNull
String getBaseUrl()

Returns:

The base URL of the JIRA instance.

putObject

void putObject(@NotNull
               Object key,
               @Nullable
               Object value)

Associate an arbitrary value with the given request. The value can be retrieved by passing the same key to getObject(Object).

Please note that AttributeContext instances are shared by all attribute loader providers or export renderer providers from all plug-ins. Therefore we recommend you to use plugin-private keys (e.g. singleton objects or custom enums) to avoid conflicts.

Parameters:

key - The key.

value - The value. Pass null to clear the object associated with the given key.

Throws:

IllegalArgumentException - if key is read-only.

getObject

@Nullable
<T> T getObject(@NotNull
                          Object key)

Retrieve the value associated with a key.

Type Parameters:

T - The expected type of the value.

Parameters:

key - The key.

Returns:

The object associated with the key, or null if none.

Throws:

ClassCastException - if the value is not an instance of type <T>.

getBaseForestSpec

@Nullable
ForestSpec getBaseForestSpec()

Returns the base forest spec, for which the attribute is being calculated. Returns null when the attribute is calculated for a forest without forest spec.

getBaseStructureId

default long getBaseStructureId()