Summary: Methods | [Expand All]
public interface

MacroMetadataProvider

com.atlassian.confluence.macro.browser.MacroMetadataProvider
Known Indirect Subclasses

Class Overview

Implementations of this class will be used by the MacroBrowserManager to provide additional MacroMetadata.

Summary

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

Public Methods

public abstract 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 abstract Collection<MacroMetadata> getData ()

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