Package com.atlassian.confluence.macro.browser

Class DefaultMacroBrowserManager

java.lang.Object

com.atlassian.confluence.macro.browser.DefaultMacroBrowserManager

All Implemented Interfaces:

MacroBrowserManager

public class DefaultMacroBrowserManager
extends Object
implements MacroBrowserManager

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

Constructor Summary

Constructors

Constructor	Description
DefaultMacroBrowserManager(MacroMetadataManager metadataManager)

Method Summary

Modifier and Type	Method	Description
Set<MacroCategory>	getMacroCategories()	Returns the available macro categories.
Set<MacroMetadata>	getMacroMetadata()	Returns the metadata for all macros in the system.
Set<MacroMetadata>	getMacroMetadata(Collection<String> whitelist)	Retrieves a set of macros that matches the whitelisted macro names.
Set<MacroSummary>	getMacroSummaries()	Retrieve just the key, title, description and icon of all the macros

Methods inherited from class java.lang.Object

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

Constructor Details

DefaultMacroBrowserManager

public DefaultMacroBrowserManager(MacroMetadataManager metadataManager)

Method Details

getMacroCategories

public Set<MacroCategory> getMacroCategories()

Returns the available macro categories.

Specified by:

getMacroCategories in interface MacroBrowserManager

getMacroMetadata

public Set<MacroMetadata> getMacroMetadata()

Returns the metadata for all macros in the system. 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

getMacroMetadata

public Set<MacroMetadata> getMacroMetadata(Collection<String> whitelist)

Description copied from interface: MacroBrowserManager

Retrieves a set of macros that matches the whitelisted macro names.

Specified by:

getMacroMetadata in interface MacroBrowserManager

Returns:

getMacroSummaries

public Set<MacroSummary> getMacroSummaries()

Description copied from interface: MacroBrowserManager

Retrieve just the key, title, description and icon of all the macros

Specified by:

getMacroSummaries in interface MacroBrowserManager