com.atlassian.confluence.macro.browser

Interface MacroMetadataProvider

All Known Implementing Classes:

DefaultMacroMetadataProvider, DelegatingMacroMetadataProvider, UserMacroMetadataProvider

public interface MacroMetadataProvider

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

Method Summary

Modifier and Type	Method and Description
@Nullable MacroMetadata	getByMacroName(String macroName) Returns the metadata for the named macro if it is known to this provider.
@Nullable MacroMetadata	getByMacroNameAndId(String macroName, String alternateId) 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.
Collection<MacroSummary>	getSummaries() Returns a collection of MacroMetadata for use in the Macro Browser.

Method Detail

getData

Collection<MacroMetadata> getData()

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

getSummaries

Collection<MacroSummary> getSummaries()

Returns a collection of MacroMetadata for use in the Macro Browser. This collection need not necessarily be unique. It's just the summaries.

getByMacroName

@Nullable 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.

Since:

4.0

getByMacroNameAndId

@Nullable MacroMetadata getByMacroNameAndId(String macroName,
                                            String alternateId)

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.

alternateId - additional identification for macros where the macroName is not sufficient. If alternateId is null, then it should be ignored.

Returns:

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

Since:

5.5