com.atlassian.confluence.macro.browser
Interface MacroMetadataManager

All Known Implementing Classes:
DefaultMacroMetadataManager

public interface MacroMetadataManager

Provides metadata about macros such as what parameters they expect and how to represent them visually.

Since:
4.0

Method Summary
 Set<MacroMetadata> getAllMacroMetadata()
          Retrieve all available metadata for macros in the system.
 Set<MacroSummary> getAllMacroSummaries()
          Return summaries of all macros in the system.
 MacroMetadata getMacroMetadataByName(String macroName)
          Retrieve the metadata for a single macro.
 MacroMetadata getMacroMetadataByNameAndId(String macroName, String alternateId)
          Retrieve the metadata for a single macro.
 Map<String,MacroParameter> getParameters(String macroName)
          Retrieve the parameter information for a single macro.
 Map<String,MacroParameterType> getParameterTypes(String macroName)
          Retrieve the parameter type information for a single macro.
 

Method Detail

getAllMacroMetadata

Set<MacroMetadata> getAllMacroMetadata()
Retrieve all available metadata for macros in the system.

Since:
4.0

getAllMacroSummaries

Set<MacroSummary> getAllMacroSummaries()
Return summaries of all macros in the system.


getMacroMetadataByName

MacroMetadata getMacroMetadataByName(String macroName)
Retrieve the metadata for a single macro. This may not be very efficient internally.

Parameters:
macroName - the (simple, unfriendly) name of the macro, as will be returned by MacroMetadata.getMacroName() or MacroDefinition.getName().
Since:
4.0

getMacroMetadataByNameAndId

MacroMetadata getMacroMetadataByNameAndId(String macroName,
                                          String alternateId)
Retrieve the metadata for a single macro. This may not be very efficient internally.

Parameters:
macroName - the (simple, unfriendly) name of the macro, as will be returned by MacroMetadata.getMacroName() or MacroDefinition.getName().
alternateId - additional identification for macros where the macroName is not sufficient. This will be ignored, if null.
Since:
5.5

getParameterTypes

Map<String,MacroParameterType> getParameterTypes(String macroName)
Retrieve the parameter type information for a single macro.

Parameters:
macroName - the name of the macro, as will be returned by MacroMetadata.getMacroName() or MacroDefinition.getName().
Returns:
A map consisting of the parameter name and its corresponding type.
Since:
5.2

getParameters

Map<String,MacroParameter> getParameters(String macroName)
Retrieve the parameter information for a single macro.

Parameters:
macroName - the name of the macro, as will be returned by MacroMetadata.getMacroName() or MacroDefinition.getName().
Returns:
A map consisting of the parameter name and its corresponding metadata.
Since:
5.2


Copyright © 2003–2015 Atlassian. All rights reserved.