com.atlassian.confluence.plugin.descriptor
Class UserMacroModuleDescriptor

java.lang.Object
  com.atlassian.plugin.descriptors.AbstractModuleDescriptor<Macro>
      com.atlassian.confluence.plugin.descriptor.UserMacroModuleDescriptor

All Implemented Interfaces:

MacroMetadataSource, PluginModuleFactory<Macro>, ModuleDescriptor<Macro>, Resourced, StateAware

public final class UserMacroModuleDescriptor
extends AbstractModuleDescriptor<Macro>
implements PluginModuleFactory<Macro>, MacroMetadataSource

Allows simple macros to be defined inline

Field Summary

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

moduleClass, moduleClassName, moduleFactory, plugin, resources, singleton

Constructor Summary

UserMacroModuleDescriptor()

Method Summary

Macro	createModule()
void	disabled()
void	enabled()
MacroMetadata	getMacroMetadata()
Macro	getModule()
UserMacroConfig	getUserMacroConfig()
void	init(Plugin plugin, Element element)
void	setMacroMetadataParser(MacroMetadataParser macroMetadataParser)

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

assertModuleClassImplements, destroy, equals, getCompleteKey, getDescription, getDescriptionKey, getI18nNameKey, getKey, getMinJavaVersion, getModuleClass, getName, getParams, getPlugin, getPluginKey, getResourceDescriptor, getResourceDescriptors, getResourceDescriptors, getResourceLocation, hashCode, isEnabledByDefault, isSingleton, isSingletonByDefault, isSystemModule, loadClass, loadClass, provideValidationRules, satisfiesMinJavaVersion, setPlugin, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

UserMacroModuleDescriptor

public UserMacroModuleDescriptor()

Method Detail

init

public void init(Plugin plugin,
                 Element element)
          throws PluginParseException

Specified by:

init in interface ModuleDescriptor<Macro>

Overrides:

init in class AbstractModuleDescriptor<Macro>

Throws:

PluginParseException

getUserMacroConfig

public UserMacroConfig getUserMacroConfig()

getMacroMetadata

public MacroMetadata getMacroMetadata()

Specified by:

getMacroMetadata in interface MacroMetadataSource

createModule

public Macro createModule()

Specified by:

createModule in interface PluginModuleFactory<Macro>

getModule

public Macro getModule()

Specified by:

getModule in interface ModuleDescriptor<Macro>

Specified by:

getModule in class AbstractModuleDescriptor<Macro>

enabled

public void enabled()

Specified by:

enabled in interface StateAware

Overrides:

enabled in class AbstractModuleDescriptor<Macro>

disabled

public void disabled()

Specified by:

disabled in interface StateAware

Overrides:

disabled in class AbstractModuleDescriptor<Macro>

setMacroMetadataParser

public void setMacroMetadataParser(MacroMetadataParser macroMetadataParser)