Package org.xwiki.rendering.macro.wikibridge

Class WikiMacroDescriptor.Builder

java.lang.Object

org.xwiki.rendering.macro.wikibridge.WikiMacroDescriptor.Builder

Enclosing class:

WikiMacroDescriptor

public static class WikiMacroDescriptor.Builder
extends Object

Use this to build instance of WikiMacroDescriptor.

Since:

10.10RC1

Version:

$Id: 7d0e602d75f5a3155e2fb5480eef272a63d1ae26 $

Constructor Summary

Constructors

Constructor	Description
Builder()	Default constructor.

Method Summary

Modifier and Type	Method	Description
WikiMacroDescriptor	build()
WikiMacroDescriptor.Builder	contentDescriptor(org.xwiki.rendering.macro.descriptor.ContentDescriptor contentDescriptor)
WikiMacroDescriptor.Builder	defaultCategories(Collection<String> defaultCategories)
WikiMacroDescriptor.Builder	description(String description)
WikiMacroDescriptor.Builder	id(org.xwiki.rendering.macro.MacroId id)
WikiMacroDescriptor.Builder	name(String name)
WikiMacroDescriptor.Builder	parameterDescriptors(List<WikiMacroParameterDescriptor> parameterDescriptors)
WikiMacroDescriptor.Builder	supportsInlineMode(boolean supportsInlineMode)
WikiMacroDescriptor.Builder	visibility(WikiMacroVisibility visibility)

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Default constructor.

Method Detail

id

public WikiMacroDescriptor.Builder id(org.xwiki.rendering.macro.MacroId id)

Parameters:

id - the macro id

Returns:

this builder

name

public WikiMacroDescriptor.Builder name(String name)

Parameters:

name - the macro name

Returns:

this builder

description

public WikiMacroDescriptor.Builder description(String description)

Parameters:

description - the macro description

Returns:

this builder

defaultCategories

@Unstable
public WikiMacroDescriptor.Builder defaultCategories(Collection<String> defaultCategories)

Parameters:

defaultCategories - the macro default categories

Returns:

this build

Since:

14.6RC1

visibility

public WikiMacroDescriptor.Builder visibility(WikiMacroVisibility visibility)

Parameters:

visibility - the macro visibility

Returns:

this builder

supportsInlineMode

public WikiMacroDescriptor.Builder supportsInlineMode(boolean supportsInlineMode)

Parameters:

supportsInlineMode - whether the macro can be used in-line or not

Returns:

this builder

contentDescriptor

public WikiMacroDescriptor.Builder contentDescriptor(org.xwiki.rendering.macro.descriptor.ContentDescriptor contentDescriptor)

Parameters:

contentDescriptor - the macro content descriptor

Returns:

this builder

parameterDescriptors

public WikiMacroDescriptor.Builder parameterDescriptors(List<WikiMacroParameterDescriptor> parameterDescriptors)

Parameters:

parameterDescriptors - the list of macro parameter descriptors

Returns:

this builder

build

public WikiMacroDescriptor build()

Returns:

the macro descriptor