Package org.xwiki.refactoring

Class WikiDocument

java.lang.Object

org.xwiki.refactoring.WikiDocument

public class WikiDocument
extends Object

Represents an in-memory wiki page used by the DocumentSplitter interface.

Since:

1.9M1

Version:

$Id: b91255e9f3a9adc06b6942c01e88f1fa04c6bc05 $

Constructor Summary

Constructors

Constructor	Description
WikiDocument(String fullName, org.xwiki.rendering.block.XDOM xdom, WikiDocument parent)	Deprecated. since 14.10.2, 15.0RC1 use WikiDocument(DocumentReference, XDOM, WikiDocument) instead
WikiDocument(org.xwiki.model.reference.DocumentReference documentReference, org.xwiki.rendering.block.XDOM xdom, WikiDocument parent)	Constructs a new WikiDocument.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
org.xwiki.model.reference.DocumentReference	getDocumentReference()
String	getFullName()	Deprecated. since 14.10.2, 15.0RC1 use getDocumentReference() instead
WikiDocument	getParent()
org.xwiki.rendering.block.XDOM	getXdom()
int	hashCode()

Methods inherited from class java.lang.Object

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

Constructor Detail

WikiDocument

@Deprecated
public WikiDocument(String fullName,
                    org.xwiki.rendering.block.XDOM xdom,
                    WikiDocument parent)

Deprecated.

since 14.10.2, 15.0RC1 use WikiDocument(DocumentReference, XDOM, WikiDocument) instead

Constructs a new WikiDocument.

Parameters:

fullName - full name of the target wiki page

xdom - XDOM for the target wiki page

parent - the parent WikiDocument of this document

WikiDocument

@Unstable
public WikiDocument(org.xwiki.model.reference.DocumentReference documentReference,
                    org.xwiki.rendering.block.XDOM xdom,
                    WikiDocument parent)

Constructs a new WikiDocument.

Parameters:

documentReference - the reference of the target wiki page

xdom - XDOM for the target wiki page

parent - the parent WikiDocument of this document

Since:

14.10.2, 15.0RC1

Method Detail

getFullName

@Deprecated
public String getFullName()

Deprecated.

since 14.10.2, 15.0RC1 use getDocumentReference() instead

Returns:

full name of the target wiki page

getDocumentReference

@Unstable
public org.xwiki.model.reference.DocumentReference getDocumentReference()

Returns:

the reference of the target wiki page

Since:

14.10.2, 15.0RC1

getXdom

public org.xwiki.rendering.block.XDOM getXdom()

Returns:

the XDOM of the target wiki page

getParent

public WikiDocument getParent()

Returns:

the parent WikiDocument of this document

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object