org.xwiki.tool.extension

Class ComponentRepresentation

java.lang.Object

org.xwiki.tool.extension.ComponentRepresentation

@Unstable
public class ComponentRepresentation
extends Object

A class to represent a ComponentRole with a serialized type.

Since:

12.2

Version:

$Id: dff12785a3a334eee3e1d07cb0be3a2ff7d917ad $

Constructor Summary

Constructors

Constructor and Description
ComponentRepresentation()

Method Summary

Modifier and Type	Method and Description
String	getRole()
String	getType()
void	setRole(String role) Set the role of the component to retrieve.
void	setType(String type) Set the serialized type of the component.

Methods inherited from class java.lang.Object

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

Constructor Detail

ComponentRepresentation

public ComponentRepresentation()

Method Detail

getRole

public String getRole()

Returns:

the role of the component or the default role.

setRole

public void setRole(String role)

Set the role of the component to retrieve.

Parameters:

role - the role used for this component.

getType

public String getType()

Returns:

the serialized type of the component. This value is mandatory.

setType

public void setType(String type)

Set the serialized type of the component.

Parameters:

type - a serialized string corresponding to the type of the component.