Package 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: 7d0e602d75f5a3155e2fb5480eef272a63d1ae26 $

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	WikiMacroDescriptor.Builder	Use this to build instance of WikiMacroDescriptor.

Method Summary

Modifier and Type	Method	Description
org.xwiki.rendering.macro.descriptor.ContentDescriptor	getContentDescriptor()
Set<String>	getDefaultCategories()
String	getDescription()
org.xwiki.rendering.macro.MacroId	getId()
String	getName()
Map<String,org.xwiki.rendering.macro.descriptor.ParameterDescriptor>	getParameterDescriptorMap()
Class<?>	getParametersBeanClass()
WikiMacroVisibility	getVisibility()
boolean	supportsInlineMode()

Methods inherited from class java.lang.Object

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

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

getDefaultCategories

public Set<String> getDefaultCategories()

Specified by:

getDefaultCategories 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

supportsInlineMode

public boolean supportsInlineMode()

Specified by:

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