org.xwiki.model.reference

Class PageReference

java.lang.Object

org.xwiki.model.reference.EntityReference

org.xwiki.model.reference.AbstractLocalizedEntityReference

org.xwiki.model.reference.PageReference

All Implemented Interfaces:

Serializable, Cloneable, Comparable<EntityReference>

@Unstable
public class PageReference
extends AbstractLocalizedEntityReference

Represents a reference to a page. Note that nested pages are supported.

Since:

10.6RC1

Version:

$Id: 3bbc47c03a8155961f3b24db75d283beaccf59bf $

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static Type	TYPE_PROVIDER The Type for a Provider<PageReference>.

Fields inherited from class org.xwiki.model.reference.AbstractLocalizedEntityReference

LOCALE

Fields inherited from class org.xwiki.model.reference.EntityReference

TOSTRING_SERIALIZER

Constructor Summary

Constructors

Modifier	Constructor and Description
	PageReference(EntityReference reference) Special constructor that transforms a generic entity reference into a PageReference.
protected	PageReference(EntityReference reference, EntityReference oldReference, EntityReference newReference) Clone a page reference, but replace one of the parent in the chain by a new one.
	PageReference(EntityReference reference, Locale locale) Clone an EntityReference and change/add the passed Locale.
	PageReference(LocalPageReference localPageReference, WikiReference wikiReference) Create a new page reference from local page reference and wiki reference.
	PageReference(String pageName, EntityReference parent) Create a page reference based on a page name and a parent entity reference.
	PageReference(String pageName, EntityReference parent, Locale locale) Create a page reference based on a page name and a parent entity reference.
	PageReference(String wikiName, List<String> pageNames) Create a page reference based on a page name and a parent page reference.
	PageReference(String wikiName, List<String> pageNames, Locale locale) Create a page reference based on a page name and a parent page reference.
	PageReference(String pageName, PageReference parent) Create a page reference based on a page name and a parent page reference.
	PageReference(String wikiName, String pageName, String... pageNames) Create a page reference based on a page name and a parent page reference.
	PageReference(String pageName, WikiReference parent) Create a page reference based on a page name and a parent wiki reference.

Method Summary

Modifier and Type	Method and Description
WikiReference	getWikiReference()
PageReference	replaceParent(EntityReference oldParent, EntityReference newParent) Return a clone of this reference, but with one of its parent replaced by another one.
protected void	setParent(EntityReference parent) Entity reference are immutable since 3.3M2, so this method is now protected.
protected void	setType(EntityType type) Entity reference are immutable since 3.3M2, so this method is now protected.
String	toString()

Methods inherited from class org.xwiki.model.reference.AbstractLocalizedEntityReference

getLocale, setLocale, setParameter

Methods inherited from class org.xwiki.model.reference.EntityReference

appendParent, compareTo, equals, equals, equals, equalsNonRecursive, extractFirstReference, extractReference, getName, getParameter, getParameters, getParent, getReversedReferenceChain, getRoot, getType, hashCode, hasParent, removeParent, setName, setParameters, size

Methods inherited from class java.lang.Object

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

Field Detail

TYPE_PROVIDER

public static final Type TYPE_PROVIDER

The Type for a Provider<PageReference>.

Constructor Detail

PageReference

public PageReference(EntityReference reference)

Special constructor that transforms a generic entity reference into a PageReference. It checks the validity of the passed reference (ie correct type).

Parameters:

reference - the entity reference to transforms

Throws:

IllegalArgumentException - if the passed reference is not a valid page reference

PageReference

protected PageReference(EntityReference reference,
                        EntityReference oldReference,
                        EntityReference newReference)

Clone a page reference, but replace one of the parent in the chain by a new one.

Parameters:

reference - the reference that is cloned

oldReference - the old parent that will be replaced

newReference - the new parent that will replace oldReference in the chain

PageReference

public PageReference(String pageName,
                     WikiReference parent)

Create a page reference based on a page name and a parent wiki reference.

Parameters:

pageName - the name of the page

parent - the wiki reference

PageReference

public PageReference(String pageName,
                     PageReference parent)

Create a page reference based on a page name and a parent page reference.

Parameters:

pageName - the name of the page

parent - the page reference

PageReference

public PageReference(String pageName,
                     EntityReference parent)

Create a page reference based on a page name and a parent entity reference. The entity reference may be either a wiki or a page reference.

Parameters:

pageName - the name of the page

parent - the entity reference

PageReference

public PageReference(String pageName,
                     EntityReference parent,
                     Locale locale)

Create a page reference based on a page name and a parent entity reference. The entity reference may be either a wiki or a page reference.

Parameters:

pageName - the name of the page

parent - the entity reference

locale - the Locale of the page.

PageReference

public PageReference(EntityReference reference,
                     Locale locale)

Clone an EntityReference and change/add the passed Locale.

Parameters:

reference - the reference to clone

locale - the Locale of the new reference

PageReference

public PageReference(String wikiName,
                     List<String> pageNames)

Create a page reference based on a page name and a parent page reference.

Parameters:

wikiName - the name of the wiki

pageNames - the pages names

PageReference

public PageReference(String wikiName,
                     List<String> pageNames,
                     Locale locale)

Create a page reference based on a page name and a parent page reference.

Parameters:

wikiName - the name of the wiki

pageNames - the pages names

locale - the Locale of the entity.

PageReference

public PageReference(String wikiName,
                     String pageName,
                     String... pageNames)

Create a page reference based on a page name and a parent page reference.

Parameters:

wikiName - the name of the wiki

pageName - the root page name

pageNames - the children page names

PageReference

public PageReference(LocalPageReference localPageReference,
                     WikiReference wikiReference)

Create a new page reference from local page reference and wiki reference.

Parameters:

localPageReference - the page reference without the wiki reference

wikiReference - the wiki reference

Method Detail

setParent

protected void setParent(EntityReference parent)

Entity reference are immutable since 3.3M2, so this method is now protected.

Overridden in order to verify the validity of the passed parent.

Overrides:

setParent in class EntityReference

Parameters:

parent - the parent for this entity, may be null for a root entity.

Throws:

IllegalArgumentException - if the passed parent is not a valid page reference parent (ie either a page reference or a wiki reference)

See Also:

EntityReference.setParent(EntityReference)

setType

protected void setType(EntityType type)

Entity reference are immutable since 3.3M2, so this method is now protected.

Overridden in order to verify the validity of the passed type.

Overrides:

setType in class EntityReference

Parameters:

type - the type for this entity

Throws:

IllegalArgumentException - if the passed type is not a page type

See Also:

EntityReference.setType(org.xwiki.model.EntityType)

replaceParent

public PageReference replaceParent(EntityReference oldParent,
                                   EntityReference newParent)

Description copied from class: EntityReference

Return a clone of this reference, but with one of its parent replaced by another one.

Overrides:

replaceParent in class EntityReference

Parameters:

oldParent - the old parent that will be replaced

newParent - the new parent that will replace oldParent in the chain. If the same as oldParent, this is returned.

Returns:

a new reference with a amended parent chain

getWikiReference

public WikiReference getWikiReference()

Returns:

the reference of the wiki containing this page

toString

public String toString()

Overrides:

toString in class EntityReference