Class DefaultMacroMetadataManager
java.lang.Object
com.atlassian.confluence.macro.browser.DefaultMacroMetadataManager
- All Implemented Interfaces:
MacroMetadataManager
Manager providing
MacroMetadata
about the Macro
s in Confluence.-
Constructor Summary
ConstructorDescriptionDefaultMacroMetadataManager
(com.atlassian.plugin.PluginAccessor pluginAccessor, com.atlassian.event.api.EventListenerRegistrar eventListenerRegistrar) -
Method Summary
Modifier and TypeMethodDescriptionvoid
destroy()
@NonNull Set<MacroMetadata>
Retrieve all available metadata for macros in the system.@NonNull Set<MacroSummary>
Return summaries of all macros in the system.getMacroMetadataByName
(String macroName) Retrieve the metadata for a single macro.getMacroMetadataByNameAndId
(String macroName, String alternateId) Retrieve the metadata for a single macro.@NonNull Map<String,
MacroParameter> getParameters
(String macroName) Retrieve the parameter information for a single macro.@NonNull Map<String,
MacroParameterType> getParameterTypes
(String macroName) Retrieve the parameter type information for a single macro.void
init()
void
-
Constructor Details
-
DefaultMacroMetadataManager
public DefaultMacroMetadataManager(com.atlassian.plugin.PluginAccessor pluginAccessor, com.atlassian.event.api.EventListenerRegistrar eventListenerRegistrar) - Since:
- 5.9
-
-
Method Details
-
init
@PostConstruct public void init() -
destroy
@PreDestroy public void destroy() -
onPluginFrameworkStartedEvent
-
getAllMacroMetadata
Description copied from interface:MacroMetadataManager
Retrieve all available metadata for macros in the system.- Specified by:
getAllMacroMetadata
in interfaceMacroMetadataManager
-
getAllMacroSummaries
Description copied from interface:MacroMetadataManager
Return summaries of all macros in the system.- Specified by:
getAllMacroSummaries
in interfaceMacroMetadataManager
-
getMacroMetadataByName
Description copied from interface:MacroMetadataManager
Retrieve the metadata for a single macro. This may not be very efficient internally.- Specified by:
getMacroMetadataByName
in interfaceMacroMetadataManager
- Parameters:
macroName
- the (simple, unfriendly) name of the macro, as will be returned byMacroMetadata.getMacroName()
orMacroDefinition.getName()
.
-
getMacroMetadataByNameAndId
Description copied from interface:MacroMetadataManager
Retrieve the metadata for a single macro. This may not be very efficient internally.- Specified by:
getMacroMetadataByNameAndId
in interfaceMacroMetadataManager
- Parameters:
macroName
- the (simple, unfriendly) name of the macro, as will be returned byMacroMetadata.getMacroName()
orMacroDefinition.getName()
.alternateId
- additional identification for macros where the macroName is not sufficient. This will be ignored, if null.
-
getParameterTypes
Description copied from interface:MacroMetadataManager
Retrieve the parameter type information for a single macro.- Specified by:
getParameterTypes
in interfaceMacroMetadataManager
- Parameters:
macroName
- the name of the macro, as will be returned byMacroMetadata.getMacroName()
orMacroDefinition.getName()
.- Returns:
- A map consisting of the parameter name and its corresponding type.
-
getParameters
Description copied from interface:MacroMetadataManager
Retrieve the parameter information for a single macro.- Specified by:
getParameters
in interfaceMacroMetadataManager
- Parameters:
macroName
- the name of the macro, as will be returned byMacroMetadata.getMacroName()
orMacroDefinition.getName()
.- Returns:
- A map consisting of the parameter name and its corresponding metadata.
-