com.xpn.xwiki.objects

Class ListProperty

java.lang.Object

com.xpn.xwiki.objects.BaseElement<R>

com.xpn.xwiki.objects.BaseProperty

com.xpn.xwiki.objects.ListProperty

All Implemented Interfaces:

ElementInterface, PropertyInterface, Serializable, Cloneable

Direct Known Subclasses:

DBStringListProperty, StringListProperty

public class ListProperty
extends BaseProperty
implements Cloneable

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ListProperty.NotifyList List implementation for updating dirty flag when updated.

Field Summary

Fields

Modifier and Type	Field and Description
protected List<String>	list We make this a notifying list, because we must propagate any value updates to the owner document.

Fields inherited from class com.xpn.xwiki.objects.BaseElement

documentReference, ownerDocument, referenceCache

Constructor Summary

Constructors

Constructor and Description
ListProperty()

Method Summary

Modifier and Type	Method and Description
ListProperty	clone()
protected void	cloneInternal(BaseProperty clone) Subclasses override this to copy values during cloning.
boolean	equals(Object obj)
String	getFormStringSeparator() Deprecated. since 7.0M2. This was never used, since it is not the right place to handle separators. They are defined in ListClass and that is where they are now handled through ListClass.toFormString(BaseProperty).
List<String>	getList()
String	getTextValue() This method is called by Hibernate to get the raw value to store in the database.
Object	getValue()
protected void	mergeValue(Object previousValue, Object newValue, MergeResult mergeResult) Try to apply 3 ways merge on property value.
void	setFormStringSeparator(String formStringSeparator) Deprecated. since 7.0M2. This was never used, since it is not the right place to handle separators. They are defined in ListClass and that is where they are now handled through ListClass.toFormString(BaseProperty).
void	setList(List<String> list) Starting from 4.3M2, this method will copy the list passed as parameter.
void	setValue(Object value)
String	toSingleFormString() Deprecated. Since 7.0M2. This method is here for a long time but it does not seem to have ever been used and it does not bring any value compared to the existing BaseProperty.toFormString() method.
String	toString()
String	toText()

Methods inherited from class com.xpn.xwiki.objects.BaseProperty

apply, createReference, getClassType, getCustomMappingValue, getId, getObject, getPropertyClass, hashCode, isValueDirty, merge, setClassType, setId, setObject, setOwnerDocument, setValueDirty, setValueDirty, toFormString, toXML, toXMLString

Methods inherited from class com.xpn.xwiki.objects.BaseElement

fromXML, fromXML, getDocumentReference, getLocalEntityReferenceSerializer, getLocalization, getLocalKey, getLocalUidStringEntityReferenceSerializer, getMergeManager, getName, getOwnerDocument, getPrettyName, getReference, getXWikiContext, localizePlain, localizePlainOrKey, setDocumentReference, setName, setPrettyName, toXMLString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.xpn.xwiki.objects.ElementInterface

getDocumentReference, getName, getReference, setDocumentReference, setName

Field Detail

list

protected transient List<String> list

We make this a notifying list, because we must propagate any value updates to the owner document.

Constructor Detail

ListProperty

public ListProperty()

Method Detail

getFormStringSeparator

@Deprecated
public String getFormStringSeparator()

Deprecated. since 7.0M2. This was never used, since it is not the right place to handle separators. They are defined in ListClass and that is where they are now handled through ListClass.toFormString(BaseProperty).

setFormStringSeparator

@Deprecated
public void setFormStringSeparator(String formStringSeparator)

Deprecated. since 7.0M2. This was never used, since it is not the right place to handle separators. They are defined in ListClass and that is where they are now handled through ListClass.toFormString(BaseProperty).

getValue

public Object getValue()

Overrides:

getValue in class BaseProperty

setValue

public void setValue(Object value)

Overrides:

setValue in class BaseProperty

getTextValue

public String getTextValue()

This method is called by Hibernate to get the raw value to store in the database. Check the xwiki.hbm.xml file.

Returns:

the string value that is saved in the database

toText

public String toText()

Overrides:

toText in class BaseProperty

toSingleFormString

@Deprecated
public String toSingleFormString()

Deprecated. Since 7.0M2. This method is here for a long time but it does not seem to have ever been used and it does not bring any value compared to the existing BaseProperty.toFormString() method.

equals

public boolean equals(Object obj)

Overrides:

equals in class BaseProperty

clone

public ListProperty clone()

Specified by:

clone in interface PropertyInterface

Overrides:

clone in class BaseProperty

cloneInternal

protected void cloneInternal(BaseProperty clone)

Description copied from class: BaseProperty

Subclasses override this to copy values during cloning.

Overrides:

cloneInternal in class BaseProperty

Parameters:

clone - The cloned value.

getList

public List<String> getList()

setList

public void setList(List<String> list)

Starting from 4.3M2, this method will copy the list passed as parameter. Due to XWIKI-8398 we must be able to detect when the values in the list changes, so we cannot store the values in any type of list.

Parameters:

list - The list to copy.

toString

public String toString()

This is important.. Otherwise we can get a stackoverflow calling toXML().

Specified by:

toString in interface ElementInterface

Overrides:

toString in class BaseElement

See Also:

BaseElement.toString()

mergeValue

protected void mergeValue(Object previousValue,
                          Object newValue,
                          MergeResult mergeResult)

Description copied from class: BaseProperty

Try to apply 3 ways merge on property value.

Overrides:

mergeValue in class BaseProperty

Parameters:

previousValue - the previous version of the value

newValue - the new version of the value

mergeResult - merge report