public class

DefaultMacroMetadataProvider

extends Object
implements MacroMetadataProvider
java.lang.Object
   ↳ com.atlassian.confluence.macro.browser.DefaultMacroMetadataProvider

Summary

Public Constructors
DefaultMacroMetadataProvider(ModuleDescriptorCache<? extends ModuleDescriptor> macroModuleDescriptorCache, MacroFallbackParser macroFallbackParser)
Public Methods
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.
[Expand]
Inherited Methods
From class java.lang.Object
From interface com.atlassian.confluence.macro.browser.MacroMetadataProvider

Public Constructors

public DefaultMacroMetadataProvider (ModuleDescriptorCache<? extends ModuleDescriptor> macroModuleDescriptorCache, MacroFallbackParser macroFallbackParser)

Public Methods

public MacroMetadata getByMacroName (String macroName)

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

Parameters
macroName the (simple, unfriendly) name of the macro.
Returns
  • the macro's metadata or null if it is not known to this provider.

public Collection<MacroMetadata> getData ()

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