- DocumentReference - Class in org.xwiki.model.reference
-
Represents a reference to a document (wiki, space and page names).
- DocumentReference(EntityReference) - Constructor for class org.xwiki.model.reference.DocumentReference
-
Special constructor that transforms a generic entity reference into a
DocumentReference
.
- DocumentReference(EntityReference, EntityReference, EntityReference) - Constructor for class org.xwiki.model.reference.DocumentReference
-
Clone an DocumentReference, but replace one of the parent in the chain by a new one.
- DocumentReference(EntityReference, Locale) - Constructor for class org.xwiki.model.reference.DocumentReference
-
Clone the provided reference and change the Locale.
- DocumentReference(String, String, String) - Constructor for class org.xwiki.model.reference.DocumentReference
-
Create a new Document reference from wiki, space and page name.
- DocumentReference(String, String, String, Locale) - Constructor for class org.xwiki.model.reference.DocumentReference
-
Create a new Document reference from wiki name, space name, page name and locale.
- DocumentReference(String, String, String, String) - Constructor for class org.xwiki.model.reference.DocumentReference
-
Create a new Document reference from wiki name, space name, page name and language.
- DocumentReference(String, List<String>, String) - Constructor for class org.xwiki.model.reference.DocumentReference
-
Create a new Document reference from wiki name, spaces names and page name.
- DocumentReference(String, List<String>, String, Locale) - Constructor for class org.xwiki.model.reference.DocumentReference
-
Create a new Document reference from wiki name, spaces names, page name and locale.
- DocumentReference(String, SpaceReference) - Constructor for class org.xwiki.model.reference.DocumentReference
-
Create a new Document reference from document name and parent space.
- DocumentReference(LocalDocumentReference, WikiReference) - Constructor for class org.xwiki.model.reference.DocumentReference
-
Create a new Document reference from local document reference and wiki reference.
- DocumentReference(String, SpaceReference, Locale) - Constructor for class org.xwiki.model.reference.DocumentReference
-
Create a new Document reference from document name, parent space and locale.
- DocumentReferenceResolver<T> - Interface in org.xwiki.model.reference
-
Resolve a Document reference defined in a given representation into a validated
DocumentReference
object, ie
with valid values and a valid hierarchy (eg a Document reference must have a parent which is a space reference,
reference values must not be null, etc).
- EntityReference - Class in org.xwiki.model.reference
-
Represents a reference to an Entity (Document, Attachment, Space, Wiki, etc).
- EntityReference(EntityReference) - Constructor for class org.xwiki.model.reference.EntityReference
-
Clone an EntityReference.
- EntityReference(EntityReference, EntityReference) - Constructor for class org.xwiki.model.reference.EntityReference
-
Clone an EntityReference, but use the specified parent for its new parent.
- EntityReference(EntityReference, EntityReference, EntityReference) - Constructor for class org.xwiki.model.reference.EntityReference
-
Clone an EntityReference, but replace one of the parent in the chain by an other one.
- EntityReference(String, EntityType) - Constructor for class org.xwiki.model.reference.EntityReference
-
Create a new root EntityReference.
- EntityReference(String, EntityType, EntityReference) - Constructor for class org.xwiki.model.reference.EntityReference
-
Create a new EntityReference.
- EntityReference(String, EntityType, EntityReference, Map<String, Serializable>) - Constructor for class org.xwiki.model.reference.EntityReference
-
Create a new EntityReference.
- EntityReferenceResolver<T> - Interface in org.xwiki.model.reference
-
Resolve an Entity reference defined in a given representation into a validated
EntityReference
object, ie
with valid values and a valid hierarchy (eg a Document reference must have a parent which is a space reference,
reference values must not be null, etc).
- EntityReferenceSerializer<T> - Interface in org.xwiki.model.reference
-
Generate a different representation of an Entity Reference (eg as a String).
- EntityReferenceSet - Class in org.xwiki.model.reference
-
A set of entities references.
- EntityReferenceSet() - Constructor for class org.xwiki.model.reference.EntityReferenceSet
-
- 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(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
-
- EntityReferenceTreeNode - Class in org.xwiki.model.reference
-
- EntityReferenceTreeNode(Comparator<String>) - Constructor for class org.xwiki.model.reference.EntityReferenceTreeNode
-
- EntityReferenceValueProvider - Interface in org.xwiki.model.reference
-
Return default values for specified Entity Reference types.
- EntityType - Enum in org.xwiki.model
-
Represents a type of entity (ie a Model Object such as a Wiki, a Space, a Document, an Attachment, etc).
- equals(Object) - Method in class org.xwiki.model.reference.EntityReference
-
- equals(Object) - Method in class org.xwiki.model.reference.PartialEntityReference
- excludes(EntityReference) - Method in class org.xwiki.model.reference.EntityReferenceSet
-
- extractReference(EntityType) - Method in class org.xwiki.model.reference.EntityReference
-
Extract the entity of the given type from this one.
- serialize(EntityReference, Object...) - Method in interface org.xwiki.model.reference.EntityReferenceSerializer
-
Serialize an entity reference into a new representation of type .
- 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.DocumentReference
-
Set the locale of this document reference.
- setLocale(Locale) - Method in class org.xwiki.model.reference.LocalDocumentReference
-
Set the locale of this document reference.
- setName(String) - Method in class org.xwiki.model.reference.EntityReference
-
Entity reference are immutable since 3.3M2, so this method is now protected.
- setParameter(String, Serializable) - Method in class org.xwiki.model.reference.EntityReference
-
Add or set a parameter value.
- setParameters(Map<String, Serializable>) - Method in class org.xwiki.model.reference.EntityReference
-
Set multiple parameters at once.
- setParent(EntityReference) - Method in class org.xwiki.model.reference.AttachmentReference
-
Entity reference are immutable since 3.3M2, so this method is now protected.
- setParent(EntityReference) - Method in class org.xwiki.model.reference.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.ObjectPropertyReference
-
Entity reference are immutable since 3.3M2, so this method is now protected.
- setParent(EntityReference) - Method in class org.xwiki.model.reference.ObjectReference
-
Entity reference are immutable since 3.3M2, so this method is now protected.
- setParent(EntityReference) - Method in class org.xwiki.model.reference.SpaceReference
-
Entity reference are immutable since 3.3M2, so this method is now protected.
- setParent(EntityReference) - Method in class org.xwiki.model.reference.WikiReference
-
Entity reference are immutable since 3.3M2, so this method is now protected.
- setType(EntityType) - Method in class org.xwiki.model.reference.AttachmentReference
-
Entity reference are immutable since 3.3M2, so this method is now protected.
- setType(EntityType) - Method in class org.xwiki.model.reference.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.ObjectPropertyReference
-
Entity reference are immutable since 3.3M2, so this method is now protected.
- setType(EntityType) - Method in class org.xwiki.model.reference.ObjectReference
-
Entity reference are immutable since 3.3M2, so this method is now protected.
- setType(EntityType) - Method in class org.xwiki.model.reference.SpaceReference
-
Entity reference are immutable since 3.3M2, so this method is now protected.
- setType(EntityType) - Method in class org.xwiki.model.reference.WikiReference
-
Entity reference are immutable since 3.3M2, so this method is now protected.
- SpaceReference - Class in org.xwiki.model.reference
-
Represents a reference to a space (space name).
- SpaceReference(EntityReference) - Constructor for class org.xwiki.model.reference.SpaceReference
-
Special constructor that transforms a generic entity reference into a
SpaceReference
.
- SpaceReference(EntityReference, EntityReference, EntityReference) - Constructor for class org.xwiki.model.reference.SpaceReference
-
Clone an SpaceReference, but replace one of the parent in the chain by a new one.
- SpaceReference(String, WikiReference) - Constructor for class org.xwiki.model.reference.SpaceReference
-
Create a space reference based on a space name and a parent wiki reference.
- SpaceReference(String, SpaceReference) - Constructor for class org.xwiki.model.reference.SpaceReference
-
Create a space reference based on a space name and a parent space reference.
- SpaceReference(String, EntityReference) - Constructor for class org.xwiki.model.reference.SpaceReference
-
Create a space reference based on a space name and a parent entity reference.