Package 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

Modifier and Type	Method	Description
@NonNull Set<MacroMetadata>	getAllMacroMetadata()	Retrieve all available metadata for macros in the system.
@NonNull Set<MacroSummary>	getAllMacroSummaries()	Return summaries of all macros in the system.
@Nullable MacroMetadata	getMacroMetadataByName(String macroName)	Retrieve the metadata for a single macro.
@Nullable MacroMetadata	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.

Method Detail

getAllMacroMetadata

@NonNull Set<MacroMetadata> getAllMacroMetadata()

Retrieve all available metadata for macros in the system.

Since:

4.0

getAllMacroSummaries

@NonNull Set<MacroSummary> getAllMacroSummaries()

Return summaries of all macros in the system.

getMacroMetadataByName

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

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

@NonNull 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

@NonNull 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