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

Enum BlueprintContextKeys

java.lang.Object

java.lang.Enum<BlueprintContextKeys>

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

All Implemented Interfaces:

Serializable, Comparable<BlueprintContextKeys>

@ExperimentalApi
public enum BlueprintContextKeys
extends Enum<BlueprintContextKeys>

Context keys for use with Blueprints ContextProvider implementations.

These enum values should be used instead of Strings in the deprecated BlueprintConstants class, but if possible you should have your ContextProvider implementation extend the AbstractBlueprintContextProvider abstract class so that you can work with the BlueprintContext object and not the simple context map.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ANALYTICS_KEY The label that will be used for tracking usage of a given Blueprint.
BLUEPRINT_ID The UUID of the Blueprint used to create content.
BLUEPRINT_MODULE_KEY The complete plugin-module key of the Blueprint used to create the content.
CONTENT_PAGE_TITLE The title that the content (page, blog) should have.
CREATE_FROM_TEMPLATE_LABEL If a Blueprint renders a "Create-from-Template" macro, this is the label for the macro's button.
CREATE_RESULT The action to take after a Blueprint page is started from a template: - 'edit' to create a draft and view it in the Editor - 'view' to create the page and view it
NO_PAGE_TITLE_PREFIX Set to true in the context for a Space Blueprint if pages created in a hierarchy should not be prefixed with the Space home page's title.
SPACE_KEY The key of the space the Blueprint content will be created in.
TEMPLATE_LABEL The label that will be added to the Blueprint Content to identify it.

Method Summary

Modifier and Type	Method and Description
String	key()
static BlueprintContextKeys	valueOf(String name) Returns the enum constant of this type with the specified name.
static BlueprintContextKeys[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

SPACE_KEY

public static final BlueprintContextKeys SPACE_KEY

The key of the space the Blueprint content will be created in.

BLUEPRINT_MODULE_KEY

public static final BlueprintContextKeys BLUEPRINT_MODULE_KEY

The complete plugin-module key of the Blueprint used to create the content.

BLUEPRINT_ID

public static final BlueprintContextKeys BLUEPRINT_ID

The UUID of the Blueprint used to create content.

TEMPLATE_LABEL

public static final BlueprintContextKeys TEMPLATE_LABEL

The label that will be added to the Blueprint Content to identify it.

ANALYTICS_KEY

public static final BlueprintContextKeys ANALYTICS_KEY

The label that will be used for tracking usage of a given Blueprint.

CREATE_RESULT

public static final BlueprintContextKeys CREATE_RESULT

The action to take after a Blueprint page is started from a template: - 'edit' to create a draft and view it in the Editor - 'view' to create the page and view it

CREATE_FROM_TEMPLATE_LABEL

public static final BlueprintContextKeys CREATE_FROM_TEMPLATE_LABEL

If a Blueprint renders a "Create-from-Template" macro, this is the label for the macro's button.

CONTENT_PAGE_TITLE

public static final BlueprintContextKeys CONTENT_PAGE_TITLE

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

Try to use BlueprintContext.setTitle(String) instead.

NO_PAGE_TITLE_PREFIX

public static final BlueprintContextKeys NO_PAGE_TITLE_PREFIX

Set to true in the context for a Space Blueprint if pages created in a hierarchy should not be prefixed with the Space home page's title.

Method Detail

values

public static BlueprintContextKeys[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (BlueprintContextKeys c : BlueprintContextKeys.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static BlueprintContextKeys valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

key

public String key()