Package com.atlassian.jira.plugin.navigation

Class FooterDataProvider

java.lang.Object

com.atlassian.jira.plugin.navigation.FooterDataProvider

@ParametersAreNonnullByDefault
public class FooterDataProvider
extends Object

Provides data for the standard footer.

Since:

7.4

Method Summary

Modifier and Type	Method	Description
Map<String,Object>	addToMap(Map<String,Object> footerModel)	Takes existing map and adds data needed to render standard footer
JSONObject	asJSON()	Assembles data needed to render the footer
Map<String,Object>	asMap()	Assembles data needed to render the footer
static FooterDataProvider	getInstance(String contextPath)	Create an instance of FooterDataProvider.

Methods inherited from class java.lang.Object

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

Method Details

getInstance

public static FooterDataProvider getInstance(String contextPath)

Create an instance of FooterDataProvider. This footer may be rendered at any given time. However not all required Compontents are available at any given time in the PICO Container. As long as the PICO Container is not fully initialized we can not be sure it can provide all needed Components. Therefore we take care of creating our own instance and handling non existing Components gracefully rather than getting our Dependencies injected.

Since:

7.4

asJSON

@Nonnull
public JSONObject asJSON()

Assembles data needed to render the footer

Returns:

JSONObject containing data needed to render standard footer

asMap

@Nonnull
public Map<String,Object> asMap()

Assembles data needed to render the footer

Returns:

map containing data to render the standard footer

addToMap

@Nonnull
public Map<String,Object> addToMap(Map<String,Object> footerModel)

Takes existing map and adds data needed to render standard footer

Parameters:

footerModel - the map to add the footer data to

Returns:

map containing data to render the standard footer