Package org.xwiki.filter

Class FilterElementDescriptor

java.lang.Object

org.xwiki.filter.FilterElementDescriptor

public class FilterElementDescriptor
extends Object

An element of the filter.

An element is defined by either an on event of a combination of begin and end events.

Since:

5.2M1

Version:

$Id: 025f1062cdab24e8210c1391b77f9573007776ab $

Constructor Summary

Constructors

Constructor	Description
FilterElementDescriptor(String name)
FilterElementDescriptor(String name, FilterElementParameterDescriptor<?>[] parameters)

Method Summary

Modifier and Type	Method	Description
Method	getBeginMethod()
Method	getEndMethod()
String	getName()
Method	getOnMethod()
<T> FilterElementParameterDescriptor<T>	getParameter(String name)
FilterElementParameterDescriptor<?>[]	getParameters()
void	setBeginMethod(Method beginMethod)
void	setEndMethod(Method endMethod)
void	setOnMethod(Method onMethod)

Methods inherited from class java.lang.Object

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

Constructor Detail

FilterElementDescriptor

public FilterElementDescriptor(String name)

Parameters:

name - the name of the element

FilterElementDescriptor

public FilterElementDescriptor(String name,
                               FilterElementParameterDescriptor<?>[] parameters)

Parameters:

name - the name of the element

parameters - the parameters

Method Detail

getName

public String getName()

Returns:

the name of the element

getParameters

public FilterElementParameterDescriptor<?>[] getParameters()

Returns:

the parameters of the element

getParameter

public <T> FilterElementParameterDescriptor<T> getParameter(String name)

Type Parameters:

T - the type of the parameter value

Parameters:

name - the name of the parameter

Returns:

the parameter associated to the passed name

getBeginMethod

public Method getBeginMethod()

Returns:

the begin method, null if it's a on event based element

setBeginMethod

public void setBeginMethod(Method beginMethod)

Parameters:

beginMethod - the begin method, null if it's a on event based element

getEndMethod

public Method getEndMethod()

Returns:

the end method, null if it's a on event based element

setEndMethod

public void setEndMethod(Method endMethod)

Parameters:

endMethod - the end method, null if it's a on event based element

getOnMethod

public Method getOnMethod()

Returns:

the on method, null if it's a begin/end event based element

setOnMethod

public void setOnMethod(Method onMethod)

Parameters:

onMethod - the on method, null if it's a begin/end event based element