com.atlassian.confluence.plugins.createcontent.api.contextproviders

Class BlueprintContext

java.lang.Object

com.atlassian.confluence.plugins.createcontent.api.contextproviders.BlueprintContext

@PublicApi
public class BlueprintContext
extends Object

Wraps the Blueprint Context map to provide getters and setters rather than direct access to the map values.

Constructor Summary

Constructors

Constructor and Description
BlueprintContext()

Method Summary

Modifier and Type	Method and Description
Object	get(String key) Use this get method sparingly!
String	getAnalyticsKey()
UUID	getBlueprintId()
com.atlassian.plugin.ModuleCompleteKey	getBlueprintModuleCompleteKey()
String	getCreateFromTemplateLabel()
String	getCreateResult()
Map<String,Object>	getMap() This method is note for use in plugins: only the AbstractBlueprintContextProvider should call it.
String	getSpaceKey()
String	getTemplateLabel()
void	put(String key, Object value) Use this put method sparingly!
void	setAnalyticsKey(String key)
void	setBlueprintId(UUID blueprintId)
void	setBlueprintModuleCompleteKey(com.atlassian.plugin.ModuleCompleteKey key)
void	setCreateFromTemplateLabel(String label) Set the label for a Create-from-Template macro button that may be rendered from this context.
void	setSpaceKey(String spaceKey)
void	setTemplateLabel(String label)
void	setTitle(String title) Set the title that the content (page, blog) should have.

Methods inherited from class java.lang.Object

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

Constructor Detail

BlueprintContext

public BlueprintContext()

Method Detail

getMap

public Map<String,Object> getMap()

This method is note for use in plugins: only the AbstractBlueprintContextProvider should call it. Other classes should interact with the map via the facade methods.

Returns:

a map for use with the ContextProvider interface

getBlueprintModuleCompleteKey

public com.atlassian.plugin.ModuleCompleteKey getBlueprintModuleCompleteKey()

getBlueprintId

public UUID getBlueprintId()

getSpaceKey

public String getSpaceKey()

getAnalyticsKey

public String getAnalyticsKey()

getTemplateLabel

public String getTemplateLabel()

getCreateResult

public String getCreateResult()

getCreateFromTemplateLabel

public String getCreateFromTemplateLabel()

get

public Object get(String key)

Use this get method sparingly!

put

public void put(String key,
                Object value)

Use this put method sparingly!

setTitle

public void setTitle(String title)

Set the title that the content (page, blog) should have.

setCreateFromTemplateLabel

public void setCreateFromTemplateLabel(String label)

Set the label for a Create-from-Template macro button that may be rendered from this context.

setTemplateLabel

public void setTemplateLabel(String label)

setAnalyticsKey

public void setAnalyticsKey(String key)

setSpaceKey

public void setSpaceKey(String spaceKey)

setBlueprintModuleCompleteKey

public void setBlueprintModuleCompleteKey(com.atlassian.plugin.ModuleCompleteKey key)

setBlueprintId

public void setBlueprintId(UUID blueprintId)