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

A

AbstractReferenceEntityReferenceResolver - Class in org.xwiki.model.internal.reference

Resolve an EntityReference into a valid and absolute reference (with all required parents filled in).

AbstractReferenceEntityReferenceResolver() - Constructor for class org.xwiki.model.internal.reference.AbstractReferenceEntityReferenceResolver

AbstractStringEntityReferenceResolver - Class in org.xwiki.model.internal.reference

Generic implementation deferring default values for unspecified reference parts to extending classes.

AbstractStringEntityReferenceResolver() - Constructor for class org.xwiki.model.internal.reference.AbstractStringEntityReferenceResolver

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(String, DocumentReference) - Constructor for class org.xwiki.model.reference.AttachmentReference

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(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

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

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

createAttachmentReference(DocumentReference, String) - Method in class org.xwiki.model.internal.scripting.ModelScriptService

Creates an AttachmentReference from a file name and a reference to the document holding that file.

createDocumentReference(String, String, String) - Method in class org.xwiki.model.internal.scripting.ModelScriptService

Create a Document Reference from a passed wiki, space and page names, which can be empty strings or null in which case they are resolved using a "currentmixed/reference" resolver.

createDocumentReference(String, String, String, String) - Method in class org.xwiki.model.internal.scripting.ModelScriptService

Create a Document Reference from a passed wiki, space and page names, which can be empty strings or null in which case they are resolved against the Resolver having the hint passed as parameter.

D

DefaultEntityReferenceValueProvider - Class in org.xwiki.model.internal.reference

Uses the Entity Reference values defined in the Model Configuration.

DefaultEntityReferenceValueProvider() - Constructor for class org.xwiki.model.internal.reference.DefaultEntityReferenceValueProvider

DefaultModelConfiguration - Class in org.xwiki.model.internal

Get configuration data from the XWiki configuration using a ConfigurationSource.

DefaultModelConfiguration() - Constructor for class org.xwiki.model.internal.DefaultModelConfiguration

DefaultModelContext - Class in org.xwiki.model.internal

Default implementation bridging to the old XWiki Context to get current Model Reference Objects.

DefaultModelContext() - Constructor for class org.xwiki.model.internal.DefaultModelContext

DefaultReferenceDocumentReferenceResolver - Class in org.xwiki.model.internal.reference

Specialized version of EntityReferenceResolver which can be considered a helper component to resolve DocumentReference objects from Entity Reference (when they miss some parent references or have NULL values).

DefaultReferenceDocumentReferenceResolver() - Constructor for class org.xwiki.model.internal.reference.DefaultReferenceDocumentReferenceResolver

DefaultReferenceEntityReferenceResolver - Class in org.xwiki.model.internal.reference

Resolve an EntityReference into a valid and absolute reference (with all required parents filled in).

DefaultReferenceEntityReferenceResolver() - Constructor for class org.xwiki.model.internal.reference.DefaultReferenceEntityReferenceResolver

DefaultStringAttachmentReferenceResolver - Class in org.xwiki.model.internal.reference

Specialized version of EntityReferenceResolver which can be considered a helper component to resolve AttachmentReference objects from their string representation.

DefaultStringAttachmentReferenceResolver() - Constructor for class org.xwiki.model.internal.reference.DefaultStringAttachmentReferenceResolver

DefaultStringDocumentReferenceResolver - Class in org.xwiki.model.internal.reference

Specialized version of EntityReferenceResolver which can be considered a helper component to resolve DocumentReference objects from their string representation.

DefaultStringDocumentReferenceResolver() - Constructor for class org.xwiki.model.internal.reference.DefaultStringDocumentReferenceResolver

DefaultStringEntityReferenceResolver - Class in org.xwiki.model.internal.reference

Generic implementation that resolve EntityReference objects from their string representation.

DefaultStringEntityReferenceResolver() - Constructor for class org.xwiki.model.internal.reference.DefaultStringEntityReferenceResolver

DefaultStringEntityReferenceSerializer - Class in org.xwiki.model.internal.reference

Generate a string representation of an entity reference (eg "wiki:space.page" for a document reference in the "wiki" Wiki, the "space" Space and the "page" Page).

DefaultStringEntityReferenceSerializer() - Constructor for class org.xwiki.model.internal.reference.DefaultStringEntityReferenceSerializer

DefaultStringObjectPropertyReferenceResolver - Class in org.xwiki.model.internal.reference

Specialized version of EntityReferenceResolver which can be considered a helper component to resolve ObjectPropertyReference objects from their string representation.

DefaultStringObjectPropertyReferenceResolver() - Constructor for class org.xwiki.model.internal.reference.DefaultStringObjectPropertyReferenceResolver

DefaultStringObjectReferenceResolver - Class in org.xwiki.model.internal.reference

Specialized version of EntityReferenceResolver which can be considered a helper component to resolve ObjectReference objects from their string representation.

DefaultStringObjectReferenceResolver() - Constructor for class org.xwiki.model.internal.reference.DefaultStringObjectReferenceResolver

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(String, String, String) - Constructor for class org.xwiki.model.reference.DocumentReference

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

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

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(String, EntityType) - Constructor for class org.xwiki.model.reference.EntityReference

EntityReference(String, EntityType, EntityReference) - Constructor for class org.xwiki.model.reference.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).

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.RegexEntityReference

ExplicitReferenceDocumentReferenceResolver - Class in org.xwiki.model.internal.reference

Specialized version of EntityReferenceResolver which can be considered a helper component to resolve DocumentReference objects from their string representation.

ExplicitReferenceDocumentReferenceResolver() - Constructor for class org.xwiki.model.internal.reference.ExplicitReferenceDocumentReferenceResolver

ExplicitReferenceEntityReferenceResolver - Class in org.xwiki.model.internal.reference

Resolver that resolves a Reference passed as a String into an absolute reference.

ExplicitReferenceEntityReferenceResolver() - Constructor for class org.xwiki.model.internal.reference.ExplicitReferenceEntityReferenceResolver

ExplicitStringAttachmentReferenceResolver - Class in org.xwiki.model.internal.reference

Specialized version of EntityReferenceResolver which can be considered a helper component to resolve AttachmentReference objects from their string representation.

ExplicitStringAttachmentReferenceResolver() - Constructor for class org.xwiki.model.internal.reference.ExplicitStringAttachmentReferenceResolver

ExplicitStringDocumentReferenceResolver - Class in org.xwiki.model.internal.reference

Specialized version of EntityReferenceResolver which can be considered a helper component to resolve DocumentReference objects from their string representation.

ExplicitStringDocumentReferenceResolver() - Constructor for class org.xwiki.model.internal.reference.ExplicitStringDocumentReferenceResolver

ExplicitStringEntityReferenceResolver - Class in org.xwiki.model.internal.reference

Resolver that resolves a Reference passed as a String into an absolute reference.

ExplicitStringEntityReferenceResolver() - Constructor for class org.xwiki.model.internal.reference.ExplicitStringEntityReferenceResolver

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

G

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

getCurrentEntityReference() - Method in class org.xwiki.model.internal.DefaultModelContext

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

getDefaultReferenceValue(EntityType) - Method in class org.xwiki.model.internal.DefaultModelConfiguration

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

getDefaultValue(EntityType, Object...) - Method in class org.xwiki.model.internal.reference.AbstractReferenceEntityReferenceResolver

getDefaultValue(EntityType, Object...) - Method in class org.xwiki.model.internal.reference.AbstractStringEntityReferenceResolver

getDefaultValue(EntityType) - Method in class org.xwiki.model.internal.reference.DefaultEntityReferenceValueProvider

getDefaultValue(EntityType, Object...) - Method in class org.xwiki.model.internal.reference.DefaultReferenceEntityReferenceResolver

getDefaultValue(EntityType, Object...) - Method in class org.xwiki.model.internal.reference.DefaultStringEntityReferenceResolver

getDefaultValue(EntityType, Object...) - Method in class org.xwiki.model.internal.reference.ExplicitReferenceEntityReferenceResolver

Expects an EntityReference parameter from which to extract the default values.

getDefaultValue(EntityType, Object...) - Method in class org.xwiki.model.internal.reference.ExplicitStringEntityReferenceResolver

Expects an EntityReference parameter from which to extract the default values.

getDefaultValue(EntityType, Object...) - Method in class org.xwiki.model.internal.reference.RelativeStringEntityReferenceResolver

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

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

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

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

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

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

H

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

I

InvalidEntityReferenceException - Exception in org.xwiki.model.reference

Thrown when an Entity Reference isn't valid.

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

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

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

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

L

LocalReferenceEntityReferenceSerializer - Class in org.xwiki.model.internal.reference

Deprecated. DefaultStringEntityReferenceSerializer should be used instead

LocalReferenceEntityReferenceSerializer() - Constructor for class org.xwiki.model.internal.reference.LocalReferenceEntityReferenceSerializer

Deprecated.

LocalStringEntityReferenceSerializer - Class in org.xwiki.model.internal.reference

Deprecated. DefaultStringEntityReferenceSerializer should be used instead

LocalStringEntityReferenceSerializer() - Constructor for class org.xwiki.model.internal.reference.LocalStringEntityReferenceSerializer

Deprecated.

M

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.

ModelScriptService - Class in org.xwiki.model.internal.scripting

Provides Model-specific Scripting APIs.

ModelScriptService() - Constructor for class org.xwiki.model.internal.scripting.ModelScriptService

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(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

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(String, String, String, String) - Constructor for class org.xwiki.model.reference.ObjectReference

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

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.internal - package org.xwiki.model.internal

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

org.xwiki.model.internal.scripting - package org.xwiki.model.internal.scripting

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

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

RelativeStringEntityReferenceResolver - Class in org.xwiki.model.internal.reference

Resolve EntityReference objects from its string representations.

RelativeStringEntityReferenceResolver() - Constructor for class org.xwiki.model.internal.reference.RelativeStringEntityReferenceResolver

resolve(EntityReference, EntityType, Object...) - Method in class org.xwiki.model.internal.reference.AbstractReferenceEntityReferenceResolver

resolve(String, EntityType, Object...) - Method in class org.xwiki.model.internal.reference.AbstractStringEntityReferenceResolver

resolve(EntityReference, Object...) - Method in class org.xwiki.model.internal.reference.DefaultReferenceDocumentReferenceResolver

resolve(String, Object...) - Method in class org.xwiki.model.internal.reference.DefaultStringAttachmentReferenceResolver

resolve(String, Object...) - Method in class org.xwiki.model.internal.reference.DefaultStringDocumentReferenceResolver

resolve(String) - Method in class org.xwiki.model.internal.reference.DefaultStringObjectPropertyReferenceResolver

resolve(String) - Method in class org.xwiki.model.internal.reference.DefaultStringObjectReferenceResolver

resolve(EntityReference, Object...) - Method in class org.xwiki.model.internal.reference.ExplicitReferenceDocumentReferenceResolver

resolve(String, Object...) - Method in class org.xwiki.model.internal.reference.ExplicitStringAttachmentReferenceResolver

resolve(String, Object...) - Method in class org.xwiki.model.internal.reference.ExplicitStringDocumentReferenceResolver

resolve(String, EntityType, Object...) - Method in class org.xwiki.model.internal.reference.RelativeStringEntityReferenceResolver

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

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

resolveAttachment(String) - Method in class org.xwiki.model.internal.scripting.ModelScriptService

resolveAttachment(String, String, Object...) - Method in class org.xwiki.model.internal.scripting.ModelScriptService

resolveDocument(String) - Method in class org.xwiki.model.internal.scripting.ModelScriptService

resolveDocument(String, String, Object...) - Method in class org.xwiki.model.internal.scripting.ModelScriptService

S

serialize(EntityReference, Object...) - Method in class org.xwiki.model.internal.reference.DefaultStringEntityReferenceSerializer

serialize(EntityReference, Object...) - Method in class org.xwiki.model.internal.reference.LocalReferenceEntityReferenceSerializer

Deprecated.

serialize(EntityReference) - Method in class org.xwiki.model.internal.scripting.ModelScriptService

serialize(EntityReference, String) - Method in class org.xwiki.model.internal.scripting.ModelScriptService

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

serializeEntityReference(EntityReference, StringBuilder, boolean, Object...) - Method in class org.xwiki.model.internal.reference.DefaultStringEntityReferenceSerializer

Serialize a reference element.

serializeEntityReference(EntityReference, StringBuilder, boolean, Object...) - Method in class org.xwiki.model.internal.reference.LocalStringEntityReferenceSerializer

Deprecated. Serialize a reference element.

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

setCurrentEntityReference(EntityReference) - Method in class org.xwiki.model.internal.DefaultModelContext

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

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

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

Overridden in order to verify the validity of the passed parent

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

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

Overridden in order to verify the validity of the passed parent

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

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

Overridden to ensure that the parent of a property is always an object.

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

Overridden to ensure that the parent of an object is always a document.

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

Overridden in order to verify the validity of the passed parent

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

Overridden in order to verify the validity of the passed type

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

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

Overridden in order to verify the validity of the passed type

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

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

Overridden to check the type to be a property type.

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

Overridden to check the type to be an object type.

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

Overridden in order to verify the validity of the passed type

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

Overridden in order to verify the validity of the passed type

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

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(String, SpaceReference) - Constructor for class org.xwiki.model.reference.SpaceReference

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

T

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

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

X

XCONTEXT_KEY - Static variable in class org.xwiki.model.internal.DefaultModelContext

Key of the XWikiContext located in the ExecutionContext.

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