com.atlassian.confluence.macro.browser

Class DefaultMacroMetadataProvider<T extends com.atlassian.plugin.ModuleDescriptor<Macro> & MacroMetadataSource>

java.lang.Object

com.atlassian.confluence.macro.browser.DefaultMacroMetadataProvider<T>

All Implemented Interfaces:

MacroMetadataProvider

public class DefaultMacroMetadataProvider<T extends com.atlassian.plugin.ModuleDescriptor<Macro> & MacroMetadataSource>
extends Object
implements MacroMetadataProvider

Constructor Summary

Constructors

Constructor and Description
DefaultMacroMetadataProvider(AllMacroMetadataProvider<T> macroMetadataCache, Class<T> descriptorClass)
DefaultMacroMetadataProvider(AllMacroMetadataProvider<T> allMacroMetadataProvider, Class<T> descriptorClass, com.atlassian.plugin.predicate.ModuleDescriptorPredicate<Macro> descriptorPredicate)

Method Summary

Modifier and Type	Method and Description
MacroMetadata	getByMacroName(String macroName) Returns the metadata for the named macro if it is known to this provider.
@Nullable 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 of MacroMetadata for use in the Macro Browser.
Collection<MacroSummary>	getSummaries() Returns a collection of MacroMetadata for use in the Macro Browser.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultMacroMetadataProvider

public DefaultMacroMetadataProvider(AllMacroMetadataProvider<T> macroMetadataCache,
                                    Class<T> descriptorClass)

DefaultMacroMetadataProvider

public DefaultMacroMetadataProvider(AllMacroMetadataProvider<T> allMacroMetadataProvider,
                                    Class<T> descriptorClass,
                                    com.atlassian.plugin.predicate.ModuleDescriptorPredicate<Macro> descriptorPredicate)

Method Detail

getData

public Collection<MacroMetadata> getData()

Description copied from interface: MacroMetadataProvider

Returns a collection of MacroMetadata for use in the Macro Browser. This collection need not necessarily be unique.

Specified by:

getData in interface MacroMetadataProvider

getSummaries

public Collection<MacroSummary> getSummaries()

Description copied from interface: MacroMetadataProvider

Returns a collection of MacroMetadata for use in the Macro Browser. This collection need not necessarily be unique. It's just the summaries.

Specified by:

getSummaries in interface MacroMetadataProvider

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 interface MacroMetadataProvider

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

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.