org.xwiki.rendering.macro.wikibridge
Class WikiMacroDescriptor

java.lang.Object
  org.xwiki.rendering.macro.wikibridge.WikiMacroDescriptor

All Implemented Interfaces:

org.xwiki.rendering.macro.descriptor.MacroDescriptor

public class WikiMacroDescriptor
extends Object
implements org.xwiki.rendering.macro.descriptor.MacroDescriptor

A MacroDescriptor for describing wiki macros.

Since:

2.0M2

Version:

$Id: ca526835d010429372ebadc959a7297c754a824c $

Constructor Summary

WikiMacroDescriptor(org.xwiki.rendering.macro.MacroId id, String name, String description, String defaultCategory, WikiMacroVisibility visibility, org.xwiki.rendering.macro.descriptor.ContentDescriptor contentDescriptor, List<WikiMacroParameterDescriptor> parameterDescriptors)
Creates a new WikiMacroDescriptor instance.

WikiMacroDescriptor(String name, String description, String defaultCategory, WikiMacroVisibility visibility, org.xwiki.rendering.macro.descriptor.ContentDescriptor contentDescriptor, List<WikiMacroParameterDescriptor> parameterDescriptors)
Deprecated. since 2.3M1 use WikiMacroDescriptor(MacroId, String, String, String, WikiMacroVisibility, ContentDescriptor, List) instead

Method Summary

org.xwiki.rendering.macro.descriptor.ContentDescriptor	getContentDescriptor()
String	getDefaultCategory()
String	getDescription()
org.xwiki.rendering.macro.MacroId	getId()
String	getName()
Map<String,org.xwiki.rendering.macro.descriptor.ParameterDescriptor>	getParameterDescriptorMap()
Class<?>	getParametersBeanClass()
WikiMacroVisibility	getVisibility()

Methods inherited from class java.lang.Object

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

Constructor Detail

WikiMacroDescriptor

public WikiMacroDescriptor(org.xwiki.rendering.macro.MacroId id,
                           String name,
                           String description,
                           String defaultCategory,
                           WikiMacroVisibility visibility,
                           org.xwiki.rendering.macro.descriptor.ContentDescriptor contentDescriptor,
                           List<WikiMacroParameterDescriptor> parameterDescriptors)

Creates a new WikiMacroDescriptor instance.

Parameters:

id - the macro id

name - the macro name

description - macro description

defaultCategory - default category under which this macro should be listed.

visibility - the macro visibility (only visible in the current wiki, for the current user or global)

contentDescriptor - macro content description.

parameterDescriptors - parameter descriptors.

Since:

2.3M1

WikiMacroDescriptor

@Deprecated
public WikiMacroDescriptor(String name,
                                      String description,
                                      String defaultCategory,
                                      WikiMacroVisibility visibility,
                                      org.xwiki.rendering.macro.descriptor.ContentDescriptor contentDescriptor,
                                      List<WikiMacroParameterDescriptor> parameterDescriptors)

Deprecated. since 2.3M1 use WikiMacroDescriptor(MacroId, String, String, String, WikiMacroVisibility, ContentDescriptor, List) instead

Creates a new WikiMacroDescriptor instance.

Parameters:

name - the macro name

description - macro description

defaultCategory - default category under which this macro should be listed.

visibility - the macro visibility (only visible in the current wiki, for the current user or global)

contentDescriptor - macro content description.

parameterDescriptors - parameter descriptors.

Since:

2.2M1

Method Detail

getId

public org.xwiki.rendering.macro.MacroId getId()

Specified by:

getId in interface org.xwiki.rendering.macro.descriptor.MacroDescriptor

getName

public String getName()

Specified by:

getName in interface org.xwiki.rendering.macro.descriptor.MacroDescriptor

getDescription

public String getDescription()

Specified by:

getDescription in interface org.xwiki.rendering.macro.descriptor.MacroDescriptor

getContentDescriptor

public org.xwiki.rendering.macro.descriptor.ContentDescriptor getContentDescriptor()

Specified by:

getContentDescriptor in interface org.xwiki.rendering.macro.descriptor.MacroDescriptor

getParametersBeanClass

public Class<?> getParametersBeanClass()

Specified by:

getParametersBeanClass in interface org.xwiki.rendering.macro.descriptor.MacroDescriptor

getParameterDescriptorMap

public Map<String,org.xwiki.rendering.macro.descriptor.ParameterDescriptor> getParameterDescriptorMap()

Specified by:

getParameterDescriptorMap in interface org.xwiki.rendering.macro.descriptor.MacroDescriptor

getDefaultCategory

public String getDefaultCategory()

Specified by:

getDefaultCategory in interface org.xwiki.rendering.macro.descriptor.MacroDescriptor

getVisibility

public WikiMacroVisibility getVisibility()

Returns:

the visibility of the macro (ie whether the macro is visible in the current wiki, for the current user or global)

Since:

2.2M1