org.xwiki.model.reference

Class LocalDocumentReference

java.lang.Object

org.xwiki.model.reference.EntityReference

org.xwiki.model.reference.LocalDocumentReference

All Implemented Interfaces:

Serializable, Cloneable, Comparable<EntityReference>

public class LocalDocumentReference
extends EntityReference

Represents a reference to a document in the current wiki.

Since:

5.0M1

Version:

$Id: c836395a74397b907fe06bb6b5ad69475e921b90 $

See Also:

Serialized Form

Field Summary

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

TOSTRING_SERIALIZER

Constructor Summary

Constructors

Constructor and Description
LocalDocumentReference(DocumentReference documentReference)
LocalDocumentReference(EntityReference reference)
LocalDocumentReference(EntityReference entityReference, Locale locale)
LocalDocumentReference(Iterable<String> spaceNames, String pageName) Create a new Document reference in the current wiki.
LocalDocumentReference(String pageName, EntityReference spaceReference) Create a new Document reference in the current wiki.
LocalDocumentReference(String spaceName, String pageName) Create a new Document reference in the current wiki.
LocalDocumentReference(String spaceName, String pageName, Locale locale) Create a new Document reference in the current wiki.

Method Summary

Methods

Modifier and Type	Method and Description
Locale	getLocale()
protected void	setLocale(Locale locale) Set the locale of this document reference.

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

appendParent, compareTo, equals, equals, equals, equalsNonRecursive, extractFirstReference, extractReference, getName, getParameter, getParent, getReversedReferenceChain, getRoot, getType, hashCode, hasParent, removeParent, replaceParent, setName, setParameter, setParameters, setParent, setType, size, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

LocalDocumentReference

public LocalDocumentReference(String spaceName,
                      String pageName)

Create a new Document reference in the current wiki.

Parameters:

spaceName - the name of the space containing the document, must not be null

pageName - the name of the document, must not be null

LocalDocumentReference

public LocalDocumentReference(Iterable<String> spaceNames,
                      String pageName)

Create a new Document reference in the current wiki.

Parameters:

spaceNames - an ordered list of the names of the spaces containing the document from root space to last one, must not be null

pageName - the name of the document

Since:

7.3M1

LocalDocumentReference

public LocalDocumentReference(String spaceName,
                      String pageName,
                      Locale locale)

Create a new Document reference in the current wiki.

Parameters:

spaceName - the name of the space containing the document, must not be null

pageName - the name of the document, must not be null

locale - the new locale for this reference

Since:

5.3RC1

LocalDocumentReference

public LocalDocumentReference(DocumentReference documentReference)

Parameters:

documentReference - the full document reference

Since:

5.2M2

LocalDocumentReference

public LocalDocumentReference(EntityReference reference)

Parameters:

reference - the reference to clone

Since:

5.4RC1

LocalDocumentReference

public LocalDocumentReference(EntityReference entityReference,
                      Locale locale)

Parameters:

entityReference - the reference

locale - the new locale for this reference, if null, locale is removed

Since:

5.3RC1

LocalDocumentReference

public LocalDocumentReference(String pageName,
                      EntityReference spaceReference)

Create a new Document reference in the current wiki.

Parameters:

pageName - the name of the document, must not be null

spaceReference - the reference of the space, must not be null

Since:

7.2M1

Method Detail

getLocale

public Locale getLocale()

Returns:

the locale of this document reference

Since:

5.3RC1

setLocale

protected void setLocale(Locale locale)

Set the locale of this document reference.

Parameters:

locale - the locale of this document reference

Since:

5.3RC1