com.atlassian.confluence.plugins.createcontent.extensions

Class BlueprintModuleDescriptor

java.lang.Object

com.atlassian.plugin.descriptors.AbstractModuleDescriptor<Void>

com.atlassian.confluence.plugins.createcontent.extensions.BlueprintModuleDescriptor

All Implemented Interfaces:

BlueprintDescriptor, com.atlassian.plugin.ModuleDescriptor<Void>, com.atlassian.plugin.Resourced, com.atlassian.plugin.ScopeAware, com.atlassian.plugin.StateAware

public class BlueprintModuleDescriptor
extends com.atlassian.plugin.descriptors.AbstractModuleDescriptor<Void>
implements BlueprintDescriptor

Represents a blueprint that creates Confluence content in a pluggable fashion.

Since:

5.0

Field Summary

Fields inherited from class com.atlassian.plugin.descriptors.AbstractModuleDescriptor

key, moduleClass, moduleClassName, moduleFactory, name, plugin, resources, singleton

Constructor Summary

Constructors

Constructor and Description
BlueprintModuleDescriptor(com.atlassian.plugin.module.ModuleFactory moduleFactory, com.atlassian.confluence.util.i18n.DocumentationBeanFactory documentationBeanFactory)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
com.atlassian.plugin.ModuleCompleteKey	getBlueprintKey()
com.atlassian.plugin.ModuleCompleteKey	getContentTemplateKey() Deprecated.
com.atlassian.plugin.ModuleCompleteKey	getContentTemplateKey(String contentTemplateModuleKey) Return a ModuleCompleteKey with this Blueprint plugin's key and the moduleKey specified.
List<com.atlassian.plugin.ModuleCompleteKey>	getContentTemplates() Return the keys of the PageTemplates associated with this Blueprint.
String	getCreateResult()
com.atlassian.confluence.plugins.dialog.wizard.api.DialogWizard	getDialogWizard()
com.atlassian.plugin.ModuleCompleteKey	getFirstContentTemplateKey() Replaces the deprecated BlueprintDescriptor.getContentTemplateKey() method, returning the first defined content-template-key for this Blueprint.
String	getHowToUseTemplate()
String	getIndexKey()
com.atlassian.plugin.ModuleCompleteKey	getIndexTemplate()
String	getIndexTitleI18nKey()
Void	getModule()
int	hashCode()
void	init(com.atlassian.plugin.Plugin plugin, org.dom4j.Element element)
boolean	isIndexDisabled()

Methods inherited from class com.atlassian.plugin.descriptors.AbstractModuleDescriptor

assertModuleClassImplements, checkPermissions, destroy, destroy, disabled, enabled, getCompleteKey, getDescription, getDescriptionKey, getI18nNameKey, getKey, getMinJavaVersion, getModuleClass, getModuleClassName, getName, getParams, getPlugin, getPluginKey, getRequiredPermissions, getResourceDescriptor, getResourceDescriptors, getResourceDescriptors, getResourceLocation, getScopeKey, isBroken, isEnabled, isEnabledByDefault, isSingleton, isSingletonByDefault, isSystemModule, loadClass, loadClass, provideValidationRules, satisfiesMinJavaVersion, setBroken, setPlugin, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

BlueprintModuleDescriptor

public BlueprintModuleDescriptor(com.atlassian.plugin.module.ModuleFactory moduleFactory,
                                 com.atlassian.confluence.util.i18n.DocumentationBeanFactory documentationBeanFactory)

Method Detail

init

public void init(com.atlassian.plugin.Plugin plugin,
                 org.dom4j.Element element)
          throws com.atlassian.plugin.PluginParseException

Specified by:

init in interface com.atlassian.plugin.ModuleDescriptor<Void>

Overrides:

init in class com.atlassian.plugin.descriptors.AbstractModuleDescriptor<Void>

Throws:

com.atlassian.plugin.PluginParseException

getContentTemplateKey

@Deprecated
public com.atlassian.plugin.ModuleCompleteKey getContentTemplateKey()

Deprecated.

Specified by:

getContentTemplateKey in interface BlueprintDescriptor

getFirstContentTemplateKey

public com.atlassian.plugin.ModuleCompleteKey getFirstContentTemplateKey()

Description copied from interface: BlueprintDescriptor

Replaces the deprecated BlueprintDescriptor.getContentTemplateKey() method, returning the first defined content-template-key for this Blueprint.

Specified by:

getFirstContentTemplateKey in interface BlueprintDescriptor

getContentTemplateKey

public com.atlassian.plugin.ModuleCompleteKey getContentTemplateKey(String contentTemplateModuleKey)

Description copied from interface: BlueprintDescriptor

Return a ModuleCompleteKey with this Blueprint plugin's key and the moduleKey specified.

Specified by:

getContentTemplateKey in interface BlueprintDescriptor

getContentTemplates

public List<com.atlassian.plugin.ModuleCompleteKey> getContentTemplates()

Description copied from interface: BlueprintDescriptor

Return the keys of the PageTemplates associated with this Blueprint.

Specified by:

getContentTemplates in interface BlueprintDescriptor

getIndexTemplate

public com.atlassian.plugin.ModuleCompleteKey getIndexTemplate()

Specified by:

getIndexTemplate in interface BlueprintDescriptor

getBlueprintKey

public com.atlassian.plugin.ModuleCompleteKey getBlueprintKey()

Specified by:

getBlueprintKey in interface BlueprintDescriptor

getIndexKey

public String getIndexKey()

Specified by:

getIndexKey in interface BlueprintDescriptor

getCreateResult

public String getCreateResult()

Specified by:

getCreateResult in interface BlueprintDescriptor

getIndexTitleI18nKey

public String getIndexTitleI18nKey()

Specified by:

getIndexTitleI18nKey in interface BlueprintDescriptor

getModule

public Void getModule()

Specified by:

getModule in interface com.atlassian.plugin.ModuleDescriptor<Void>

Specified by:

getModule in class com.atlassian.plugin.descriptors.AbstractModuleDescriptor<Void>

getHowToUseTemplate

public String getHowToUseTemplate()

Specified by:

getHowToUseTemplate in interface BlueprintDescriptor

getDialogWizard

public com.atlassian.confluence.plugins.dialog.wizard.api.DialogWizard getDialogWizard()

Specified by:

getDialogWizard in interface BlueprintDescriptor

isIndexDisabled

public boolean isIndexDisabled()

Specified by:

isIndexDisabled in interface BlueprintDescriptor

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.atlassian.plugin.ModuleDescriptor<Void>

Overrides:

equals in class com.atlassian.plugin.descriptors.AbstractModuleDescriptor<Void>

hashCode

public int hashCode()

Specified by:

hashCode in interface com.atlassian.plugin.ModuleDescriptor<Void>

Overrides:

hashCode in class com.atlassian.plugin.descriptors.AbstractModuleDescriptor<Void>