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.
 MacroMetadata getMacroMetadataByName(String macroName)
          Retrieve the metadata for a single macro.
 

Method Detail

getAllMacroMetadata

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

Since:
4.0

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


Copyright © 2003-2011 Atlassian. All Rights Reserved.