Class UserMacroMetadataProvider
- java.lang.Object
-
- com.atlassian.confluence.macro.browser.UserMacroMetadataProvider
-
- All Implemented Interfaces:
MacroMetadataProvider
public class UserMacroMetadataProvider extends Object implements MacroMetadataProvider
Serves metadata for user macros managed by theUserMacroLibrary
.Note: this is distinct from user macros managed by the plugin subsystem that are declared using <user-macro> in plugin descriptors.
-
-
Field Summary
Fields Modifier and Type Field Description static String
USER_MACRO_DUMMY_PLUGIN_KEY
-
Constructor Summary
Constructors Constructor Description UserMacroMetadataProvider()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description MacroMetadata
getByMacroName(String macroName)
Returns the metadata for the named macro if it is known to this provider.MacroMetadata
getByMacroNameAndId(String macroName, String alternateId)
Returns the metadata for the named macro if it is known to this provider.Collection<MacroMetadata>
getData()
Returns a collection ofMacroMetadata
for use in the Macro Browser.Collection<MacroSummary>
getSummaries()
Returns a collection ofMacroMetadata
for use in the Macro Browser.void
setUserMacroLibrary(UserMacroLibrary userMacroLibrary)
-
-
-
Field Detail
-
USER_MACRO_DUMMY_PLUGIN_KEY
public static final String USER_MACRO_DUMMY_PLUGIN_KEY
- See Also:
- Constant Field Values
-
-
Method Detail
-
getData
public Collection<MacroMetadata> getData()
Description copied from interface:MacroMetadataProvider
Returns a collection ofMacroMetadata
for use in the Macro Browser. This collection need not necessarily be unique.- Specified by:
getData
in interfaceMacroMetadataProvider
-
getSummaries
public Collection<MacroSummary> getSummaries()
Description copied from interface:MacroMetadataProvider
Returns a collection ofMacroMetadata
for use in the Macro Browser. This collection need not necessarily be unique. It's just the summaries.- Specified by:
getSummaries
in interfaceMacroMetadataProvider
-
getByMacroName
public MacroMetadata getByMacroName(String macroName)
Description copied from interface:MacroMetadataProvider
Returns the metadata for the named macro if it is known to this provider. Otherwise returns null.- Specified by:
getByMacroName
in interfaceMacroMetadataProvider
- Parameters:
macroName
- the (simple, unfriendly) name of the macro.- Returns:
- the macro's metadata or null if it is not known to this provider.
-
getByMacroNameAndId
public MacroMetadata getByMacroNameAndId(String macroName, String alternateId)
Description copied from interface:MacroMetadataProvider
Returns the metadata for the named macro if it is known to this provider. Otherwise returns null.- Specified by:
getByMacroNameAndId
in interfaceMacroMetadataProvider
- Parameters:
macroName
- the (simple, unfriendly) name of the macro.alternateId
- additional identification for macros where the macroName is not sufficient. If alternateId is null, then it should be ignored.- Returns:
- the macro's metadata or null if it is not known to this provider.
-
setUserMacroLibrary
public void setUserMacroLibrary(UserMacroLibrary userMacroLibrary)
-
-