Uses of Interface
com.atlassian.confluence.macro.Macro

Packages that use Macro

Package	Description
com.atlassian.confluence.api
com.atlassian.confluence.content.render.xhtml.editor.macro
com.atlassian.confluence.content.render.xhtml.view.macro
com.atlassian.confluence.impl.macro.metadata
com.atlassian.confluence.internal.bigpipe
com.atlassian.confluence.macro
com.atlassian.confluence.macro.browser
com.atlassian.confluence.macro.count
com.atlassian.confluence.macro.wiki
com.atlassian.confluence.macro.xhtml
com.atlassian.confluence.plugin.descriptor
com.atlassian.confluence.plugins.link
com.atlassian.confluence.plugins.macros.core
com.atlassian.confluence.renderer
com.atlassian.confluence.renderer.v2.macros
test.plugin.macro
test.plugin.macro.schema

Uses of Macro in com.atlassian.confluence.api

Classes in com.atlassian.confluence.api that implement Macro

Modifier and Type	Class and Description
class	CustomWebResourceAddingMacro
class	NaughtyWritingToDBWhilstRenderingMacro A macro that writes to the DB whilst rendering, exploding on readOnly transactions

Uses of Macro in com.atlassian.confluence.content.render.xhtml.editor.macro

Methods in com.atlassian.confluence.content.render.xhtml.editor.macro with parameters of type Macro

Modifier and Type	Method and Description
boolean	MacroMarshaller.handles(Macro macro)
boolean	EditorUnknownMacroMarshaller.handles(Macro macro)
boolean	EditorBodyMacroMarshaller.handles(Macro macro)
boolean	EditorBodilessMacroMarshaller.handles(Macro macro)
boolean	CustomPlaceholderEditorMarshaller.handles(Macro macro)
boolean	CustomImageEditorMacroMarshaller.handles(Macro macro)
Streamable	MacroMarshaller.marshal(Macro macro, MacroDefinition macroDefinition, ConversionContext conversionContext) Marshall the supplied macro.
Streamable	EditorBodyMacroMarshaller.marshal(Macro macro, MacroDefinition macroDefinition, ConversionContext conversionContext)
Streamable	EditorBodilessMacroMarshaller.marshal(Macro macro, MacroDefinition macroDefinition, ConversionContext conversionContext)
Streamable	CustomPlaceholderEditorMarshaller.marshal(Macro macro, MacroDefinition macroDefinition, ConversionContext conversionContext)
Streamable	CustomImageEditorMacroMarshaller.marshal(Macro macro, MacroDefinition macroDefinition, ConversionContext conversionContext)

Uses of Macro in com.atlassian.confluence.content.render.xhtml.view.macro

Methods in com.atlassian.confluence.content.render.xhtml.view.macro with parameters of type Macro

Modifier and Type	Method and Description
Streamable	ViewMacroWrapper.executeWrapMacro(ConversionContext context, Macro macro, MarshallerMetricsCollector metricsCollector, MacroDefinition macroDefinition, Map<String,String> macroParameters) Deprecated. since 5.9.0. Please use `wrap` instead
Streamable	DefaultViewMacroWrapper.executeWrapMacro(ConversionContext context, Macro macro, MarshallerMetricsCollector metricsCollector, MacroDefinition macroDefinition, Map<String,String> macroParameters)

Method parameters in com.atlassian.confluence.content.render.xhtml.view.macro with type arguments of type Macro

Modifier and Type	Method and Description
boolean	MacroAsyncRenderWhitelist.isAsyncRenderSafe(MacroDefinition macroDefinition, Class<? extends Macro> macroClass)

Uses of Macro in com.atlassian.confluence.impl.macro.metadata

Classes in com.atlassian.confluence.impl.macro.metadata with type parameters of type Macro

Modifier and Type	Class and Description
class	AllMacroMetadataCache<T extends com.atlassian.plugin.ModuleDescriptor<Macro> & MacroMetadataSource> Caches a map of macro metadata by macro names loaded using the given a macro module descriptor class and a macro module descriptor predicate.
class	AllMacroMetadataLoader<T extends com.atlassian.plugin.ModuleDescriptor<Macro> & MacroMetadataSource> Loads a map of macro metadata by macro names when given a macro module descriptor class and a macro module descriptor predicate.
interface	AllMacroMetadataProvider<T extends com.atlassian.plugin.ModuleDescriptor<Macro> & MacroMetadataSource> Provider that returns a map of macro metadata by macro names when given a macro module descriptor class and a macro module descriptor predicate.

Method parameters in com.atlassian.confluence.impl.macro.metadata with type arguments of type Macro

Modifier and Type	Method and Description
Map<String,MacroMetadata>	AllMacroMetadataLoader.apply(Class<T> descriptorClass, com.atlassian.plugin.predicate.ModuleDescriptorPredicate<Macro> descriptorPredicate)
Map<String,MacroMetadata>	AllMacroMetadataCache.apply(Class<T> descriptorClass, com.atlassian.plugin.predicate.ModuleDescriptorPredicate<Macro> descriptorPredicate)

Uses of Macro in com.atlassian.confluence.internal.bigpipe

Methods in com.atlassian.confluence.internal.bigpipe with parameters of type Macro

Modifier and Type	Method and Description
boolean	BigPipeSettingsManager.isOptedIn(String pluginKey, String moduleName, Macro macro)

Uses of Macro in com.atlassian.confluence.macro

Subinterfaces of Macro in com.atlassian.confluence.macro

Modifier and Type	Interface and Description
interface	BigPipeMacro A specialised Macro type that can provide specific hints to Bigpipe on how to render its placeholders.
interface	StreamableMacro Macro that consumes and produces Streamables instead of Strings.

Classes in com.atlassian.confluence.macro that implement Macro

Modifier and Type	Class and Description
class	GenericVelocityMacro A configurable and generic macro that renders a Velocity template as part of its execution.
class	LazyLoadingMacroWrapper Used to wrap a Macro in a LazyReference.
class	StreamableMacroAdapter Adapter for the StreamableMacro interface that provides a default implementation of the redundant execute method.
class	V2CompatibilityMacro A wrapper macro that retains compatibility with our old V2 macros.

Methods in com.atlassian.confluence.macro that return Macro

Modifier and Type	Method and Description
Macro	LazyLoadingMacroWrapper.getMacro()

Constructor parameters in com.atlassian.confluence.macro with type arguments of type Macro

Constructor and Description
LazyLoadingMacroWrapper(com.atlassian.util.concurrent.LazyReference<Macro> delegate)

Uses of Macro in com.atlassian.confluence.macro.browser

Classes in com.atlassian.confluence.macro.browser with type parameters of type Macro

Modifier and Type	Class and Description
class	DefaultMacroMetadataProvider<T extends com.atlassian.plugin.ModuleDescriptor<Macro> & MacroMetadataSource>

Constructor parameters in com.atlassian.confluence.macro.browser with type arguments of type Macro

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

Uses of Macro in com.atlassian.confluence.macro.count

Methods in com.atlassian.confluence.macro.count with parameters of type Macro

Modifier and Type	Method and Description
void	MacroCounter.addMacroUsage(MacroDefinition macroDefinition, Macro macro) Record a single usage of the given macro.
void	DefaultMacroCounter.addMacroUsage(MacroDefinition macroDefinition, Macro macro)
static MacroMetricsKey	MacroMetricsKey.createFrom(MacroDefinition macroDefinition, Macro macro)

Uses of Macro in com.atlassian.confluence.macro.wiki

Classes in com.atlassian.confluence.macro.wiki that implement Macro

Modifier and Type	Class and Description
class	UnmigratedBlockWikiMarkupMacro This macro will render it's body using the V2 Renderer.
class	UnmigratedInlineWikiMarkupMacro This macro will render it's body using the V2 Renderer.

Uses of Macro in com.atlassian.confluence.macro.xhtml

Methods in com.atlassian.confluence.macro.xhtml that return Macro

Modifier and Type	Method and Description
Macro	XhtmlMacroManager.getMacroByName(String macroName)
Macro	V2CompatibilityMacroManager.getMacroByName(String macroName)
Macro	UserMacroPluginMacroManager.getMacroByName(String macroName)
Macro	UserMacroLibraryMacroManager.getMacroByName(String macroName)
Macro	MacroManager.getMacroByName(String macroName) Gives the Macro registered with the given name, or null if there is none registered with the manager.
Macro	DelegatingReadOnlyMacroManager.getMacroByName(String macroName)
static Macro	XhtmlMacroManager.unwrapMacroProxy(Macro proxy) Unwraps a macro proxy that is wrapped with a ResourceAwareMacroInvocationHandler.

Methods in com.atlassian.confluence.macro.xhtml that return types with arguments of type Macro

Modifier and Type	Method and Description
com.atlassian.util.concurrent.LazyReference<Macro>	XhtmlMacroManager.createLazyMacroReference(com.atlassian.plugin.ModuleDescriptor<?> moduleDescriptor)
com.atlassian.util.concurrent.LazyReference<Macro>	V2CompatibilityMacroManager.createLazyMacroReference(com.atlassian.plugin.ModuleDescriptor<?> moduleDescriptor)
com.atlassian.util.concurrent.LazyReference<Macro>	UserMacroPluginMacroManager.createLazyMacroReference(com.atlassian.plugin.ModuleDescriptor<?> moduleDescriptor)
com.atlassian.util.concurrent.LazyReference<Macro>	UserMacroLibraryMacroManager.createLazyMacroReference(com.atlassian.plugin.ModuleDescriptor<?> moduleDescriptor)
com.atlassian.util.concurrent.LazyReference<Macro>	MacroManager.createLazyMacroReference(com.atlassian.plugin.ModuleDescriptor<?> moduleDescriptor) Macros are lazy loaded to avoid plugin module ordering problems like CONF-13386.
com.atlassian.util.concurrent.LazyReference<Macro>	DelegatingReadOnlyMacroManager.createLazyMacroReference(com.atlassian.plugin.ModuleDescriptor<?> moduleDescriptor)
Map<String,Macro>	XhtmlMacroManager.getMacros()

Methods in com.atlassian.confluence.macro.xhtml with parameters of type Macro

Modifier and Type	Method and Description
void	XhtmlMacroManager.registerMacro(String name, Macro macro)
void	V2CompatibilityMacroManager.registerMacro(String name, Macro macro)
void	UserMacroPluginMacroManager.registerMacro(String name, Macro macro)
void	UserMacroLibraryMacroManager.registerMacro(String name, Macro macro)
void	MacroManager.registerMacro(String name, Macro macro) Registers a new macro with the given name.
void	DelegatingReadOnlyMacroManager.registerMacro(String name, Macro macro)
static Macro	XhtmlMacroManager.unwrapMacroProxy(Macro proxy) Unwraps a macro proxy that is wrapped with a ResourceAwareMacroInvocationHandler.

Uses of Macro in com.atlassian.confluence.plugin.descriptor

Methods in com.atlassian.confluence.plugin.descriptor that return Macro

Modifier and Type	Method and Description
Macro	UserMacroModuleDescriptor.createModule()
Macro	XhtmlMacroModuleDescriptor.getModule()
Macro	UserMacroModuleDescriptor.getModule()

Method parameters in com.atlassian.confluence.plugin.descriptor with type arguments of type Macro

Modifier and Type	Method and Description
boolean	OutputDeviceTypeMacroModuleDescriptorPredicate.matches(com.atlassian.plugin.ModuleDescriptor<? extends Macro> moduleDescriptor)

Uses of Macro in com.atlassian.confluence.plugins.link

Classes in com.atlassian.confluence.plugins.link that implement Macro

Modifier and Type	Class and Description
class	LinkMacro Generates a link to the given content - including external content.

Uses of Macro in com.atlassian.confluence.plugins.macros.core

Classes in com.atlassian.confluence.plugins.macros.core that implement Macro

Modifier and Type	Class and Description
class	LoremIpsumMacro

Uses of Macro in com.atlassian.confluence.renderer

Methods in com.atlassian.confluence.renderer that return Macro

Modifier and Type	Method and Description
Macro	UserMacroConfig.toMacro()

Uses of Macro in com.atlassian.confluence.renderer.v2.macros

Methods in com.atlassian.confluence.renderer.v2.macros that return Macro

Modifier and Type	Method and Description
Macro	V2UserMacroAdapter.getXhtmlMacro()

Constructors in com.atlassian.confluence.renderer.v2.macros with parameters of type Macro

Constructor and Description
V2UserMacroAdapter(Macro xhtmlUserMacro)

Uses of Macro in test.plugin.macro

Classes in test.plugin.macro that implement Macro

Modifier and Type	Class and Description
class	ProcessedBodyMacro
class	UnprocessedBodyMacro

Uses of Macro in test.plugin.macro.schema

Classes in test.plugin.macro.schema that implement Macro

Modifier and Type	Class and Description
class	ParameterJsonMacro A test macro that outputs its parameters as a JSON string.