org.xwiki.edit

Class EditorDescriptorBuilder

java.lang.Object

org.xwiki.edit.EditorDescriptorBuilder

All Implemented Interfaces:

EditorDescriptor

@Component(roles=EditorDescriptorBuilder.class)
 @InstantiationStrategy(value=PER_LOOKUP)
 @Unstable
public class EditorDescriptorBuilder
extends Object
implements EditorDescriptor

Builds an EditorDescriptor instance.

Since:

8.2RC1

Version:

$Id: dbd5e3d00aa7aecd57e3cfd33089b3bc95fa82d9 $

Constructor Summary

Constructors

Constructor and Description
EditorDescriptorBuilder()

Method Summary

Modifier and Type	Method and Description
EditorDescriptor	build() Builds the editor descriptor.
String	getCategory()
String	getDescription()
String	getIcon()
String	getId()
String	getName()
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 class java.lang.Object

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

Constructor Detail

EditorDescriptorBuilder

public EditorDescriptorBuilder()

Method Detail

setId

public EditorDescriptorBuilder setId(String id)

Sets the editor id.

Parameters:

id - the editor id

Returns:

this builder

getId

public String getId()

Specified by:

getId in interface EditorDescriptor

Returns:

the editor identifier (normally the editor component hint)

setName

public EditorDescriptorBuilder setName(String name)

Sets the editor name.

Parameters:

name - the editor name

Returns:

this builder

getName

public String getName()

Specified by:

getName in interface EditorDescriptor

Returns:

the editor name

setDescription

public EditorDescriptorBuilder setDescription(String description)

Sets the editor description.

Parameters:

description - the editor description

Returns:

this builder

getDescription

public String getDescription()

Specified by:

getDescription in interface EditorDescriptor

Returns:

the editor description

setIcon

public EditorDescriptorBuilder setIcon(String icon)

Sets the editor icon.

Parameters:

icon - the editor icon

Returns:

this builder

getIcon

public String getIcon()

Specified by:

getIcon in interface EditorDescriptor

Returns:

the editor icon

setCategory

public EditorDescriptorBuilder setCategory(String category)

Sets the editor category.

Parameters:

category - the editor category

Returns:

this builder

getCategory

public String getCategory()

Specified by:

getCategory in interface EditorDescriptor

Returns:

the editor category

build

public EditorDescriptor build()

Builds the editor descriptor.

Returns:

the editor descriptor