com.atlassian.renderer.v2.components

Interface PluggableRendererComponentFactory

public interface PluggableRendererComponentFactory

A factory used to instantiate RendererComponents via the plugin system.

Since:

v3.12

Method Summary

Modifier and Type	Method and Description
RendererComponent	getRendererComponent() Constructs a RendererComponent.
void	init(com.atlassian.plugin.ModuleDescriptor moduleDescriptor) Initialises the RendererComponentFactory, with parameters provided by a plugin module descriptor.

Method Detail

init

void init(com.atlassian.plugin.ModuleDescriptor moduleDescriptor)
   throws com.atlassian.plugin.PluginParseException

Initialises the RendererComponentFactory, with parameters provided by a plugin module descriptor.

Parameters:

moduleDescriptor - plugin module descriptor to initialize the factory

Throws:

com.atlassian.plugin.PluginParseException - if there's an error initializing the factory

getRendererComponent

RendererComponent getRendererComponent()

Constructs a RendererComponent.

Returns:

a new RendererComponent or null if there was a problem initialising the component