com.xpn.xwiki.api
Class Element
java.lang.Object
com.xpn.xwiki.api.Api
com.xpn.xwiki.api.Element
- Direct Known Subclasses:
- Collection, Property
public class Element
- extends Api
Element is a superclass for any XWiki Class, Object, or Property which might be stored in the database.
- Version:
- $Id: a7e1f6131dd3807a55eafb9ea20fd6a7275aedce $
Fields inherited from class com.xpn.xwiki.api.Api |
context |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
element
protected BaseElement element
- The internal element which this wraps.
Element
public Element(BaseElement element,
XWikiContext context)
- The Constructor.
Create a new element wrapping the given internal BaseElement.
- Parameters:
element
- the internal BaseElement to wrap.context
- the XWikiContext which may be used to get information about the current request.
getBaseElement
protected BaseElement getBaseElement()
- Returns:
- the internal BaseElement which this Element wraps.
getName
public String getName()
- Get the name of this element.
If the Element is an XWiki
Object
then it will be the name of the Document
containing the Object, if it's an XWiki Class
it will be the full name of the
Document
where the class is defined, if it's an XWiki
Property
then it will be the name of the property.
- Returns:
- the name of this Element.
Copyright © 2004–2014 XWiki. All rights reserved.