com.atlassian.confluence.macro.browser
Class DefaultMacroMetadataProvider

java.lang.Object
  com.atlassian.confluence.macro.browser.DefaultMacroMetadataProvider

All Implemented Interfaces:

MacroMetadataProvider

public class DefaultMacroMetadataProvider
extends Object
implements MacroMetadataProvider

Constructor Summary

DefaultMacroMetadataProvider(ModuleDescriptorCache<? extends com.atlassian.plugin.ModuleDescriptor> macroModuleDescriptorCache, MacroFallbackParser macroFallbackParser)

Method Summary

MacroMetadata	getByMacroName(String macroName) Returns the metadata for the named macro if it is known to this provider.
Collection<MacroMetadata>	getData() Returns a collection of MacroMetadata for use in the Macro Browser.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultMacroMetadataProvider

public DefaultMacroMetadataProvider(ModuleDescriptorCache<? extends com.atlassian.plugin.ModuleDescriptor> macroModuleDescriptorCache,
                                    MacroFallbackParser macroFallbackParser)

Method Detail

getData

public Collection<MacroMetadata> getData()

Description copied from interface: MacroMetadataProvider

Returns a collection of MacroMetadata for use in the Macro Browser. This collection need not necessarily be unique.

Specified by:

getData in interface MacroMetadataProvider

getByMacroName

public MacroMetadata getByMacroName(String macroName)

Description copied from interface: MacroMetadataProvider

Returns the metadata for the named macro if it is known to this provider. Otherwise returns null.

Specified by:

getByMacroName in interface MacroMetadataProvider

Parameters:

macroName - the (simple, unfriendly) name of the macro.

Returns:

the macro's metadata or null if it is not known to this provider.