com.atlassian.confluence.macro.browser
Class DefaultMacroBrowserManager

java.lang.Object
  extended by com.atlassian.confluence.macro.browser.DefaultMacroBrowserManager
All Implemented Interfaces:
MacroBrowserManager

public class DefaultMacroBrowserManager
extends java.lang.Object
implements MacroBrowserManager

Default MacroBrowserManager implementation. Stores Macro metadata and "extra" details from plugin descriptors, a fallback file, and notification help.


Constructor Summary
DefaultMacroBrowserManager(ModuleDescriptorCache<MacroModuleDescriptor> moduleDescriptorCache)
           
 
Method Summary
 java.util.Set<MacroCategory> getMacroCategories()
          Returns the available macro categories.
 MacroFormDetails getMacroFormDetails(java.lang.String macroName)
          Returns the form details (parameters, documentation URL, etc.) for a macro with the specified name or alias.
 java.util.Set<MacroMetadata> getMacroMetadata()
          Returns the metadata for all macros in the system, excluding user macros.
 void setPluginEventManager(com.atlassian.plugin.event.PluginEventManager pluginEventManager)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DefaultMacroBrowserManager

public DefaultMacroBrowserManager(ModuleDescriptorCache<MacroModuleDescriptor> moduleDescriptorCache)
Method Detail

getMacroCategories

public java.util.Set<MacroCategory> getMacroCategories()
Returns the available macro categories.

Specified by:
getMacroCategories in interface MacroBrowserManager

getMacroMetadata

public java.util.Set<MacroMetadata> getMacroMetadata()
Returns the metadata for all macros in the system, excluding user macros. Macro metadata might be retrieved from the fallback XML file in Confluence if there's none in the macro itself.

Specified by:
getMacroMetadata in interface MacroBrowserManager

getMacroFormDetails

public MacroFormDetails getMacroFormDetails(java.lang.String macroName)
Returns the form details (parameters, documentation URL, etc.) for a macro with the specified name or alias.

Specified by:
getMacroFormDetails in interface MacroBrowserManager
Parameters:
macroName - the macro name to retrieve form details for
Returns:
The MacroFormDetails for the given macro. Null is returned if the macro is unknown.

setPluginEventManager

public void setPluginEventManager(com.atlassian.plugin.event.PluginEventManager pluginEventManager)


Copyright © 2003-2009 Atlassian Pty Ltd. All Rights Reserved.