Uses of Class
org.xwiki.model.reference.EntityReference

Packages that use EntityReference

Package	Description
org.xwiki.model
org.xwiki.model.reference
org.xwiki.model.script

Uses of EntityReference in org.xwiki.model

Methods in org.xwiki.model that return EntityReference

Modifier and Type	Method	Description
EntityReference	ModelContext.getCurrentEntityReference()

Methods in org.xwiki.model with parameters of type EntityReference

Modifier and Type	Method	Description
void	ModelContext.setCurrentEntityReference(EntityReference entityReference)

Uses of EntityReference in org.xwiki.model.reference

Subclasses of EntityReference in org.xwiki.model.reference

Modifier and Type	Class	Description
class	AbstractLocalizedEntityReference	Represents an entity reference which contains a locale.
class	AttachmentReference	Represents a reference to an Attachment (document reference and file name).
class	BlockReference	Reference to a block, a structured part of the content of a document or an object property.
class	ClassPropertyReference	References a property in a class in a document (the description of the property).
class	DocumentReference	Represents a reference to a document (wiki, space and document names).
class	DocumentVersionReference	A reference to a document version.
class	LocalDocumentReference	Represents a reference to a document in the current wiki.
class	LocalPageReference	Represents a reference to a page in the current wiki.
class	ObjectPropertyReference	References a property in an object in a document (the value of the property).
class	ObjectReference	Reference to an object in a document (by classname and index, document, space, wiki).
class	PageAttachmentReference	Represents a reference to an Attachment (page reference and file name).
class	PageClassPropertyReference	References a property in a class in a page (the description of the property).
class	PageObjectPropertyReference	References a property in an object in a document (the value of the property).
class	PageObjectReference	Reference to an object in a page (by classname and index, page, wiki).
class	PageReference	Represents a reference to a page.
class	PartialEntityReference	An EntityReference used to match another one.
class	RegexEntityReference	An EntityReference used to match another one.
class	SpaceReference	Represents a reference to a space (space name).
class	WikiReference	Represents a reference to a wiki (wiki name).

Methods in org.xwiki.model.reference that return EntityReference

Modifier and Type	Method	Description
EntityReference	EntityReference.appendParent(EntityReference newParent)	Return a clone of this reference with a parent appended at the root of its parents chain.
EntityReference	EntityReference.extractFirstReference(EntityType type)	Extract the first entity of the given type from this one by traversing the current entity to the root.
EntityReference	EntityReference.extractReference(EntityType type)	Extract the last entity of the given type from this one by traversing the current entity to the root.
EntityReference	EntityReferenceProvider.getDefaultReference(EntityType type)
EntityReference	EntityReference.getParent()
EntityReference	EntityReferenceTreeNode.getReference()
EntityReference	EntityReference.getRoot()
EntityReference	EntityReference.removeParent(EntityReference oldParent)	Return a clone of this reference truncated to a null parent when it reach the given parent.
EntityReference	EntityReference.replaceParent(EntityReference newParent)	Return a clone of this reference, but with its parent replaced by the passed one.
EntityReference	EntityReference.replaceParent(EntityReference oldParent, EntityReference newParent)	Return a clone of this reference, but with one of its parent replaced by another one.
EntityReference	EntityReferenceResolver.resolve(T entityReferenceRepresentation, EntityType type, Object... parameters)

Methods in org.xwiki.model.reference that return types with arguments of type EntityReference

Modifier and Type	Method	Description
Collection<EntityReference>	EntityReferenceTreeNode.getLocales()
List<EntityReference>	EntityReference.getReversedReferenceChain()

Methods in org.xwiki.model.reference with parameters of type EntityReference

Modifier and Type	Method	Description
EntityReference	EntityReference.appendParent(EntityReference newParent)	Return a clone of this reference with a parent appended at the root of its parents chain.
int	EntityReference.compareTo(EntityReference reference)
boolean	EntityReference.equals(EntityReference otherReference, EntityType to)	Compared the two reference between the first reference and the last (including) to type of entity.
boolean	EntityReference.equals(EntityReference otherReference, EntityType from, EntityType to)	Compared the two reference between the first (including) from type of entity and the last (including) to type of entity.
boolean	EntityReference.equalsNonRecursive(EntityReference otherReference)	Same as equals(Object) but only the first level of the references (ignore parents).
EntityReferenceSet	EntityReferenceSet.excludes(EntityReference reference)
EntityReferenceTreeNode	EntityReferenceTreeNode.get(EntityReference path)
boolean	EntityReference.hasParent(EntityReference expectedParent)	Checks if a given reference is a parent of this reference.
EntityReferenceSet	EntityReferenceSet.includes(EntityReference reference)
boolean	EntityReferenceSet.matches(EntityReference reference)
EntityReference	EntityReference.removeParent(EntityReference oldParent)	Return a clone of this reference truncated to a null parent when it reach the given parent.
AttachmentReference	AttachmentReference.replaceParent(EntityReference newParent)
AttachmentReference	AttachmentReference.replaceParent(EntityReference oldParent, EntityReference newParent)
BlockReference	BlockReference.replaceParent(EntityReference newParent)
BlockReference	BlockReference.replaceParent(EntityReference oldParent, EntityReference newParent)
ClassPropertyReference	ClassPropertyReference.replaceParent(EntityReference newParent)
ClassPropertyReference	ClassPropertyReference.replaceParent(EntityReference oldParent, EntityReference newParent)
DocumentReference	DocumentReference.replaceParent(EntityReference newParent)
DocumentReference	DocumentReference.replaceParent(EntityReference oldParent, EntityReference newParent)
EntityReference	EntityReference.replaceParent(EntityReference newParent)	Return a clone of this reference, but with its parent replaced by the passed one.
EntityReference	EntityReference.replaceParent(EntityReference oldParent, EntityReference newParent)	Return a clone of this reference, but with one of its parent replaced by another one.
LocalDocumentReference	LocalDocumentReference.replaceParent(EntityReference newParent)
LocalPageReference	LocalPageReference.replaceParent(EntityReference newParent)
ObjectPropertyReference	ObjectPropertyReference.replaceParent(EntityReference newParent)
ObjectPropertyReference	ObjectPropertyReference.replaceParent(EntityReference oldParent, EntityReference newParent)
ObjectReference	ObjectReference.replaceParent(EntityReference newParent)
ObjectReference	ObjectReference.replaceParent(EntityReference oldParent, EntityReference newParent)
PageAttachmentReference	PageAttachmentReference.replaceParent(EntityReference newParent)
PageAttachmentReference	PageAttachmentReference.replaceParent(EntityReference oldParent, EntityReference newParent)
PageClassPropertyReference	PageClassPropertyReference.replaceParent(EntityReference newParent)
PageClassPropertyReference	PageClassPropertyReference.replaceParent(EntityReference oldParent, EntityReference newParent)
PageObjectPropertyReference	PageObjectPropertyReference.replaceParent(EntityReference newParent)
PageObjectPropertyReference	PageObjectPropertyReference.replaceParent(EntityReference oldParent, EntityReference newParent)
PageObjectReference	PageObjectReference.replaceParent(EntityReference newParent)
PageObjectReference	PageObjectReference.replaceParent(EntityReference oldParent, EntityReference newParent)
PageReference	PageReference.replaceParent(EntityReference newParent)
PageReference	PageReference.replaceParent(EntityReference oldParent, EntityReference newParent)
SpaceReference	SpaceReference.replaceParent(EntityReference newParent)
SpaceReference	SpaceReference.replaceParent(EntityReference oldParent, EntityReference newParent)
T	EntityReferenceSerializer.serialize(EntityReference reference, Object... parameters)	Serialize an entity reference into a new representation of type T.
protected void	AttachmentReference.setParent(EntityReference parent)	Entity reference are immutable since 3.3M2, so this method is now protected.
protected void	BlockReference.setParent(EntityReference parent)	Entity reference are immutable since 3.3M2, so this method is now protected.
protected void	ClassPropertyReference.setParent(EntityReference parent)	Entity reference are immutable since 3.3M2, so this method is now protected.
protected void	DocumentReference.setParent(EntityReference parent)	Entity reference are immutable since 3.3M2, so this method is now protected.
protected void	EntityReference.setParent(EntityReference parent)	Entity reference are immutable since 3.3M2, so this method is now protected.
protected void	LocalPageReference.setParent(EntityReference parent)	Entity reference are immutable since 3.3M2, so this method is now protected.
protected void	ObjectPropertyReference.setParent(EntityReference parent)	Entity reference are immutable since 3.3M2, so this method is now protected.
protected void	ObjectReference.setParent(EntityReference parent)	Entity reference are immutable since 3.3M2, so this method is now protected.
protected void	PageAttachmentReference.setParent(EntityReference parent)	Entity reference are immutable since 3.3M2, so this method is now protected.
protected void	PageClassPropertyReference.setParent(EntityReference parent)	Entity reference are immutable since 3.3M2, so this method is now protected.
protected void	PageObjectPropertyReference.setParent(EntityReference parent)	Entity reference are immutable since 3.3M2, so this method is now protected.
protected void	PageObjectReference.setParent(EntityReference parent)	Entity reference are immutable since 3.3M2, so this method is now protected.
protected void	PageReference.setParent(EntityReference parent)	Entity reference are immutable since 3.3M2, so this method is now protected.
protected void	SpaceReference.setParent(EntityReference parent)	Entity reference are immutable since 3.3M2, so this method is now protected.
protected void	WikiReference.setParent(EntityReference parent)	Entity reference are immutable since 3.3M2, so this method is now protected.

Constructors in org.xwiki.model.reference with parameters of type EntityReference

Constructor	Description
AbstractLocalizedEntityReference(String name, EntityType type, EntityReference parent)	Create a new EntityReference.
AbstractLocalizedEntityReference(String name, EntityType type, EntityReference parent, Locale locale)
AbstractLocalizedEntityReference(String name, EntityType type, EntityReference parent, Map<String,Serializable> parameters)	Create a new EntityReference.
AbstractLocalizedEntityReference(EntityReference reference)	Clone an EntityReference.
AbstractLocalizedEntityReference(EntityReference reference, Locale locale)	Clone an EntityReference and change/add the passed Locale.
AbstractLocalizedEntityReference(EntityReference reference, EntityReference parent)	Clone an AbstractLocalizedEntityReference, but use the specified parent for its new parent.
AbstractLocalizedEntityReference(EntityReference reference, EntityReference oldReference, EntityReference newReference)	Clone an EntityReference, but replace one of the parent in the chain by an other one.
AttachmentReference(EntityReference reference)	Special constructor that transforms a generic entity reference into an AttachmentReference.
AttachmentReference(EntityReference reference, EntityReference parent)	Clone an AttachmentReference, but use the specified parent for its new parent.
AttachmentReference(EntityReference reference, EntityReference oldReference, EntityReference newReference)	Clone an AttachmentReference, but replace one of the parent in the chain by a new one.
BlockReference(EntityReference reference)	Constructor which would raise exceptions if the source entity reference does not have the appropriate type or parent, etc.
BlockReference(EntityReference reference, EntityReference parent)	Clone an BlockReference, but use the specified parent for its new parent.
BlockReference(EntityReference reference, EntityReference oldReference, EntityReference newReference)	Clone an BlockReference, but replace one of the parent in the chain by a new one.
ClassPropertyReference(EntityReference reference)	Constructor which would raise exceptions if the source entity reference does not have the appropriate type or parent, etc.
ClassPropertyReference(EntityReference reference, EntityReference parent)	Clone an ClassPropertyReference, but use the specified parent for its new parent.
ClassPropertyReference(EntityReference reference, EntityReference oldReference, EntityReference newReference)	Clone an ClassPropertyReference, but replace one of the parent in the chain by a new one.
DocumentReference(String pageName, EntityReference parent, Map<String,Serializable> parameters)
DocumentReference(EntityReference reference)	Special constructor that transforms a generic entity reference into a DocumentReference.
DocumentReference(EntityReference reference, Locale locale)	Clone the provided reference and change the Locale.
DocumentReference(EntityReference reference, EntityReference parent)	Clone an DocumentReference, but use the specified parent for its new parent.
DocumentReference(EntityReference reference, EntityReference oldReference, EntityReference newReference)	Clone an DocumentReference, but replace one of the parent in the chain by a new one.
EntityReference(String name, EntityType type, EntityReference parent)	Create a new EntityReference.
EntityReference(String name, EntityType type, EntityReference parent, Map<String,Serializable> parameters)	Create a new EntityReference.
EntityReference(EntityReference reference)	Clone an EntityReference.
EntityReference(EntityReference reference, Map<String,Serializable> parameters)	Clone an EntityReference, but use the specified paramaters.
EntityReference(EntityReference reference, EntityReference parent)	Clone an EntityReference, but use the specified parent for its new parent.
EntityReference(EntityReference reference, EntityReference oldReference, EntityReference newReference)	Clone an EntityReference, but replace one of the parent in the chain by an other one.
EntityReferenceTree(Comparator<String> comparator, EntityReference... references)
EntityReferenceTree(EntityReference... references)
LocalDocumentReference(String pageName, EntityReference spaceReference)	Create a new Document reference in the current wiki.
LocalDocumentReference(EntityReference reference)
LocalDocumentReference(EntityReference entityReference, Locale locale)
LocalDocumentReference(EntityReference reference, EntityReference parent)	Clone an LocalDocumentReference, but use the specified parent for its new parent.
LocalPageReference(String pageName, EntityReference pageReference)	Create a new Page reference in the current wiki.
LocalPageReference(EntityReference reference)
LocalPageReference(EntityReference entityReference, Locale locale)
LocalPageReference(EntityReference reference, EntityReference parent)	Clone an DocumentVersionReference, but use the specified parent for its new parent.
ObjectPropertyReference(EntityReference reference)	Constructor which would raise exceptions if the source entity reference does not have the appropriate type or parent, etc.
ObjectPropertyReference(EntityReference reference, EntityReference parent)	Clone an ObjectPropertyReference, but use the specified parent for its new parent.
ObjectPropertyReference(EntityReference reference, EntityReference oldReference, EntityReference newReference)	Clone an ObjectPropertyReference, but replace one of the parent in the chain by a new one.
ObjectReference(EntityReference reference)	Constructor which would raise exceptions if the source entity reference does not have the appropriate type or parent, etc.
ObjectReference(EntityReference reference, EntityReference parent)	Clone an ObjectReference, but use the specified parent for its new parent.
ObjectReference(EntityReference reference, EntityReference oldReference, EntityReference newReference)	Clone an ObjectReference, but replace one of the parent in the chain by a new one.
PageAttachmentReference(EntityReference reference)	Special constructor that transforms a generic entity reference into an PageAttachmentReference.
PageAttachmentReference(EntityReference reference, EntityReference parent)	Clone an PageAttachmentReference, but use the specified parent for its new parent.
PageAttachmentReference(EntityReference reference, EntityReference oldReference, EntityReference newReference)	Clone an AttachmentReference, but replace one of the parent in the chain by a new one.
PageClassPropertyReference(EntityReference reference)	Constructor which would raise exceptions if the source entity reference does not have the appropriate type or parent, etc.
PageClassPropertyReference(EntityReference reference, EntityReference parent)	Clone an PageClassPropertyReference, but use the specified parent for its new parent.
PageClassPropertyReference(EntityReference reference, EntityReference oldReference, EntityReference newReference)	Clone an ClassPropertyReference, but replace one of the parent in the chain by a new one.
PageObjectPropertyReference(EntityReference reference)	Constructor which would raise exceptions if the source entity reference does not have the appropriate type or parent, etc.
PageObjectPropertyReference(EntityReference reference, EntityReference parent)	Clone an PageObjectPropertyReference, but use the specified parent for its new parent.
PageObjectPropertyReference(EntityReference reference, EntityReference oldReference, EntityReference newReference)	Clone an ObjectPropertyReference, but replace one of the parent in the chain by a new one.
PageObjectReference(EntityReference reference)	Constructor which would raise exceptions if the source entity reference does not have the appropriate type or parent, etc.
PageObjectReference(EntityReference reference, EntityReference parent)	Clone an PageObjectReference, but use the specified parent for its new parent.
PageObjectReference(EntityReference reference, EntityReference oldReference, EntityReference newReference)	Clone an ObjectReference, but replace one of the parent in the chain by a new one.
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(EntityReference reference)	Special constructor that transforms a generic entity reference into a PageReference.
PageReference(EntityReference reference, Locale locale)	Clone an EntityReference and change/add the passed Locale.
PageReference(EntityReference reference, EntityReference parent)	Clone an PageReference, but use the specified parent for its new parent.
PageReference(EntityReference reference, EntityReference oldReference, EntityReference newReference)	Clone a page reference, but replace one of the parent in the chain by a new one.
PartialEntityReference(String name, EntityType type, EntityReference parent)	Create a new EntityReference.
RegexEntityReference(Pattern pattern, EntityType type, EntityReference parent)
SpaceReference(String spaceName, EntityReference parent)	Create a space reference based on a space name and a parent entity reference.
SpaceReference(EntityReference reference)	Special constructor that transforms a generic entity reference into a SpaceReference.
SpaceReference(EntityReference reference, EntityReference parent)	Clone an SpaceReference, but use the specified parent for its new parent.
SpaceReference(EntityReference reference, EntityReference oldReference, EntityReference newReference)	Clone an SpaceReference, but replace one of the parent in the chain by a new one.
WikiReference(EntityReference reference)	Special constructor that transforms a generic entity reference into a WikiReference.

Constructor parameters in org.xwiki.model.reference with type arguments of type EntityReference

Constructor	Description
EntityReferenceTree(Iterable<? extends EntityReference> references)
EntityReferenceTree(Comparator<String> comparator, Iterable<? extends EntityReference> references)

Uses of EntityReference in org.xwiki.model.script

Methods in org.xwiki.model.script that return EntityReference

Modifier and Type	Method	Description
EntityReference	ModelScriptService.createEntityReference(String name, EntityType type)	Creates any EntityReference from a string.
EntityReference	ModelScriptService.createEntityReference(String name, EntityType type, EntityReference parent)	Creates any EntityReference from a string.
EntityReference	ModelScriptService.getEntityReference(EntityType type)	Get the current reference configured for a specific entity type, like the space reference or wiki reference.
EntityReference	ModelScriptService.getEntityReference(EntityType type, String hint)	Get the reference configured for a specific entity type, like the space reference or wiki reference.

Methods in org.xwiki.model.script with parameters of type EntityReference

Modifier and Type	Method	Description
EntityReference	ModelScriptService.createEntityReference(String name, EntityType type, EntityReference parent)	Creates any EntityReference from a string.
String	ModelScriptService.serialize(EntityReference reference, Object... parameters)
String	ModelScriptService.serialize(EntityReference reference, String hint, Object... parameters)
EntityReferenceTree	ModelScriptService.toTree(EntityReference... references)	Convert passed references to a tree of references.

Method parameters in org.xwiki.model.script with type arguments of type EntityReference

Modifier and Type	Method	Description
EntityReferenceTree	ModelScriptService.toTree(Iterable<? extends EntityReference> references)	Convert passed references to a tree of references.