A B C D E G H I L M O P R S T U V W
All Classes All Packages
All Classes All Packages
All Classes All Packages
A
- AbstractLocalizedEntityReference - Class in org.xwiki.model.reference
-
Represents an entity reference which contains a locale.
- AbstractLocalizedEntityReference(String, EntityType) - Constructor for class org.xwiki.model.reference.AbstractLocalizedEntityReference
-
Create a new EntityReference.
- AbstractLocalizedEntityReference(String, EntityType, Locale) - Constructor for class org.xwiki.model.reference.AbstractLocalizedEntityReference
-
Create a new EntityReference.
- AbstractLocalizedEntityReference(String, EntityType, EntityReference) - Constructor for class org.xwiki.model.reference.AbstractLocalizedEntityReference
-
Create a new EntityReference.
- AbstractLocalizedEntityReference(String, EntityType, EntityReference, Locale) - Constructor for class org.xwiki.model.reference.AbstractLocalizedEntityReference
- AbstractLocalizedEntityReference(String, EntityType, EntityReference, Map<String, Serializable>) - Constructor for class org.xwiki.model.reference.AbstractLocalizedEntityReference
-
Create a new EntityReference.
- AbstractLocalizedEntityReference(EntityReference) - Constructor for class org.xwiki.model.reference.AbstractLocalizedEntityReference
-
Clone an EntityReference.
- AbstractLocalizedEntityReference(EntityReference, Locale) - Constructor for class org.xwiki.model.reference.AbstractLocalizedEntityReference
-
Clone an EntityReference and change/add the passed Locale.
- AbstractLocalizedEntityReference(EntityReference, EntityReference) - Constructor for class org.xwiki.model.reference.AbstractLocalizedEntityReference
-
Clone an AbstractLocalizedEntityReference, but use the specified parent for its new parent.
- AbstractLocalizedEntityReference(EntityReference, EntityReference, EntityReference) - Constructor for class org.xwiki.model.reference.AbstractLocalizedEntityReference
-
Clone an EntityReference, but replace one of the parent in the chain by an other one.
- 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.
- ATTACHMENT - org.xwiki.model.EntityType
-
Represents an Attachment Entity.
- AttachmentReference - Class in org.xwiki.model.reference
-
Represents a reference to an Attachment (document reference and file name).
- 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.
- AttachmentReference(EntityReference) - Constructor for class org.xwiki.model.reference.AttachmentReference
-
Special constructor that transforms a generic entity reference into an
AttachmentReference
. - AttachmentReference(EntityReference, EntityReference) - Constructor for class org.xwiki.model.reference.AttachmentReference
-
Clone an AttachmentReference, but use the specified parent for its new parent.
- 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.
- AttachmentReferenceConverter - Class in org.xwiki.model.reference
-
Converter that converts a value into a
AttachmentReference
object. - AttachmentReferenceConverter() - Constructor for class org.xwiki.model.reference.AttachmentReferenceConverter
- 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).
B
- BLOCK - org.xwiki.model.EntityType
-
Represents a structured part of the content of a document or an object property.
- BlockReference - Class in org.xwiki.model.reference
-
Reference to a block, a structured part of the content of a document or an object property.
- BlockReference(String) - Constructor for class org.xwiki.model.reference.BlockReference
- BlockReference(String, DocumentReference) - Constructor for class org.xwiki.model.reference.BlockReference
- BlockReference(String, ObjectPropertyReference) - Constructor for class org.xwiki.model.reference.BlockReference
- BlockReference(EntityReference) - Constructor for class org.xwiki.model.reference.BlockReference
-
Constructor which would raise exceptions if the source entity reference does not have the appropriate type or parent, etc.
- BlockReference(EntityReference, EntityReference) - Constructor for class org.xwiki.model.reference.BlockReference
-
Clone an BlockReference, but use the specified parent for its new parent.
- BlockReference(EntityReference, EntityReference, EntityReference) - Constructor for class org.xwiki.model.reference.BlockReference
-
Clone an BlockReference, but replace one of the parent in the chain by a new one.
- BlockReferenceResolver<T> - Interface in org.xwiki.model.reference
-
Resolve a Block reference from the referenced instance or another representation into a validated
BlockReference
object.
C
- CLASS_PROPERTY - org.xwiki.model.EntityType
-
Represents a class property entity.
- ClassPropertyReference - Class in org.xwiki.model.reference
-
References a property in a class in a document (the description of the property).
- ClassPropertyReference(String, String, String, String) - Constructor for class org.xwiki.model.reference.ClassPropertyReference
-
Deprecated.
- ClassPropertyReference(String, DocumentReference) - Constructor for class org.xwiki.model.reference.ClassPropertyReference
-
Builds a property reference for the passed property in the passed object.
- 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) - Constructor for class org.xwiki.model.reference.ClassPropertyReference
-
Clone an ClassPropertyReference, but use the specified parent for its new parent.
- 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.
- compareTo(EntityReference) - Method in class org.xwiki.model.reference.EntityReference
- convertToString(AttachmentReference) - Method in class org.xwiki.model.reference.AttachmentReferenceConverter
- convertToType(Type, Object) - Method in class org.xwiki.model.reference.AttachmentReferenceConverter
- createAttachmentReference(DocumentReference, String) - Method in class org.xwiki.model.script.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.script.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 the "current" resolver. - createDocumentReference(String, String, String, String) - Method in class org.xwiki.model.script.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.
- createDocumentReference(String, List<String>, String) - Method in class org.xwiki.model.script.ModelScriptService
-
Create a Document Reference from a passed wiki, list of spaces and page names, which can be empty strings or
null
in which case they are resolved using the "current" resolver. - createDocumentReference(String, List<String>, String, String) - Method in class org.xwiki.model.script.ModelScriptService
-
Create a Document Reference from a passed wiki, list of spaces 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.
- createDocumentReference(String, SpaceReference) - Method in class org.xwiki.model.script.ModelScriptService
-
Creates a new
DocumentReference
from a given page name and the reference of the parent space. - createDocumentReference(DocumentReference, Locale) - Method in class org.xwiki.model.script.ModelScriptService
-
Create a new reference with the passed
Locale
. - createEntityReference(String, EntityType) - Method in class org.xwiki.model.script.ModelScriptService
-
Creates any
EntityReference
from a string. - createEntityReference(String, EntityType, EntityReference) - Method in class org.xwiki.model.script.ModelScriptService
-
Creates any
EntityReference
from a string. - createObjectPropertyReference(String, ObjectReference) - Method in class org.xwiki.model.script.ModelScriptService
-
Creates an
ObjectPropertyReference
from a property name and the reference of the object having that property. - createPageAttachmentReference(PageReference, String) - Method in class org.xwiki.model.script.ModelScriptService
-
Creates a
PageAttachmentReference
from a file name and a reference to the page holding that file. - createPageReference(String, String...) - Method in class org.xwiki.model.script.ModelScriptService
-
Create a Page Reference from a passed wiki and pages names, which can be empty strings or
null
in which case they are resolved using the "current" resolver. - createPageReference(String, List<String>, Locale) - Method in class org.xwiki.model.script.ModelScriptService
-
Create a Page Reference from a passed wiki, list of page names, which can be empty strings or
null
in which case they are resolved using the "current" resolver. - createPageReference(String, List<String>, Locale, String) - Method in class org.xwiki.model.script.ModelScriptService
-
Create a Page Reference from a passed wiki, list of pages names, which can be empty strings or null in which case they are resolved against the Resolver having the hint passed as parameter.
- createSpaceReference(String, SpaceReference) - Method in class org.xwiki.model.script.ModelScriptService
-
Creates a
SpaceReference
from a string representing the space name and the reference of the parent space. - createSpaceReference(String, WikiReference) - Method in class org.xwiki.model.script.ModelScriptService
-
Creates a
SpaceReference
from a string representing the space name. - createSpaceReference(List<String>, WikiReference) - Method in class org.xwiki.model.script.ModelScriptService
-
Creates a
SpaceReference
from a list of string representing the space name and the name of its parents. - createWikiReference(String) - Method in class org.xwiki.model.script.ModelScriptService
-
Creates a
WikiReference
from a string representing the wiki name.
D
- DOCUMENT - org.xwiki.model.EntityType
-
Represents a Document Entity.
- DocumentNamespace - Class in org.xwiki.model.namespace
-
Typed
Namespace
for documents. - DocumentNamespace(String) - Constructor for class org.xwiki.model.namespace.DocumentNamespace
- DocumentReference - Class in org.xwiki.model.reference
-
Represents a reference to a document (wiki, space and document names).
- 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, 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, 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, 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, EntityReference, Map<String, Serializable>) - Constructor for class org.xwiki.model.reference.DocumentReference
- DocumentReference(String, SpaceReference) - Constructor for class org.xwiki.model.reference.DocumentReference
-
Create a new Document reference from document name and parent space.
- DocumentReference(String, SpaceReference, Locale) - Constructor for class org.xwiki.model.reference.DocumentReference
-
Create a new Document reference from document name, parent space and locale.
- DocumentReference(EntityReference) - Constructor for class org.xwiki.model.reference.DocumentReference
-
Special constructor that transforms a generic entity reference into a
DocumentReference
. - DocumentReference(EntityReference, Locale) - Constructor for class org.xwiki.model.reference.DocumentReference
-
Clone the provided reference and change the Locale.
- DocumentReference(EntityReference, EntityReference) - Constructor for class org.xwiki.model.reference.DocumentReference
-
Clone an DocumentReference, but use the specified parent for its new parent.
- 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(LocalDocumentReference, WikiReference) - Constructor for class org.xwiki.model.reference.DocumentReference
-
Create a new Document reference from local document reference and wiki reference.
- 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). - DocumentVersionReference - Class in org.xwiki.model.reference
-
A reference to a document version.
- DocumentVersionReference(DocumentReference) - Constructor for class org.xwiki.model.reference.DocumentVersionReference
-
Cast a
DocumentReference
to aDocumentVersionReference
. - DocumentVersionReference(DocumentReference, Serializable) - Constructor for class org.xwiki.model.reference.DocumentVersionReference
-
Creates a new reference to the specified document version.
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
-
Create a new root EntityReference.
- EntityReference(String, EntityType, Map<String, Serializable>) - Constructor for class org.xwiki.model.reference.EntityReference
-
Create a new 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.
- EntityReference(EntityReference) - Constructor for class org.xwiki.model.reference.EntityReference
-
Clone an EntityReference.
- EntityReference(EntityReference, Map<String, Serializable>) - Constructor for class org.xwiki.model.reference.EntityReference
-
Clone an EntityReference, but use the specified paramaters.
- 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.
- EntityReferenceProvider - Interface in org.xwiki.model.reference
-
Return default values for specified Entity Reference types.
- 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
- EntityReferenceString - Interface in org.xwiki.model.reference
-
Represents a serialized
EntityReference
. - EntityReferenceTree - Class in org.xwiki.model.reference
-
Expose a set of references as a tree.
- EntityReferenceTree(Iterable<? extends EntityReference>) - Constructor for class org.xwiki.model.reference.EntityReferenceTree
- EntityReferenceTree(Comparator<String>, Iterable<? extends EntityReference>) - Constructor for class org.xwiki.model.reference.EntityReferenceTree
- EntityReferenceTree(Comparator<String>, EntityReference...) - Constructor for class org.xwiki.model.reference.EntityReferenceTree
- EntityReferenceTree(EntityReference...) - Constructor for class org.xwiki.model.reference.EntityReferenceTree
- EntityReferenceTreeNode - Class in org.xwiki.model.reference
-
A node in a
EntityReferenceTree
. - EntityReferenceTreeNode(Comparator<String>) - Constructor for class org.xwiki.model.reference.EntityReferenceTreeNode
- EntityReferenceValueProvider - Interface in org.xwiki.model.reference
-
Deprecated.since 7.2M1, use
EntityReferenceProvider
instead - 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
- equals(EntityReference, EntityType) - Method in class org.xwiki.model.reference.EntityReference
-
Compared the two reference between the first reference and the last (including)
to
type of entity. - equals(EntityReference, EntityType, EntityType) - Method in class org.xwiki.model.reference.EntityReference
-
Compared the two reference between the first (including)
from
type of entity and the last (including)to
type of entity. - equalsNonRecursive(EntityReference) - Method in class org.xwiki.model.reference.EntityReference
-
Same as
EntityReference.equals(Object)
but only the first level of the references (ignore parents). - escape(String, EntityType) - Method in class org.xwiki.model.script.ModelScriptService
-
Escape the passed entity name according to reference syntax.
- excludes(EntityReference) - Method in class org.xwiki.model.reference.EntityReferenceSet
- extractFirstReference(EntityType) - Method in class org.xwiki.model.reference.EntityReference
-
Extract the first entity of the given type from this one by traversing the current entity to the root.
- extractReference(EntityType) - Method in class org.xwiki.model.reference.EntityReference
-
Extract the last entity of the given type from this one by traversing the current entity to the root.
G
- get(String) - Method in class org.xwiki.model.reference.EntityReferenceTreeNode
-
Return the first found direct child with passed name.
- get(EntityReference) - Method in class org.xwiki.model.reference.EntityReferenceTreeNode
- getAllowedParents() - Method in enum org.xwiki.model.EntityType
- getChildren() - Method in class org.xwiki.model.reference.EntityReferenceTreeNode
- getChildren(String) - Method in class org.xwiki.model.reference.EntityReferenceTreeNode
- getChildren(EntityType) - Method in class org.xwiki.model.reference.EntityReferenceTreeNode
- getChildrenInternal(String) - Method in class org.xwiki.model.reference.EntityReferenceTreeNode
- getCurrentEntityReference() - Method in interface org.xwiki.model.ModelContext
- getDefaultReference(EntityType) - Method in interface org.xwiki.model.reference.EntityReferenceProvider
- getDefaultReferenceValue(EntityType) - Method in interface org.xwiki.model.ModelConfiguration
- getDefaultValue(EntityType) - Method in interface org.xwiki.model.reference.EntityReferenceValueProvider
-
Deprecated.
- getDocumentReference() - Method in class org.xwiki.model.reference.AttachmentReference
- getDocumentReference() - Method in class org.xwiki.model.reference.ObjectReference
- getEntityReference(EntityType) - Method in class org.xwiki.model.script.ModelScriptService
-
Get the current reference configured for a specific entity type, like the space reference or wiki reference.
- getEntityReference(EntityType, String) - Method in class org.xwiki.model.script.ModelScriptService
-
Get the reference configured for a specific entity type, like the space reference or wiki reference.
- getEntityReferenceValue(EntityType) - Method in class org.xwiki.model.script.ModelScriptService
-
Deprecated.since 7.4.1/8.0M1, use
getEntityReference(EntityType)
- getEntityReferenceValue(EntityType, String) - Method in class org.xwiki.model.script.ModelScriptService
-
Deprecated.since 7.2M1, use
getEntityReference(EntityType, String)
- getLastSpaceReference() - Method in class org.xwiki.model.reference.DocumentReference
- getLocalDocumentReference() - Method in class org.xwiki.model.reference.DocumentReference
- getLocale() - Method in class org.xwiki.model.reference.AbstractLocalizedEntityReference
- getLocaleDocumentReference() - Method in class org.xwiki.model.reference.DocumentReference
-
Deprecated.since 9.3RC1/8.4.5, use
DocumentReference.getLocalDocumentReference()
instead - getLocales() - Method in class org.xwiki.model.reference.EntityReferenceTreeNode
- getLowerCase() - Method in enum org.xwiki.model.EntityType
- getName() - Method in class org.xwiki.model.reference.EntityReference
-
Returns the name of this entity.
- getPageReference() - Method in class org.xwiki.model.reference.PageAttachmentReference
- getPageReference() - Method in class org.xwiki.model.reference.PageObjectReference
- getParameter(String) - Method in class org.xwiki.model.reference.EntityReference
-
Get the value of a parameter.
- getParameters() - Method in class org.xwiki.model.reference.EntityReference
-
Get the parameters.
- getParent() - Method in class org.xwiki.model.reference.EntityReference
- getPattern() - Method in class org.xwiki.model.reference.RegexEntityReference
- getReference() - Method in class org.xwiki.model.reference.EntityReferenceTreeNode
- 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.
- getVersion() - Method in class org.xwiki.model.reference.DocumentVersionReference
- getWikiReference() - Method in class org.xwiki.model.reference.DocumentReference
- getWikiReference() - Method in class org.xwiki.model.reference.PageReference
- getWikiReference() - Method in class org.xwiki.model.reference.SpaceReference
H
- hashCode() - Method in class org.xwiki.model.reference.EntityReference
- hashCode() - Method in class org.xwiki.model.reference.PartialEntityReference
- hasParent(EntityReference) - Method in class org.xwiki.model.reference.EntityReference
-
Checks if a given reference is a parent of this reference.
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.
- isAllowedAncestor(EntityType) - Method in enum org.xwiki.model.EntityType
- 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(Iterable<String>, String) - Constructor for class org.xwiki.model.reference.LocalDocumentReference
-
Create a new Document reference 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(String, String, Locale) - Constructor for class org.xwiki.model.reference.LocalDocumentReference
-
Create a new Document reference in the current wiki.
- LocalDocumentReference(String, EntityReference) - 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
- LocalDocumentReference(EntityReference) - Constructor for class org.xwiki.model.reference.LocalDocumentReference
- LocalDocumentReference(EntityReference, Locale) - Constructor for class org.xwiki.model.reference.LocalDocumentReference
- LocalDocumentReference(EntityReference, EntityReference) - Constructor for class org.xwiki.model.reference.LocalDocumentReference
-
Clone an LocalDocumentReference, but use the specified parent for its new parent.
- LOCALE - Static variable in class org.xwiki.model.reference.AbstractLocalizedEntityReference
-
Parameter key for the locale.
- LocalPageReference - Class in org.xwiki.model.reference
-
Represents a reference to a page in the current wiki.
- LocalPageReference(String, String...) - Constructor for class org.xwiki.model.reference.LocalPageReference
-
Create a new Page reference in the current wiki.
- LocalPageReference(String, Locale) - Constructor for class org.xwiki.model.reference.LocalPageReference
-
Create a new Page reference in the current wiki.
- LocalPageReference(String, EntityReference) - Constructor for class org.xwiki.model.reference.LocalPageReference
-
Create a new Page reference in the current wiki.
- LocalPageReference(List<String>) - Constructor for class org.xwiki.model.reference.LocalPageReference
-
Create a new Page reference in the current wiki.
- LocalPageReference(EntityReference) - Constructor for class org.xwiki.model.reference.LocalPageReference
- LocalPageReference(EntityReference, Locale) - Constructor for class org.xwiki.model.reference.LocalPageReference
- LocalPageReference(EntityReference, EntityReference) - Constructor for class org.xwiki.model.reference.LocalPageReference
-
Clone an DocumentVersionReference, but use the specified parent for its new parent.
- LocalPageReference(PageReference) - Constructor for class org.xwiki.model.reference.LocalPageReference
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.
- ModelScriptService - Class in org.xwiki.model.script
-
Provides Model-specific Scripting APIs.
- ModelScriptService() - Constructor for class org.xwiki.model.script.ModelScriptService
O
- OBJECT - org.xwiki.model.EntityType
-
Represents an Object Entity.
- OBJECT_PROPERTY - org.xwiki.model.EntityType
-
Represents an Object Property Entity.
- ObjectPropertyReference - Class in org.xwiki.model.reference
-
References a property in an object in a document (the value of the property).
- ObjectPropertyReference(String, String, String, String, String) - Constructor for class org.xwiki.model.reference.ObjectPropertyReference
-
Deprecated.
- ObjectPropertyReference(String, ObjectReference) - Constructor for class org.xwiki.model.reference.ObjectPropertyReference
-
Builds a property reference for the passed property in the passed object.
- 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) - Constructor for class org.xwiki.model.reference.ObjectPropertyReference
-
Clone an ObjectPropertyReference, but use the specified parent for its new parent.
- 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.
- 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(String, String, String, String) - Constructor for class org.xwiki.model.reference.ObjectReference
-
Deprecated.
- ObjectReference(String, DocumentReference) - Constructor for class org.xwiki.model.reference.ObjectReference
- 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) - Constructor for class org.xwiki.model.reference.ObjectReference
-
Clone an ObjectReference, but use the specified parent for its new parent.
- 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.
- 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.namespace - package org.xwiki.model.namespace
- org.xwiki.model.reference - package org.xwiki.model.reference
- org.xwiki.model.script - package org.xwiki.model.script
P
- PAGE - org.xwiki.model.EntityType
-
Represents a Page Entity.
- PAGE_ATTACHMENT - org.xwiki.model.EntityType
-
Represents an Attachment Entity in a page.
- PAGE_CLASS_PROPERTY - org.xwiki.model.EntityType
-
Represents a class property entity in a page.
- PAGE_OBJECT - org.xwiki.model.EntityType
-
Represents an Object Entity in a page.
- PAGE_OBJECT_PROPERTY - org.xwiki.model.EntityType
-
Represents an Object Property Entity in a page.
- PageAttachmentReference - Class in org.xwiki.model.reference
-
Represents a reference to an Attachment (page reference and file name).
- PageAttachmentReference(String, PageReference) - Constructor for class org.xwiki.model.reference.PageAttachmentReference
-
Create a new attachment reference based on the attachment name and the parent page reference.
- PageAttachmentReference(EntityReference) - Constructor for class org.xwiki.model.reference.PageAttachmentReference
-
Special constructor that transforms a generic entity reference into an
PageAttachmentReference
. - PageAttachmentReference(EntityReference, EntityReference) - Constructor for class org.xwiki.model.reference.PageAttachmentReference
-
Clone an PageAttachmentReference, but use the specified parent for its new parent.
- PageAttachmentReference(EntityReference, EntityReference, EntityReference) - Constructor for class org.xwiki.model.reference.PageAttachmentReference
-
Clone an AttachmentReference, but replace one of the parent in the chain by a new one.
- PageAttachmentReferenceResolver<T> - Interface in org.xwiki.model.reference
-
Resolve an Attachment reference defined in a given representation into a validated
PageAttachmentReference
object, ie with valid values and a valid hierarchy (eg an Attachment reference must have a parent which is a page reference, reference values must not be null, etc). - PageClassPropertyReference - Class in org.xwiki.model.reference
-
References a property in a class in a page (the description of the property).
- PageClassPropertyReference(String, PageReference) - Constructor for class org.xwiki.model.reference.PageClassPropertyReference
-
Builds a property reference for the passed property in the passed object.
- PageClassPropertyReference(EntityReference) - Constructor for class org.xwiki.model.reference.PageClassPropertyReference
-
Constructor which would raise exceptions if the source entity reference does not have the appropriate type or parent, etc.
- PageClassPropertyReference(EntityReference, EntityReference) - Constructor for class org.xwiki.model.reference.PageClassPropertyReference
-
Clone an PageClassPropertyReference, but use the specified parent for its new parent.
- PageClassPropertyReference(EntityReference, EntityReference, EntityReference) - Constructor for class org.xwiki.model.reference.PageClassPropertyReference
-
Clone an ClassPropertyReference, but replace one of the parent in the chain by a new one.
- PageObjectPropertyReference - Class in org.xwiki.model.reference
-
References a property in an object in a document (the value of the property).
- PageObjectPropertyReference(String, PageObjectReference) - Constructor for class org.xwiki.model.reference.PageObjectPropertyReference
-
Builds a property reference for the passed property in the passed object.
- PageObjectPropertyReference(EntityReference) - Constructor for class org.xwiki.model.reference.PageObjectPropertyReference
-
Constructor which would raise exceptions if the source entity reference does not have the appropriate type or parent, etc.
- PageObjectPropertyReference(EntityReference, EntityReference) - Constructor for class org.xwiki.model.reference.PageObjectPropertyReference
-
Clone an PageObjectPropertyReference, but use the specified parent for its new parent.
- PageObjectPropertyReference(EntityReference, EntityReference, EntityReference) - Constructor for class org.xwiki.model.reference.PageObjectPropertyReference
-
Clone an ObjectPropertyReference, but replace one of the parent in the chain by a new one.
- PageObjectPropertyReferenceResolver<T> - Interface in org.xwiki.model.reference
-
Resolve a Property reference defined in a given representation into a validated
PageObjectPropertyReference
object, i.e. - PageObjectReference - Class in org.xwiki.model.reference
-
Reference to an object in a page (by classname and index, page, wiki).
- PageObjectReference(String, PageReference) - Constructor for class org.xwiki.model.reference.PageObjectReference
- PageObjectReference(EntityReference) - Constructor for class org.xwiki.model.reference.PageObjectReference
-
Constructor which would raise exceptions if the source entity reference does not have the appropriate type or parent, etc.
- PageObjectReference(EntityReference, EntityReference) - Constructor for class org.xwiki.model.reference.PageObjectReference
-
Clone an PageObjectReference, but use the specified parent for its new parent.
- PageObjectReference(EntityReference, EntityReference, EntityReference) - Constructor for class org.xwiki.model.reference.PageObjectReference
-
Clone an ObjectReference, but replace one of the parent in the chain by a new one.
- PageObjectReferenceResolver<T> - Interface in org.xwiki.model.reference
-
Resolve an Object reference defined in a given representation into a validated
PageObjectReference
object, i.e. - PageReference - Class in org.xwiki.model.reference
-
Represents a reference to a page.
- PageReference(String, String, String...) - Constructor for class org.xwiki.model.reference.PageReference
-
Create a page reference based on a page name and a parent page reference.
- PageReference(String, List<String>) - Constructor for class org.xwiki.model.reference.PageReference
-
Create a page reference based on a page name and a parent page reference.
- PageReference(String, List<String>, Locale) - Constructor for class org.xwiki.model.reference.PageReference
-
Create a page reference based on a page name and a parent page reference.
- PageReference(String, EntityReference) - Constructor for class org.xwiki.model.reference.PageReference
-
Create a page reference based on a page name and a parent entity reference.
- PageReference(String, EntityReference, Locale) - Constructor for class org.xwiki.model.reference.PageReference
-
Create a page reference based on a page name and a parent entity reference.
- PageReference(String, PageReference) - Constructor for class org.xwiki.model.reference.PageReference
-
Create a page reference based on a page name and a parent page reference.
- PageReference(String, WikiReference) - Constructor for class org.xwiki.model.reference.PageReference
-
Create a page reference based on a page name and a parent wiki reference.
- PageReference(EntityReference) - Constructor for class org.xwiki.model.reference.PageReference
-
Special constructor that transforms a generic entity reference into a
PageReference
. - PageReference(EntityReference, Locale) - Constructor for class org.xwiki.model.reference.PageReference
-
Clone an EntityReference and change/add the passed Locale.
- PageReference(EntityReference, EntityReference) - Constructor for class org.xwiki.model.reference.PageReference
-
Clone an PageReference, but use the specified parent for its new parent.
- PageReference(EntityReference, EntityReference, EntityReference) - Constructor for class org.xwiki.model.reference.PageReference
-
Clone a page reference, but replace one of the parent in the chain by a new one.
- PageReference(LocalPageReference, WikiReference) - Constructor for class org.xwiki.model.reference.PageReference
-
Create a new page reference from local page reference and wiki reference.
- PageReferenceResolver<T> - Interface in org.xwiki.model.reference
-
Resolve a Page reference defined in a given representation into a validated
PageReference
object, ie with valid values and a valid hierarchy (eg a Page reference must have a parent which is a space reference, reference values must not be null, etc). - 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.
- removeVersion() - Method in class org.xwiki.model.reference.DocumentVersionReference
- replaceParent(EntityReference) - Method in class org.xwiki.model.reference.AttachmentReference
- replaceParent(EntityReference) - Method in class org.xwiki.model.reference.BlockReference
- replaceParent(EntityReference) - Method in class org.xwiki.model.reference.ClassPropertyReference
- replaceParent(EntityReference) - Method in class org.xwiki.model.reference.DocumentReference
- replaceParent(EntityReference) - Method in class org.xwiki.model.reference.EntityReference
-
Return a clone of this reference, but with its parent replaced by the passed one.
- replaceParent(EntityReference) - Method in class org.xwiki.model.reference.LocalDocumentReference
- replaceParent(EntityReference) - Method in class org.xwiki.model.reference.LocalPageReference
- replaceParent(EntityReference) - Method in class org.xwiki.model.reference.ObjectPropertyReference
- replaceParent(EntityReference) - Method in class org.xwiki.model.reference.ObjectReference
- replaceParent(EntityReference) - Method in class org.xwiki.model.reference.PageAttachmentReference
- replaceParent(EntityReference) - Method in class org.xwiki.model.reference.PageClassPropertyReference
- replaceParent(EntityReference) - Method in class org.xwiki.model.reference.PageObjectPropertyReference
- replaceParent(EntityReference) - Method in class org.xwiki.model.reference.PageObjectReference
- replaceParent(EntityReference) - Method in class org.xwiki.model.reference.PageReference
- replaceParent(EntityReference) - Method in class org.xwiki.model.reference.SpaceReference
- replaceParent(EntityReference, EntityReference) - Method in class org.xwiki.model.reference.AttachmentReference
- replaceParent(EntityReference, EntityReference) - Method in class org.xwiki.model.reference.BlockReference
- 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.PageAttachmentReference
- replaceParent(EntityReference, EntityReference) - Method in class org.xwiki.model.reference.PageClassPropertyReference
- replaceParent(EntityReference, EntityReference) - Method in class org.xwiki.model.reference.PageObjectPropertyReference
- replaceParent(EntityReference, EntityReference) - Method in class org.xwiki.model.reference.PageObjectReference
- replaceParent(EntityReference, EntityReference) - Method in class org.xwiki.model.reference.PageReference
- replaceParent(EntityReference, EntityReference) - Method in class org.xwiki.model.reference.SpaceReference
- resolve(T) - Method in interface org.xwiki.model.reference.ObjectPropertyReferenceResolver
-
Deprecated.
- resolve(T) - Method in interface org.xwiki.model.reference.ObjectReferenceResolver
-
Deprecated.
- resolve(T, Object...) - Method in interface org.xwiki.model.reference.AttachmentReferenceResolver
- resolve(T, Object...) - Method in interface org.xwiki.model.reference.BlockReferenceResolver
- resolve(T, Object...) - Method in interface org.xwiki.model.reference.DocumentReferenceResolver
- resolve(T, Object...) - Method in interface org.xwiki.model.reference.ObjectPropertyReferenceResolver
- resolve(T, Object...) - Method in interface org.xwiki.model.reference.ObjectReferenceResolver
- resolve(T, Object...) - Method in interface org.xwiki.model.reference.PageAttachmentReferenceResolver
- resolve(T, Object...) - Method in interface org.xwiki.model.reference.PageObjectPropertyReferenceResolver
- resolve(T, Object...) - Method in interface org.xwiki.model.reference.PageObjectReferenceResolver
- resolve(T, Object...) - Method in interface org.xwiki.model.reference.PageReferenceResolver
- resolve(T, Object...) - Method in interface org.xwiki.model.reference.SpaceReferenceResolver
- resolve(T, EntityType, Object...) - Method in interface org.xwiki.model.reference.EntityReferenceResolver
- resolveAttachment(String, Object...) - Method in class org.xwiki.model.script.ModelScriptService
- resolveAttachment(String, String, Object...) - Method in class org.xwiki.model.script.ModelScriptService
- resolveClassProperty(String, Object...) - Method in class org.xwiki.model.script.ModelScriptService
- resolveClassProperty(String, String, Object...) - Method in class org.xwiki.model.script.ModelScriptService
- resolveDocument(String, Object...) - Method in class org.xwiki.model.script.ModelScriptService
- resolveDocument(String, String, Object...) - Method in class org.xwiki.model.script.ModelScriptService
- resolveObject(String, Object...) - Method in class org.xwiki.model.script.ModelScriptService
- resolveObject(String, String, Object...) - Method in class org.xwiki.model.script.ModelScriptService
- resolveObjectProperty(String, Object...) - Method in class org.xwiki.model.script.ModelScriptService
- resolveObjectProperty(String, String, Object...) - Method in class org.xwiki.model.script.ModelScriptService
- resolvePage(String, Object...) - Method in class org.xwiki.model.script.ModelScriptService
- resolvePage(String, String, Object...) - Method in class org.xwiki.model.script.ModelScriptService
- resolvePageAttachment(String, Object...) - Method in class org.xwiki.model.script.ModelScriptService
- resolvePageAttachment(String, String, Object...) - Method in class org.xwiki.model.script.ModelScriptService
- resolvePageClassProperty(String, Object...) - Method in class org.xwiki.model.script.ModelScriptService
- resolvePageClassProperty(String, String, Object...) - Method in class org.xwiki.model.script.ModelScriptService
- resolvePageObject(String, Object...) - Method in class org.xwiki.model.script.ModelScriptService
- resolvePageObject(String, String, Object...) - Method in class org.xwiki.model.script.ModelScriptService
- resolvePageObjectProperty(String, Object...) - Method in class org.xwiki.model.script.ModelScriptService
- resolvePageObjectProperty(String, String, Object...) - Method in class org.xwiki.model.script.ModelScriptService
- resolveSpace(String, Object...) - Method in class org.xwiki.model.script.ModelScriptService
- resolveSpace(String, String, Object...) - Method in class org.xwiki.model.script.ModelScriptService
S
- serialize(EntityReference, Object...) - Method in interface org.xwiki.model.reference.EntityReferenceSerializer
-
Serialize an entity reference into a new representation of type
T
. - serialize(EntityReference, Object...) - Method in class org.xwiki.model.script.ModelScriptService
- serialize(EntityReference, String, Object...) - Method in class org.xwiki.model.script.ModelScriptService
- setCurrentEntityReference(EntityReference) - Method in interface org.xwiki.model.ModelContext
- setLocale(Locale) - Method in class org.xwiki.model.reference.AbstractLocalizedEntityReference
-
Set the locale of this 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.AbstractLocalizedEntityReference
-
Add or set a parameter value.
- 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.BlockReference
-
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.LocalPageReference
-
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.PageAttachmentReference
-
Entity reference are immutable since 3.3M2, so this method is now protected.
- setParent(EntityReference) - Method in class org.xwiki.model.reference.PageClassPropertyReference
-
Entity reference are immutable since 3.3M2, so this method is now protected.
- setParent(EntityReference) - Method in class org.xwiki.model.reference.PageObjectPropertyReference
-
Entity reference are immutable since 3.3M2, so this method is now protected.
- setParent(EntityReference) - Method in class org.xwiki.model.reference.PageObjectReference
-
Entity reference are immutable since 3.3M2, so this method is now protected.
- setParent(EntityReference) - Method in class org.xwiki.model.reference.PageReference
-
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.BlockReference
-
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.LocalPageReference
-
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.PageAttachmentReference
-
Entity reference are immutable since 3.3M2, so this method is now protected.
- setType(EntityType) - Method in class org.xwiki.model.reference.PageClassPropertyReference
-
Entity reference are immutable since 3.3M2, so this method is now protected.
- setType(EntityType) - Method in class org.xwiki.model.reference.PageObjectPropertyReference
-
Entity reference are immutable since 3.3M2, so this method is now protected.
- setType(EntityType) - Method in class org.xwiki.model.reference.PageObjectReference
-
Entity reference are immutable since 3.3M2, so this method is now protected.
- setType(EntityType) - Method in class org.xwiki.model.reference.PageReference
-
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.
- setWikiReference(WikiReference) - Method in class org.xwiki.model.reference.DocumentReference
-
Create a new DocumentReference with passed wiki reference.
- size() - Method in class org.xwiki.model.reference.EntityReference
- SPACE - org.xwiki.model.EntityType
-
Represents a Space Entity.
- SpaceNamespace - Class in org.xwiki.model.namespace
-
Typed
Namespace
for spaces. - SpaceNamespace(String) - Constructor for class org.xwiki.model.namespace.SpaceNamespace
- SpaceReference - Class in org.xwiki.model.reference
-
Represents a reference to a space (space name).
- SpaceReference(String, String...) - Constructor for class org.xwiki.model.reference.SpaceReference
-
Create a space reference based on a space name and a parent space reference.
- SpaceReference(String, List<String>) - 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.
- 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, WikiReference) - Constructor for class org.xwiki.model.reference.SpaceReference
-
Create a space reference based on a space name and a parent wiki reference.
- SpaceReference(EntityReference) - Constructor for class org.xwiki.model.reference.SpaceReference
-
Special constructor that transforms a generic entity reference into a
SpaceReference
. - SpaceReference(EntityReference, EntityReference) - Constructor for class org.xwiki.model.reference.SpaceReference
-
Clone an SpaceReference, but use the specified parent for its new parent.
- 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.
- SpaceReferenceResolver<T> - Interface in org.xwiki.model.reference
-
Resolve a Space reference defined in a given representation into a validated
SpaceReference
object, ie with valid values and a valid hierarchy (eg a Space reference must have a parent which is a space reference or a wiki reference, reference values must not be null, etc).
T
- toString() - Method in class org.xwiki.model.reference.DocumentReference
- toString() - Method in class org.xwiki.model.reference.EntityReference
- toString() - Method in class org.xwiki.model.reference.EntityReferenceTreeNode
- toString() - Method in class org.xwiki.model.reference.LocalDocumentReference
- toString() - Method in class org.xwiki.model.reference.LocalPageReference
- toString() - Method in class org.xwiki.model.reference.PageReference
- 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. - toTree(Iterable<? extends EntityReference>) - Method in class org.xwiki.model.script.ModelScriptService
-
Convert passed references to a tree of references.
- toTree(EntityReference...) - Method in class org.xwiki.model.script.ModelScriptService
-
Convert passed references to a tree of references.
- TYPE - Static variable in class org.xwiki.model.namespace.DocumentNamespace
-
The type used in those namespaces.
- TYPE - Static variable in class org.xwiki.model.namespace.SpaceNamespace
-
The type used in those namespaces.
- TYPE - Static variable in class org.xwiki.model.namespace.UserNamespace
-
The type used in those namespaces.
- TYPE - Static variable in class org.xwiki.model.namespace.WikiNamespace
-
The type used in those namespaces.
- TYPE_PAGEREFERENCE - Static variable in interface org.xwiki.model.reference.DocumentReferenceResolver
-
Type instance for
DocumentReferenceResolver<PageReference>
. - TYPE_PROVIDER - Static variable in class org.xwiki.model.reference.DocumentReference
-
The
Type
for aProvider<DocumentReference>
. - TYPE_PROVIDER - Static variable in class org.xwiki.model.reference.PageReference
-
The
Type
for aProvider<PageReference>
. - TYPE_PROVIDER - Static variable in class org.xwiki.model.reference.SpaceReference
-
The
Type
for aProvider<SpaceReference>
. - TYPE_PROVIDER - Static variable in class org.xwiki.model.reference.WikiReference
-
The
Type
for aProvider<WikiReference>
. - TYPE_REFERENCE - Static variable in interface org.xwiki.model.reference.AttachmentReferenceResolver
-
Type instance for
AttachmentReferenceResolver<EntityReference>
. - TYPE_REFERENCE - Static variable in interface org.xwiki.model.reference.DocumentReferenceResolver
-
Type instance for
DocumentReferenceResolver<EntityReference>
. - TYPE_REFERENCE - Static variable in interface org.xwiki.model.reference.EntityReferenceResolver
-
Type instance for
EntityReferenceResolver<EntityReference>
. - TYPE_REFERENCE - Static variable in interface org.xwiki.model.reference.EntityReferenceSerializer
-
Type instance for
EntityReferenceSerializer<EntityReference>
. - TYPE_REFERENCE - Static variable in interface org.xwiki.model.reference.ObjectPropertyReferenceResolver
-
Type instance for
ObjectPropertyReferenceResolver<EntityReference>
. - TYPE_REFERENCE - Static variable in interface org.xwiki.model.reference.ObjectReferenceResolver
-
Type instance for
ObjectReferenceResolver<EntityReference>
. - TYPE_REFERENCE - Static variable in interface org.xwiki.model.reference.PageAttachmentReferenceResolver
-
Type instance for
PageAttachmentReferenceResolver<EntityReference>
. - TYPE_REFERENCE - Static variable in interface org.xwiki.model.reference.PageObjectPropertyReferenceResolver
-
Type instance for
PageObjectPropertyReferenceResolver<EntityReference>
. - TYPE_REFERENCE - Static variable in interface org.xwiki.model.reference.PageObjectReferenceResolver
-
Type instance for
PageObjectReferenceResolver<EntityReference>
. - TYPE_REFERENCE - Static variable in interface org.xwiki.model.reference.PageReferenceResolver
-
Type instance for
PageReferenceResolver<EntityReference>
. - TYPE_REFERENCE - Static variable in interface org.xwiki.model.reference.SpaceReferenceResolver
-
Type instance for
SpaceReferenceResolver<EntityReference>
. - TYPE_STRING - Static variable in interface org.xwiki.model.reference.AttachmentReferenceResolver
-
Type instance for
AttachmentReferenceResolver<String>
. - TYPE_STRING - Static variable in interface org.xwiki.model.reference.DocumentReferenceResolver
-
Type instance for
DocumentReferenceResolver<String>
. - TYPE_STRING - Static variable in interface org.xwiki.model.reference.EntityReferenceResolver
-
Type instance for
EntityReferenceResolver<String>
. - TYPE_STRING - Static variable in interface org.xwiki.model.reference.EntityReferenceSerializer
-
Type instance for
EntityReferenceSerializer<String>
. - TYPE_STRING - Static variable in interface org.xwiki.model.reference.ObjectPropertyReferenceResolver
-
Type instance for
ObjectPropertyReferenceResolver<String>
. - TYPE_STRING - Static variable in interface org.xwiki.model.reference.ObjectReferenceResolver
-
Type instance for
ObjectReferenceResolver<String>
. - TYPE_STRING - Static variable in interface org.xwiki.model.reference.PageAttachmentReferenceResolver
-
Type instance for
PageAttachmentReferenceResolver<String>
. - TYPE_STRING - Static variable in interface org.xwiki.model.reference.PageObjectPropertyReferenceResolver
-
Type instance for
PageObjectPropertyReferenceResolver<String>
. - TYPE_STRING - Static variable in interface org.xwiki.model.reference.PageObjectReferenceResolver
-
Type instance for
PageObjectReferenceResolver<String>
. - TYPE_STRING - Static variable in interface org.xwiki.model.reference.PageReferenceResolver
-
Type instance for
PageReferenceResolver<String>
. - TYPE_STRING - Static variable in interface org.xwiki.model.reference.SpaceReferenceResolver
-
Type instance for
SpaceReferenceResolver<String>
.
U
- UserNamespace - Class in org.xwiki.model.namespace
-
Typed
Namespace
for users. - UserNamespace(String) - Constructor for class org.xwiki.model.namespace.UserNamespace
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
- WIKI - org.xwiki.model.EntityType
-
Represents a Wiki Entity.
- WikiNamespace - Class in org.xwiki.model.namespace
-
Typed
Namespace
for wikis. - WikiNamespace(String) - Constructor for class org.xwiki.model.namespace.WikiNamespace
- WikiReference - Class in org.xwiki.model.reference
-
Represents a reference to a wiki (wiki name).
- WikiReference(String) - Constructor for class org.xwiki.model.reference.WikiReference
- WikiReference(EntityReference) - Constructor for class org.xwiki.model.reference.WikiReference
-
Special constructor that transforms a generic entity reference into a
WikiReference
. - withoutLocale() - Method in class org.xwiki.model.reference.DocumentReference
All Classes All Packages