Package org.xwiki.edit

Interface EditorDescriptorBuilder

All Superinterfaces:

EditorDescriptor

@Role
public interface EditorDescriptorBuilder
extends EditorDescriptor

Builds an EditorDescriptor instance.

Since:

8.2RC1

Version:

$Id: dec4343442c61d54142cdd5bf45b1d81f54109e1 $

Method Summary

Modifier and Type	Method	Description
EditorDescriptor	build()	Builds the editor descriptor.
EditorDescriptorBuilder	setCategory(String category)	Sets the editor category.
EditorDescriptorBuilder	setDescription(String description)	Sets the editor description.
EditorDescriptorBuilder	setIcon(String icon)	Sets the editor icon.
EditorDescriptorBuilder	setId(String id)	Sets the editor id.
EditorDescriptorBuilder	setName(String name)	Sets the editor name.

Methods inherited from interface org.xwiki.edit.EditorDescriptor

getCategory, getDescription, getIcon, getId, getName

Method Details

setId

EditorDescriptorBuilder setId(String id)

Sets the editor id.

Parameters:

id - the editor id

Returns:

this builder

setName

EditorDescriptorBuilder setName(String name)

Sets the editor name.

Parameters:

name - the editor name

Returns:

this builder

setDescription

EditorDescriptorBuilder setDescription(String description)

Sets the editor description.

Parameters:

description - the editor description

Returns:

this builder

setIcon

EditorDescriptorBuilder setIcon(String icon)

Sets the editor icon.

Parameters:

icon - the editor icon

Returns:

this builder

setCategory

EditorDescriptorBuilder setCategory(String category)

Sets the editor category.

Parameters:

category - the editor category

Returns:

this builder

build

EditorDescriptor build()

Builds the editor descriptor.

Returns:

the editor descriptor