org.xwiki.livedata

Class WithParameters

java.lang.Object

org.xwiki.livedata.WithParameters

Direct Known Subclasses:

BaseDescriptor

@Unstable
public class WithParameters
extends Object

Base class for components and POJOs that can have unknown parameters. When extended by POJOs the unknown parameters are serialized as JSON side by side with the other (known) POJO fields. When extended by components, they should have ComponentInstantiationStrategy.PER_LOOKUP.

Since:

12.10

Version:

$Id: 0e64750d6f9b9a4f59f0b5a27ab51563fc18b2fa $

Constructor Summary

Constructors

Constructor and Description
WithParameters()

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
Map<String,Object>	getParameters()
int	hashCode()
Object	setParameter(String key, Object value) Set the value of a parameter.

Methods inherited from class java.lang.Object

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

Constructor Detail

WithParameters

public WithParameters()

Method Detail

getParameters

public Map<String,Object> getParameters()

Returns:

the parameters

setParameter

public Object setParameter(String key,
                           Object value)

Set the value of a parameter.

Parameters:

key - the parameter name

value - the parameter value

Returns:

the previous parameter value

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object