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

A

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

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

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

G

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

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

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

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.

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

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

S

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

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

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

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

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