A C D E G H I L M O P R S T V W

A

appendParent(EntityReference) - Method in class org.xwiki.model.reference.EntityReference

Return a clone of this reference with a parent appended at the root of its parents chain.

AttachmentReference - Class in org.xwiki.model.reference

Represents a reference to an Attachment (document reference and file name).

AttachmentReference(EntityReference) - Constructor for class org.xwiki.model.reference.AttachmentReference

Special constructor that transforms a generic entity reference into an AttachmentReference.

AttachmentReference(EntityReference, EntityReference, EntityReference) - Constructor for class org.xwiki.model.reference.AttachmentReference

Clone an AttachmentReference, but replace one of the parent in the chain by a new one.

AttachmentReference(String, DocumentReference) - Constructor for class org.xwiki.model.reference.AttachmentReference

Create a new attachment reference based on the attachment name and the parent document reference.

AttachmentReferenceResolver<T> - Interface in org.xwiki.model.reference

Resolve an Attachment reference defined in a given representation into a validated AttachmentReference object, ie with valid values and a valid hierarchy (eg an Attachment reference must have a parent which is a document reference, reference values must not be null, etc).

C

ClassPropertyReference - Class in org.xwiki.model.reference

References a property in a class in a document (the description of the property).

ClassPropertyReference(EntityReference) - Constructor for class org.xwiki.model.reference.ClassPropertyReference

Constructor which would raise exceptions if the source entity reference does not have the appropriate type or parent, etc.

ClassPropertyReference(EntityReference, EntityReference, EntityReference) - Constructor for class org.xwiki.model.reference.ClassPropertyReference

Clone an ClassPropertyReference, but replace one of the parent in the chain by a new one.

ClassPropertyReference(String, DocumentReference) - Constructor for class org.xwiki.model.reference.ClassPropertyReference

Builds a property reference for the passed property in the passed object.

ClassPropertyReference(String, String, String, String) - Constructor for class org.xwiki.model.reference.ClassPropertyReference

Deprecated.

compareTo(EntityReference) - Method in class org.xwiki.model.reference.EntityReference

D

DocumentReference - Class in org.xwiki.model.reference

Represents a reference to a document (wiki, space and page names).

DocumentReference(EntityReference) - Constructor for class org.xwiki.model.reference.DocumentReference

Special constructor that transforms a generic entity reference into a DocumentReference.

DocumentReference(EntityReference, EntityReference, EntityReference) - Constructor for class org.xwiki.model.reference.DocumentReference

Clone an DocumentReference, but replace one of the parent in the chain by a new one.

DocumentReference(EntityReference, Locale) - Constructor for class org.xwiki.model.reference.DocumentReference

Clone the provided reference and change the Locale.

DocumentReference(String, String, String) - Constructor for class org.xwiki.model.reference.DocumentReference

Create a new Document reference from wiki, space and page name.

DocumentReference(String, String, String, Locale) - Constructor for class org.xwiki.model.reference.DocumentReference

Create a new Document reference from wiki name, space name, page name and locale.

DocumentReference(String, String, String, String) - Constructor for class org.xwiki.model.reference.DocumentReference

Create a new Document reference from wiki name, space name, page name and language.

DocumentReference(String, List<String>, String) - Constructor for class org.xwiki.model.reference.DocumentReference

Create a new Document reference from wiki name, spaces names and page name.

DocumentReference(String, List<String>, String, Locale) - Constructor for class org.xwiki.model.reference.DocumentReference

Create a new Document reference from wiki name, spaces names, page name and locale.

DocumentReference(String, SpaceReference) - Constructor for class org.xwiki.model.reference.DocumentReference

Create a new Document reference from document name and parent space.

DocumentReference(LocalDocumentReference, WikiReference) - Constructor for class org.xwiki.model.reference.DocumentReference

Create a new Document reference from local document reference and wiki reference.

DocumentReference(String, SpaceReference, Locale) - Constructor for class org.xwiki.model.reference.DocumentReference

Create a new Document reference from document name, parent space and locale.

DocumentReferenceResolver<T> - Interface in org.xwiki.model.reference

Resolve a Document reference defined in a given representation into a validated DocumentReference object, ie with valid values and a valid hierarchy (eg a Document reference must have a parent which is a space reference, reference values must not be null, etc).

E

EntityReference - Class in org.xwiki.model.reference

Represents a reference to an Entity (Document, Attachment, Space, Wiki, etc).

EntityReference(EntityReference) - Constructor for class org.xwiki.model.reference.EntityReference

Clone an EntityReference.

EntityReference(EntityReference, EntityReference) - Constructor for class org.xwiki.model.reference.EntityReference

Clone an EntityReference, but use the specified parent for its new parent.

EntityReference(EntityReference, EntityReference, EntityReference) - Constructor for class org.xwiki.model.reference.EntityReference

Clone an EntityReference, but replace one of the parent in the chain by an other one.

EntityReference(String, EntityType) - Constructor for class org.xwiki.model.reference.EntityReference

Create a new root EntityReference.

EntityReference(String, EntityType, EntityReference) - Constructor for class org.xwiki.model.reference.EntityReference

Create a new EntityReference.

EntityReference(String, EntityType, EntityReference, Map<String, Serializable>) - Constructor for class org.xwiki.model.reference.EntityReference

Create a new EntityReference.

EntityReferenceResolver<T> - Interface in org.xwiki.model.reference

Resolve an Entity reference defined in a given representation into a validated EntityReference object, ie with valid values and a valid hierarchy (eg a Document reference must have a parent which is a space reference, reference values must not be null, etc).

EntityReferenceSerializer<T> - Interface in org.xwiki.model.reference

Generate a different representation of an Entity Reference (eg as a String).

EntityReferenceSet - Class in org.xwiki.model.reference

A set of entities references.

EntityReferenceSet() - Constructor for class org.xwiki.model.reference.EntityReferenceSet

EntityReferenceValueProvider - Interface in org.xwiki.model.reference

Return default values for specified Entity Reference types.

EntityType - Enum in org.xwiki.model

Represents a type of entity (ie a Model Object such as a Wiki, a Space, a Document, an Attachment, etc).

equals(Object) - Method in class org.xwiki.model.reference.EntityReference

equals(Object) - Method in class org.xwiki.model.reference.PartialEntityReference

excludes(EntityReference) - Method in class org.xwiki.model.reference.EntityReferenceSet

extractReference(EntityType) - Method in class org.xwiki.model.reference.EntityReference

Extract the entity of the given type from this one.

G

getCurrentEntityReference() - Method in interface org.xwiki.model.ModelContext

getDefaultReferenceValue(EntityType) - Method in interface org.xwiki.model.ModelConfiguration

getDefaultValue(EntityType) - Method in interface org.xwiki.model.reference.EntityReferenceValueProvider

getDocumentReference() - Method in class org.xwiki.model.reference.AttachmentReference

getLastSpaceReference() - Method in class org.xwiki.model.reference.DocumentReference

getLocale() - Method in class org.xwiki.model.reference.DocumentReference

getName() - Method in class org.xwiki.model.reference.EntityReference

Returns the name of this entity.

getParameter(String) - Method in class org.xwiki.model.reference.EntityReference

Get the value of a parameter.

getParent() - Method in class org.xwiki.model.reference.EntityReference

getPattern() - Method in class org.xwiki.model.reference.RegexEntityReference

getReversedReferenceChain() - Method in class org.xwiki.model.reference.EntityReference

getRoot() - Method in class org.xwiki.model.reference.EntityReference

getSpaceReferences() - Method in class org.xwiki.model.reference.DocumentReference

getType() - Method in class org.xwiki.model.reference.EntityReference

Returns the type of this entity.

getWikiReference() - Method in class org.xwiki.model.reference.DocumentReference

H

hashCode() - Method in class org.xwiki.model.reference.EntityReference

hashCode() - Method in class org.xwiki.model.reference.PartialEntityReference

I

includes(EntityReference) - Method in class org.xwiki.model.reference.EntityReferenceSet

InvalidEntityReferenceException - Exception in org.xwiki.model.reference

Thrown when an Entity Reference isn't valid.

InvalidEntityReferenceException() - Constructor for exception org.xwiki.model.reference.InvalidEntityReferenceException

Create a new invalid entity reference exception.

InvalidEntityReferenceException(String) - Constructor for exception org.xwiki.model.reference.InvalidEntityReferenceException

Create a new invalid entity reference exception with a message.

InvalidEntityReferenceException(String, Throwable) - Constructor for exception org.xwiki.model.reference.InvalidEntityReferenceException

Create a new invalid entity reference exception with a message and a cause.

InvalidEntityReferenceException(Throwable) - Constructor for exception org.xwiki.model.reference.InvalidEntityReferenceException

Create a new invalid entity reference exception with a cause.

isNameEqual(String) - Method in class org.xwiki.model.reference.PartialEntityReference

isNameEqual(String) - Method in class org.xwiki.model.reference.RegexEntityReference

L

LocalDocumentReference - Class in org.xwiki.model.reference

Represents a reference to a document in the current wiki.

LocalDocumentReference(String, String) - Constructor for class org.xwiki.model.reference.LocalDocumentReference

Create a new Document reference in the current wiki.

LocalDocumentReference(DocumentReference) - Constructor for class org.xwiki.model.reference.LocalDocumentReference

M

matches(EntityReference) - Method in class org.xwiki.model.reference.EntityReferenceSet

ModelConfiguration - Interface in org.xwiki.model

Provides configuration options for the Model module.

ModelContext - Interface in org.xwiki.model

Allows accessing Model Objects for current objects (current document, current wiki, current space, etc) placed in the Execution Context.

O

ObjectPropertyReference - Class in org.xwiki.model.reference

References a property in an object in a document (the value of the property).

ObjectPropertyReference(EntityReference) - Constructor for class org.xwiki.model.reference.ObjectPropertyReference

Constructor which would raise exceptions if the source entity reference does not have the appropriate type or parent, etc.

ObjectPropertyReference(EntityReference, EntityReference, EntityReference) - Constructor for class org.xwiki.model.reference.ObjectPropertyReference

Clone an ObjectPropertyReference, but replace one of the parent in the chain by a new one.

ObjectPropertyReference(String, ObjectReference) - Constructor for class org.xwiki.model.reference.ObjectPropertyReference

Builds a property reference for the passed property in the passed object.

ObjectPropertyReference(String, String, String, String, String) - Constructor for class org.xwiki.model.reference.ObjectPropertyReference

Deprecated.

ObjectPropertyReferenceResolver<T> - Interface in org.xwiki.model.reference

Resolve a Property reference defined in a given representation into a validated ObjectPropertyReference object, i.e.

ObjectReference - Class in org.xwiki.model.reference

Reference to an object in a document (by classname and index, document, space, wiki).

ObjectReference(EntityReference) - Constructor for class org.xwiki.model.reference.ObjectReference

Constructor which would raise exceptions if the source entity reference does not have the appropriate type or parent, etc.

ObjectReference(EntityReference, EntityReference, EntityReference) - Constructor for class org.xwiki.model.reference.ObjectReference

Clone an ObjectReference, but replace one of the parent in the chain by a new one.

ObjectReference(String, DocumentReference) - Constructor for class org.xwiki.model.reference.ObjectReference

ObjectReference(String, String, String, String) - Constructor for class org.xwiki.model.reference.ObjectReference

Deprecated.

ObjectReferenceResolver<T> - Interface in org.xwiki.model.reference

Resolve an Object reference defined in a given representation into a validated ObjectReference object, i.e.

org.xwiki.model - package org.xwiki.model

org.xwiki.model.reference - package org.xwiki.model.reference

P

PartialEntityReference - Class in org.xwiki.model.reference

An EntityReference used to match another one.

PartialEntityReference(String, EntityType) - Constructor for class org.xwiki.model.reference.PartialEntityReference

Create a new root EntityReference.

PartialEntityReference(String, EntityType, EntityReference) - Constructor for class org.xwiki.model.reference.PartialEntityReference

Create a new EntityReference.

R

RegexEntityReference - Class in org.xwiki.model.reference

An EntityReference used to match another one.

RegexEntityReference(Pattern, EntityType) - Constructor for class org.xwiki.model.reference.RegexEntityReference

RegexEntityReference(Pattern, EntityType, EntityReference) - Constructor for class org.xwiki.model.reference.RegexEntityReference

removeParent(EntityReference) - Method in class org.xwiki.model.reference.EntityReference

Return a clone of this reference truncated to a null parent when it reach the given parent.

replaceParent(EntityReference, EntityReference) - Method in class org.xwiki.model.reference.AttachmentReference

replaceParent(EntityReference, EntityReference) - Method in class org.xwiki.model.reference.ClassPropertyReference

replaceParent(EntityReference, EntityReference) - Method in class org.xwiki.model.reference.DocumentReference

replaceParent(EntityReference, EntityReference) - Method in class org.xwiki.model.reference.EntityReference

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

replaceParent(EntityReference, EntityReference) - Method in class org.xwiki.model.reference.ObjectPropertyReference

replaceParent(EntityReference, EntityReference) - Method in class org.xwiki.model.reference.ObjectReference

replaceParent(EntityReference, EntityReference) - Method in class org.xwiki.model.reference.SpaceReference

resolve(T, Object...) - Method in interface org.xwiki.model.reference.AttachmentReferenceResolver

resolve(T, Object...) - Method in interface org.xwiki.model.reference.DocumentReferenceResolver

resolve(T, EntityType, Object...) - Method in interface org.xwiki.model.reference.EntityReferenceResolver

resolve(T) - Method in interface org.xwiki.model.reference.ObjectPropertyReferenceResolver

Deprecated.

resolve(T, Object...) - Method in interface org.xwiki.model.reference.ObjectPropertyReferenceResolver

resolve(T) - Method in interface org.xwiki.model.reference.ObjectReferenceResolver

Deprecated.

resolve(T, Object...) - Method in interface org.xwiki.model.reference.ObjectReferenceResolver

S

serialize(EntityReference, Object...) - Method in interface org.xwiki.model.reference.EntityReferenceSerializer

Serialize an entity reference into a new representation of type .

setCurrentEntityReference(EntityReference) - Method in interface org.xwiki.model.ModelContext

setLocale(Locale) - Method in class org.xwiki.model.reference.DocumentReference

Set the locale of this document reference.

setName(String) - Method in class org.xwiki.model.reference.EntityReference

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

setParameter(String, Serializable) - Method in class org.xwiki.model.reference.EntityReference

Add or set a parameter value.

setParameters(Map<String, Serializable>) - Method in class org.xwiki.model.reference.EntityReference

Set multiple parameters at once.

setParent(EntityReference) - Method in class org.xwiki.model.reference.AttachmentReference

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

setParent(EntityReference) - Method in class org.xwiki.model.reference.ClassPropertyReference

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

setParent(EntityReference) - Method in class org.xwiki.model.reference.DocumentReference

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

setParent(EntityReference) - Method in class org.xwiki.model.reference.EntityReference

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

setParent(EntityReference) - Method in class org.xwiki.model.reference.ObjectPropertyReference

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

setParent(EntityReference) - Method in class org.xwiki.model.reference.ObjectReference

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

setParent(EntityReference) - Method in class org.xwiki.model.reference.SpaceReference

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

setParent(EntityReference) - Method in class org.xwiki.model.reference.WikiReference

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

setType(EntityType) - Method in class org.xwiki.model.reference.AttachmentReference

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

setType(EntityType) - Method in class org.xwiki.model.reference.ClassPropertyReference

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

setType(EntityType) - Method in class org.xwiki.model.reference.DocumentReference

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

setType(EntityType) - Method in class org.xwiki.model.reference.EntityReference

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

setType(EntityType) - Method in class org.xwiki.model.reference.ObjectPropertyReference

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

setType(EntityType) - Method in class org.xwiki.model.reference.ObjectReference

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

setType(EntityType) - Method in class org.xwiki.model.reference.SpaceReference

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

setType(EntityType) - Method in class org.xwiki.model.reference.WikiReference

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

SpaceReference - Class in org.xwiki.model.reference

Represents a reference to a space (space name).

SpaceReference(EntityReference) - Constructor for class org.xwiki.model.reference.SpaceReference

Special constructor that transforms a generic entity reference into a SpaceReference.

SpaceReference(EntityReference, EntityReference, EntityReference) - Constructor for class org.xwiki.model.reference.SpaceReference

Clone an SpaceReference, but replace one of the parent in the chain by a new one.

SpaceReference(String, WikiReference) - Constructor for class org.xwiki.model.reference.SpaceReference

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

SpaceReference(String, SpaceReference) - Constructor for class org.xwiki.model.reference.SpaceReference

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

SpaceReference(String, EntityReference) - Constructor for class org.xwiki.model.reference.SpaceReference

Create a space reference based on a space name and a parent entity reference.

T

toString() - Method in class org.xwiki.model.reference.DocumentReference

toString() - Method in class org.xwiki.model.reference.EntityReference

TOSTRING_SERIALIZER - Static variable in class org.xwiki.model.reference.EntityReference

Used to provide a nice and readable pretty name for the EntityReference.toString() method.

TYPE_REFERENCE - Static variable in interface org.xwiki.model.reference.AttachmentReferenceResolver

Type instance for EntityReferenceResolver.

TYPE_REFERENCE - Static variable in interface org.xwiki.model.reference.DocumentReferenceResolver

Type instance for EntityReferenceResolver.

TYPE_REFERENCE - Static variable in interface org.xwiki.model.reference.EntityReferenceResolver

Type instance for EntityReferenceResolver.

TYPE_REFERENCE - Static variable in interface org.xwiki.model.reference.EntityReferenceSerializer

Type instance for EntityReferenceResolver.

TYPE_REFERENCE - Static variable in interface org.xwiki.model.reference.ObjectPropertyReferenceResolver

Type instance for EntityReferenceResolver.

TYPE_REFERENCE - Static variable in interface org.xwiki.model.reference.ObjectReferenceResolver

Type instance for EntityReferenceResolver.

TYPE_STRING - Static variable in interface org.xwiki.model.reference.AttachmentReferenceResolver

Type instance for EntityReferenceResolver.

TYPE_STRING - Static variable in interface org.xwiki.model.reference.DocumentReferenceResolver

Type instance for EntityReferenceResolver.

TYPE_STRING - Static variable in interface org.xwiki.model.reference.EntityReferenceResolver

Type instance for EntityReferenceResolver.

TYPE_STRING - Static variable in interface org.xwiki.model.reference.EntityReferenceSerializer

Type instance for EntityReferenceResolver.

TYPE_STRING - Static variable in interface org.xwiki.model.reference.ObjectPropertyReferenceResolver

Type instance for EntityReferenceResolver.

TYPE_STRING - Static variable in interface org.xwiki.model.reference.ObjectReferenceResolver

Type instance for EntityReferenceResolver.

V

valueOf(String) - Static method in enum org.xwiki.model.EntityType

Returns the enum constant of this type with the specified name.

values() - Static method in enum org.xwiki.model.EntityType

Returns an array containing the constants of this enum type, in the order they are declared.

W

WikiReference - Class in org.xwiki.model.reference

Represents a reference to a wiki (wiki name).

WikiReference(EntityReference) - Constructor for class org.xwiki.model.reference.WikiReference

Special constructor that transforms a generic entity reference into a WikiReference.

WikiReference(String) - Constructor for class org.xwiki.model.reference.WikiReference

A C D E G H I L M O P R S T V W