com.atlassian.confluence.macro.browser.beans

Class MacroMetadata

java.lang.Object

com.atlassian.confluence.macro.browser.beans.MacroMetadata

public class MacroMetadata
extends Object

A Bean that encapsulates the 'metadata' of the macro.

Its purpose is to provide an overview of the macro for the Macro Browser's list of available macros, and to include information about how the macro should be displayed in the list (e.g. "hidden").

More detailed macro metadata including parameter details is encapsulated by the MacroFormDetails class.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MacroMetadata(MacroMetadataBuilder builder)

Method Summary

Modifier and Type	Method and Description
static MacroMetadataBuilder	builder()
MacroSummary	extractMacroSummary()
Set<String>	getAliases() Returns aliases for this macro.
String	getAlternateId() Returns an alternative id for the macro.
List<MacroPropertyPanelButton>	getButtons()
Set<String>	getCategories() Returns categories this macro should be displayed within in the Macro Browser.
Message	getDescription()
MacroFormDetails	getFormDetails()
MacroIcon	getIcon()
String	getMacroName()
String	getPluginKey()
Message	getTitle()
boolean	isBodyDeprecated()
boolean	isHidden()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

MacroMetadata

protected MacroMetadata(MacroMetadataBuilder builder)

Method Detail

builder

public static MacroMetadataBuilder builder()

getMacroName

public String getMacroName()

getPluginKey

public String getPluginKey()

getIcon

public MacroIcon getIcon()

Returns:

the MacroIcon , containing the url string to the macro icon and whether or not the URL is relative. Can return null.

getTitle

public Message getTitle()

getDescription

public Message getDescription()

getAliases

public Set<String> getAliases()

Returns aliases for this macro.

Aliases are other macro names that can be substituted for the "main" macro name. For example "web-widget" can be used instead of "widget" for the "Widget Connector" macro. Only the "main" name is used by the macro-browser, so we use the Strings returned by this method to edit in the macro-browser those macros with an alias in their markup.

Returns:

a set of strings that are aliases of the macro name.

getCategories

public Set<String> getCategories()

Returns categories this macro should be displayed within in the Macro Browser.

Categories allow macros to be browsed instead of searched. The Macro Browser has a list view where all macros for a given category are displayed, and adding the category name to the set returned from this method displays this macro in that category list.

Returns:

a set of strings that are names of MacroCategory enum objects.

isBodyDeprecated

public boolean isBodyDeprecated()

Returns:

true if the body of the macro is deprecated (defined the macro configuration). Use this method to take precedence over the Macro.hasBody() implementation.

isHidden

public boolean isHidden()

Returns:

true if this metadata should not appear in the Macro Browser.

toString

public String toString()

Overrides:

toString in class Object

getAlternateId

public String getAlternateId()

Returns an alternative id for the macro. This is necessary as the macro name may not necessary be unique.

getFormDetails

public MacroFormDetails getFormDetails()

getButtons

public List<MacroPropertyPanelButton> getButtons()

extractMacroSummary

public MacroSummary extractMacroSummary()