com.xpn.xwiki.api

Class Property

java.lang.Object

com.xpn.xwiki.api.Api

com.xpn.xwiki.api.Element

com.xpn.xwiki.api.Property

public class Property
extends Element

Property is a single attribute of an XWiki Object.

Version:

$Id: d257d9ba675a2ef56c46b43be6b598df15427ae6 $

Field Summary

Fields inherited from class com.xpn.xwiki.api.Element

element

Fields inherited from class com.xpn.xwiki.api.Api

context

Constructor Summary

Constructors

Constructor and Description
Property(BaseProperty property, XWikiContext context) The Constructor.

Method Summary

Modifier and Type	Method and Description
protected BaseProperty	getBaseProperty()
BaseProperty	getProperty()
PropertyClass	getPropertyClass()
Object	getValue()

Methods inherited from class com.xpn.xwiki.api.Element

getBaseElement, getDocumentReference, getName, getReference

Methods inherited from class com.xpn.xwiki.api.Api

convert, convert, convert, convertAttachments, getAuthorizationManager, getContextualAuthorizationManager, getXWikiContext, hasAccess, hasAccessLevel, hasAdminRights, hasProgrammingRights, hasWikiAdminRights

Methods inherited from class java.lang.Object

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

Constructor Detail

Property

public Property(BaseProperty property,
                XWikiContext context)

The Constructor.

Parameters:

property - the internal BaseProperty to wrap.

context - the XWikiContext which may be used to get information about the current request.

Method Detail

getBaseProperty

protected BaseProperty getBaseProperty()

Returns:

the internal BaseProperty which this Property wraps.

getProperty

public BaseProperty getProperty()

Returns:

the internal BaseProperty which this Property wraps.

getPropertyClass

public PropertyClass getPropertyClass()

Returns:

the definition of the property

Since:

8.3M1

getValue

public Object getValue()

Returns:

the actual value of the property, as a String, Number or List.