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

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

Method Detail

getAllMacroMetadata

java.util.Set<MacroMetadata> getAllMacroMetadata()

Retrieve all available metadata for macros in the system.

Since:

4.0

getAllMacroSummaries

java.util.Set<MacroSummary> getAllMacroSummaries()

Return summaries of all macros in the system.

getMacroMetadataByName

MacroMetadata getMacroMetadataByName(java.lang.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(java.lang.String macroName,
                                          java.lang.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

java.util.Map<java.lang.String,MacroParameterType> getParameterTypes(java.lang.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

java.util.Map<java.lang.String,MacroParameter> getParameters(java.lang.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