A C D E F G H I O P S T W

A

AbstractDocumentEvent - Class in org.xwiki.bridge.event

Base class for all document related Event.

AbstractDocumentEvent() - Constructor for class org.xwiki.bridge.event.AbstractDocumentEvent

This event will match any other document event of the same type.

AbstractDocumentEvent(DocumentReference) - Constructor for class org.xwiki.bridge.event.AbstractDocumentEvent

This event will match only events of the same type affecting the same document.

AbstractDocumentEvent(EventFilter) - Constructor for class org.xwiki.bridge.event.AbstractDocumentEvent

Constructor using a custom EventFilter.

AbstractWikiEvent - Class in org.xwiki.bridge.event

Base class for all wiki related Event.

AbstractWikiEvent() - Constructor for class org.xwiki.bridge.event.AbstractWikiEvent

This event will match any other document event of the same type.

AbstractWikiEvent(String) - Constructor for class org.xwiki.bridge.event.AbstractWikiEvent

This event will match only events of the same type affecting the same document.

AbstractWikiEvent(EventFilter) - Constructor for class org.xwiki.bridge.event.AbstractWikiEvent

Constructor using a custom EventFilter.

AttachmentName - Class in org.xwiki.bridge

Deprecated. use AttachmentReference instead since 2.2M1

AttachmentName(DocumentName, String) - Constructor for class org.xwiki.bridge.AttachmentName

Deprecated.

AttachmentName(String, String, String, String) - Constructor for class org.xwiki.bridge.AttachmentName

Deprecated.

AttachmentNameFactory - Interface in org.xwiki.bridge

Deprecated. use AttachmentReferenceResolver instead since 2.2M1

AttachmentNameSerializer - Interface in org.xwiki.bridge

Deprecated. use EntityReferenceSerializer instead since 2.2M1

C

createAttachmentName(String) - Method in interface org.xwiki.bridge.AttachmentNameFactory

Deprecated.

createAttachmentName(String) - Method in class org.xwiki.bridge.internal.DefaultAttachmentNameFactory

Deprecated. The supported formats are: wiki:space.page@filename filename If no "@" symbol is found then the reference is the attachment's filename and the document is the current document.

createDocumentName(String) - Method in interface org.xwiki.bridge.DocumentNameFactory

Deprecated.

D

DefaultAttachmentNameFactory - Class in org.xwiki.bridge.internal

Deprecated. use AttachmentReferenceResolver instead since 2.2M1

DefaultAttachmentNameFactory() - Constructor for class org.xwiki.bridge.internal.DefaultAttachmentNameFactory

Deprecated.

DefaultAttachmentNameSerializer - Class in org.xwiki.bridge.internal

Deprecated. use EntityReferenceSerializer instead since 2.2M1

DefaultAttachmentNameSerializer() - Constructor for class org.xwiki.bridge.internal.DefaultAttachmentNameSerializer

Deprecated.

DocumentAccessBridge - Interface in org.xwiki.bridge

Exposes methods for accessing Document data.

DocumentCreatedEvent - Class in org.xwiki.bridge.event

An event triggered after a document is created.

DocumentCreatedEvent() - Constructor for class org.xwiki.bridge.event.DocumentCreatedEvent

Constructor initializing the event filter with an AlwaysMatchingEventFilter, meaning that this event will match any other document delete event.

DocumentCreatedEvent(DocumentReference) - Constructor for class org.xwiki.bridge.event.DocumentCreatedEvent

Constructor initializing the event filter with a FixedNameEventFilter, meaning that this event will match only delete events affecting the same document.

DocumentCreatedEvent(EventFilter) - Constructor for class org.xwiki.bridge.event.DocumentCreatedEvent

Constructor using a custom EventFilter.

DocumentCreatingEvent - Class in org.xwiki.bridge.event

An event triggered before a document is created.

DocumentCreatingEvent() - Constructor for class org.xwiki.bridge.event.DocumentCreatingEvent

Constructor initializing the event filter with an AlwaysMatchingEventFilter, meaning that this event will match any other document delete event.

DocumentCreatingEvent(DocumentReference) - Constructor for class org.xwiki.bridge.event.DocumentCreatingEvent

Constructor initializing the event filter with a FixedNameEventFilter, meaning that this event will match only delete events affecting the same document.

DocumentCreatingEvent(EventFilter) - Constructor for class org.xwiki.bridge.event.DocumentCreatingEvent

Constructor using a custom EventFilter.

DocumentDeletedEvent - Class in org.xwiki.bridge.event

An event triggered after a document is deleted.

DocumentDeletedEvent() - Constructor for class org.xwiki.bridge.event.DocumentDeletedEvent

Constructor initializing the event filter with an AlwaysMatchingEventFilter, meaning that this event will match any other document delete event.

DocumentDeletedEvent(DocumentReference) - Constructor for class org.xwiki.bridge.event.DocumentDeletedEvent

Constructor initializing the event filter with a FixedNameEventFilter, meaning that this event will match only delete events affecting the same document.

DocumentDeletedEvent(EventFilter) - Constructor for class org.xwiki.bridge.event.DocumentDeletedEvent

Constructor using a custom EventFilter.

DocumentDeletingEvent - Class in org.xwiki.bridge.event

An event triggered before a document is deleted.

DocumentDeletingEvent() - Constructor for class org.xwiki.bridge.event.DocumentDeletingEvent

Constructor initializing the event filter with an AlwaysMatchingEventFilter, meaning that this event will match any other document delete event.

DocumentDeletingEvent(DocumentReference) - Constructor for class org.xwiki.bridge.event.DocumentDeletingEvent

Constructor initializing the event filter with a FixedNameEventFilter, meaning that this event will match only delete events affecting the same document.

DocumentDeletingEvent(EventFilter) - Constructor for class org.xwiki.bridge.event.DocumentDeletingEvent

Constructor using a custom EventFilter.

DocumentModelBridge - Interface in org.xwiki.bridge

Exposes methods for accessing Documents.

DocumentName - Class in org.xwiki.bridge

Deprecated. use DocumentReference instead since 2.2M1

DocumentName(String, String, String) - Constructor for class org.xwiki.bridge.DocumentName

Deprecated.

DocumentNameFactory - Interface in org.xwiki.bridge

Deprecated. use DocumentReferenceResolver instead since 2.2M1

DocumentNameSerializer - Interface in org.xwiki.bridge

Deprecated. use EntityReferenceSerializer instead since 2.2M1

DocumentUpdatedEvent - Class in org.xwiki.bridge.event

An event triggered after a document is updated.

DocumentUpdatedEvent() - Constructor for class org.xwiki.bridge.event.DocumentUpdatedEvent

Constructor initializing the event filter with an AlwaysMatchingEventFilter, meaning that this event will match any other document delete event.

DocumentUpdatedEvent(DocumentReference) - Constructor for class org.xwiki.bridge.event.DocumentUpdatedEvent

Constructor initializing the event filter with a FixedNameEventFilter, meaning that this event will match only delete events affecting the same document.

DocumentUpdatedEvent(EventFilter) - Constructor for class org.xwiki.bridge.event.DocumentUpdatedEvent

Constructor using a custom EventFilter.

DocumentUpdatingEvent - Class in org.xwiki.bridge.event

An event triggered before a document is updated.

DocumentUpdatingEvent() - Constructor for class org.xwiki.bridge.event.DocumentUpdatingEvent

Constructor initializing the event filter with an AlwaysMatchingEventFilter, meaning that this event will match any other document delete event.

DocumentUpdatingEvent(DocumentReference) - Constructor for class org.xwiki.bridge.event.DocumentUpdatingEvent

Constructor initializing the event filter with a FixedNameEventFilter, meaning that this event will match only delete events affecting the same document.

DocumentUpdatingEvent(EventFilter) - Constructor for class org.xwiki.bridge.event.DocumentUpdatingEvent

Constructor using a custom EventFilter.

E

equals(Object) - Method in class org.xwiki.bridge.AttachmentName

Deprecated.

equals(Object) - Method in class org.xwiki.bridge.DocumentName

Deprecated.

exists(DocumentReference) - Method in interface org.xwiki.bridge.DocumentAccessBridge

Check if a document exists or not in the wiki.

exists(String) - Method in interface org.xwiki.bridge.DocumentAccessBridge

Deprecated. replaced by DocumentAccessBridge.exists(DocumentReference) since 2.2.1

F

FILENAME_SEPARATOR - Static variable in class org.xwiki.bridge.internal.DefaultAttachmentNameFactory

Deprecated. Character to separate document name from filename, see createAttachmentName(String).

G

getAttachmentContent(String, String) - Method in interface org.xwiki.bridge.DocumentAccessBridge

Deprecated. use DocumentAccessBridge.getAttachmentContent(org.xwiki.model.reference.AttachmentReference) instead

getAttachmentContent(AttachmentReference) - Method in interface org.xwiki.bridge.DocumentAccessBridge

Returns the content of a document attachment.

getAttachmentContent(AttachmentName) - Method in interface org.xwiki.bridge.DocumentAccessBridge

Deprecated. replaced by DocumentAccessBridge.getAttachmentContent(org.xwiki.model.reference.AttachmentReference) since 2.2M1

getAttachmentReferences(DocumentReference) - Method in interface org.xwiki.bridge.DocumentAccessBridge

Retrieves all attachments in the passed document.

getAttachments(DocumentName) - Method in interface org.xwiki.bridge.DocumentAccessBridge

Deprecated. replaced by DocumentAccessBridge.getAttachmentReferences(DocumentReference) since 2.2M1

getAttachmentURL(String, String) - Method in interface org.xwiki.bridge.DocumentAccessBridge

Deprecated. use DocumentAccessBridge.getAttachmentURL(org.xwiki.model.reference.AttachmentReference , boolean) instead

getAttachmentURL(AttachmentReference, boolean) - Method in interface org.xwiki.bridge.DocumentAccessBridge

Retrieves the URL (either relative ie the path without the hostname and port, or the full URL) that can be used to access an attachment.

getAttachmentURL(AttachmentReference, String, boolean) - Method in interface org.xwiki.bridge.DocumentAccessBridge

Retrieves the URL (either relative ie the path without the hostname and port, or the full URL) that can be used to access an attachment.

getAttachmentURL(AttachmentName, boolean) - Method in interface org.xwiki.bridge.DocumentAccessBridge

Deprecated. replaced by DocumentAccessBridge.getAttachmentURL(AttachmentReference , boolean) since 2.2M1

getAttachmentURLs(DocumentReference, boolean) - Method in interface org.xwiki.bridge.DocumentAccessBridge

Deprecated. use DocumentAccessBridge.getAttachmentReferences(org.xwiki.model.reference.DocumentReference) instead

getAttachmentURLs(DocumentName, boolean) - Method in interface org.xwiki.bridge.DocumentAccessBridge

Deprecated. use DocumentAccessBridge.getAttachmentReferences(org.xwiki.model.reference.DocumentReference) instead

getAttachmentVersion(AttachmentReference) - Method in interface org.xwiki.bridge.DocumentAccessBridge

Returns the current version of a document attachment.

getContent() - Method in interface org.xwiki.bridge.DocumentModelBridge

Retrieves the textual content of the document.

getCurrentDocumentName() - Method in interface org.xwiki.bridge.DocumentAccessBridge

Deprecated. replaced by DocumentAccessBridge.getCurrentDocumentReference() since 2.2M1

getCurrentDocumentReference() - Method in interface org.xwiki.bridge.DocumentAccessBridge

Get the reference to the current document (found in the Context).

getCurrentUser() - Method in interface org.xwiki.bridge.DocumentAccessBridge

Utility method to retrieve the current user.

getCurrentWiki() - Method in interface org.xwiki.bridge.DocumentAccessBridge

Deprecated. replaced by ModelContext.getCurrentEntityReference() since 2.2M1

getDefaultEncoding() - Method in interface org.xwiki.bridge.DocumentAccessBridge

getDocument(String) - Method in interface org.xwiki.bridge.DocumentAccessBridge

Deprecated. use DocumentAccessBridge.getDocument(org.xwiki.model.reference.DocumentReference) instead

getDocument(DocumentReference) - Method in interface org.xwiki.bridge.DocumentAccessBridge

Get the document object associated with the passed document name.

getDocument(DocumentName) - Method in interface org.xwiki.bridge.DocumentAccessBridge

Deprecated. replaced by DocumentAccessBridge.getDocument(org.xwiki.model.reference.DocumentReference) since 2.2M1

getDocumentContent(String) - Method in interface org.xwiki.bridge.DocumentAccessBridge

Deprecated. replaced by DocumentAccessBridge.getDocument(DocumentReference) and DocumentModelBridge.getContent() since 2.2.1

getDocumentContent(DocumentReference, String) - Method in interface org.xwiki.bridge.DocumentAccessBridge

Retrieves the textual content of the document, in the given language.

getDocumentContent(String, String) - Method in interface org.xwiki.bridge.DocumentAccessBridge

Deprecated. replaced by DocumentAccessBridge.getDocumentContent(DocumentReference, String) since 2.2.1

getDocumentContentForDefaultLanguage(DocumentReference) - Method in interface org.xwiki.bridge.DocumentAccessBridge

Retrieves the textual content of the document, in the document's default language.

getDocumentContentForDefaultLanguage(String) - Method in interface org.xwiki.bridge.DocumentAccessBridge

Deprecated. replaced by DocumentAccessBridge.getDocumentContentForDefaultLanguage(DocumentReference) since 2.2.1

getDocumentName() - Method in class org.xwiki.bridge.AttachmentName

Deprecated.

getDocumentName(String) - Method in interface org.xwiki.bridge.DocumentAccessBridge

Deprecated. replaced by DocumentReferenceResolver since 2.2M1

getDocumentName() - Method in interface org.xwiki.bridge.DocumentModelBridge

Deprecated. replaced by DocumentModelBridge.getDocumentReference() since 2.2M1

getDocumentReference() - Method in interface org.xwiki.bridge.DocumentModelBridge

getDocumentSyntaxId(String) - Method in interface org.xwiki.bridge.DocumentAccessBridge

Deprecated. replaced by DocumentAccessBridge.getDocument(DocumentReference) and DocumentModelBridge.getSyntaxId() since 2.2.1

getDocumentURL(DocumentReference, String, String, String) - Method in interface org.xwiki.bridge.DocumentAccessBridge

Retrieves the internal (without the hostname) URL that can be used to access a document, using a specific action.

getDocumentURL(DocumentReference, String, String, String, boolean) - Method in interface org.xwiki.bridge.DocumentAccessBridge

Retrieves the relitive (without the hostname) or absolute (with the hostname) URL that can be used to access a document, using a specific action.

getFileName() - Method in class org.xwiki.bridge.AttachmentName

Deprecated.

getFullName() - Method in interface org.xwiki.bridge.DocumentModelBridge

Deprecated. use DocumentModelBridge.getDocumentReference() instead

getIconURL(String) - Method in interface org.xwiki.bridge.SkinAccessBridge

getOriginalDocument() - Method in interface org.xwiki.bridge.DocumentModelBridge

Retrieves a copy of the document before it was changed.

getPage() - Method in class org.xwiki.bridge.DocumentName

Deprecated.

getPageName() - Method in interface org.xwiki.bridge.DocumentModelBridge

Deprecated. since 2.2M1 use DocumentModelBridge.getDocumentReference() instead

getProperties(String, String) - Method in interface org.xwiki.bridge.DocumentAccessBridge

getProperty(String, String, int, String) - Method in interface org.xwiki.bridge.DocumentAccessBridge

Retrieves the value for an object property.

getProperty(String, String, String) - Method in interface org.xwiki.bridge.DocumentAccessBridge

Deprecated. since 2.2M1 use DocumentAccessBridge.getProperty(DocumentReference, DocumentReference, String) instead

getProperty(DocumentReference, DocumentReference, String) - Method in interface org.xwiki.bridge.DocumentAccessBridge

Retrieves the value for an object property, from the first object of the given class.

getProperty(String, String) - Method in interface org.xwiki.bridge.DocumentAccessBridge

Retrieves the value for an object property, from the first object of any class that has a property with that name.

getPropertyType(String, String) - Method in interface org.xwiki.bridge.DocumentAccessBridge

getRealLanguage() - Method in interface org.xwiki.bridge.DocumentModelBridge

Retrieve the actual language of the document variant.

getSkinFile(String) - Method in interface org.xwiki.bridge.SkinAccessBridge

Gets a specific file from the current skin.

getSpace() - Method in class org.xwiki.bridge.DocumentName

Deprecated.

getSpaceName() - Method in interface org.xwiki.bridge.DocumentModelBridge

Deprecated. since 2.2M1 use DocumentModelBridge.getDocumentReference() instead

getSyntax() - Method in interface org.xwiki.bridge.DocumentModelBridge

getSyntaxId() - Method in interface org.xwiki.bridge.DocumentModelBridge

Deprecated. since 3.0M1 use DocumentModelBridge.getSyntax() instead

getTitle() - Method in interface org.xwiki.bridge.DocumentModelBridge

getURL(String, String, String, String) - Method in interface org.xwiki.bridge.DocumentAccessBridge

Deprecated. replaced by DocumentAccessBridge.getDocumentURL(DocumentReference, String, String, String) since 2.2.1

getVersion() - Method in interface org.xwiki.bridge.DocumentModelBridge

getWiki() - Method in class org.xwiki.bridge.DocumentName

Deprecated.

getWikiId() - Method in class org.xwiki.bridge.event.AbstractWikiEvent

getWikiId() - Method in interface org.xwiki.bridge.event.WikiEvent

getWikiName() - Method in interface org.xwiki.bridge.DocumentModelBridge

Deprecated. since 2.2M1 use DocumentModelBridge.getDocumentReference() instead

getXDOM() - Method in interface org.xwiki.bridge.DocumentModelBridge

H

hashCode() - Method in class org.xwiki.bridge.AttachmentName

Deprecated.

hashCode() - Method in class org.xwiki.bridge.DocumentName

Deprecated.

hasProgrammingRights() - Method in interface org.xwiki.bridge.DocumentAccessBridge

I

isDocumentEditable(String) - Method in interface org.xwiki.bridge.DocumentAccessBridge

Deprecated. use DocumentAccessBridge.isDocumentEditable(org.xwiki.model.reference.DocumentReference) instead

isDocumentEditable(DocumentReference) - Method in interface org.xwiki.bridge.DocumentAccessBridge

isDocumentViewable(DocumentReference) - Method in interface org.xwiki.bridge.DocumentAccessBridge

isDocumentViewable(String) - Method in interface org.xwiki.bridge.DocumentAccessBridge

Deprecated. use DocumentAccessBridge.isDocumentViewable(org.xwiki.model.reference.DocumentReference) instead

isPropertyCustomMapped(String, String) - Method in interface org.xwiki.bridge.DocumentAccessBridge

O

org.xwiki.bridge - package org.xwiki.bridge

org.xwiki.bridge.event - package org.xwiki.bridge.event

org.xwiki.bridge.internal - package org.xwiki.bridge.internal

P

popDocumentFromContext(Map<String, Object>) - Method in interface org.xwiki.bridge.DocumentAccessBridge

Restore values saved in a backup object in the XWiki Context and restore the current document with the same value before DocumentAccessBridge.pushDocumentInContext(Map, String) was called.

pushDocumentInContext(Map<String, Object>, String) - Method in interface org.xwiki.bridge.DocumentAccessBridge

Deprecated. use DocumentAccessBridge.pushDocumentInContext(Map, DocumentReference) instead

pushDocumentInContext(Map<String, Object>, DocumentReference) - Method in interface org.xwiki.bridge.DocumentAccessBridge

Sets the passed document as the current document in the XWiki Context and saves current values related to the current document into a backup object.

S

serialize(AttachmentName) - Method in interface org.xwiki.bridge.AttachmentNameSerializer

Deprecated.

serialize(DocumentName) - Method in interface org.xwiki.bridge.DocumentNameSerializer

Deprecated.

serialize(AttachmentName) - Method in class org.xwiki.bridge.internal.DefaultAttachmentNameSerializer

Deprecated.

setAttachmentContent(AttachmentReference, byte[]) - Method in interface org.xwiki.bridge.DocumentAccessBridge

Sets the content of a document attachment.

setAttachmentContent(String, String, byte[]) - Method in interface org.xwiki.bridge.DocumentAccessBridge

Deprecated. replaced by DocumentAccessBridge.getAttachmentContent(AttachmentReference) since 2.2.1

setCurrentUser(String) - Method in interface org.xwiki.bridge.DocumentAccessBridge

Utility method to set the current user.

setDocumentContent(DocumentReference, String, String, boolean) - Method in interface org.xwiki.bridge.DocumentAccessBridge

Updates the target document with the new content provided.

setDocumentContent(String, String, String, boolean) - Method in interface org.xwiki.bridge.DocumentAccessBridge

Deprecated. replaced by DocumentAccessBridge.setDocumentContent(DocumentReference, String, String, boolean) since 2.2.1

setDocumentName(DocumentName) - Method in class org.xwiki.bridge.AttachmentName

Deprecated.

setDocumentParentReference(DocumentReference, DocumentReference) - Method in interface org.xwiki.bridge.DocumentAccessBridge

Sets the parent document name attribute for this document.

setDocumentSyntaxId(DocumentReference, String) - Method in interface org.xwiki.bridge.DocumentAccessBridge

Changes the syntax Id of the target document to the given syntaxId.

setDocumentSyntaxId(String, String) - Method in interface org.xwiki.bridge.DocumentAccessBridge

Deprecated. replaced by DocumentAccessBridge.setDocumentSyntaxId(DocumentReference, String) since 2.2.1

setDocumentTitle(DocumentReference, String) - Method in interface org.xwiki.bridge.DocumentAccessBridge

Sets the title of this document.

setFileName(String) - Method in class org.xwiki.bridge.AttachmentName

Deprecated.

setProperty(String, String, String, Object) - Method in interface org.xwiki.bridge.DocumentAccessBridge

Deprecated. use {@link DocumentAccessBridge#setProperty(DocumentReference, DocumentReference, String, Object)

setProperty(DocumentReference, DocumentReference, String, Object) - Method in interface org.xwiki.bridge.DocumentAccessBridge

Sets the given property of the first object (of the given class) attached to the document.

SkinAccessBridge - Interface in org.xwiki.bridge

Exposes methods for accessing Skin data.

T

toString() - Method in class org.xwiki.bridge.AttachmentName

Deprecated.

toString() - Method in class org.xwiki.bridge.DocumentName

Deprecated.

W

WikiCreatedEvent - Class in org.xwiki.bridge.event

An event triggered after a wiki is created.

WikiCreatedEvent() - Constructor for class org.xwiki.bridge.event.WikiCreatedEvent

Constructor initializing the event filter with an AlwaysMatchingEventFilter, meaning that this event will match any other document delete event.

WikiCreatedEvent(String) - Constructor for class org.xwiki.bridge.event.WikiCreatedEvent

Constructor initializing the event filter with a FixedNameEventFilter, meaning that this event will match only events affecting the same wiki.

WikiCreatedEvent(EventFilter) - Constructor for class org.xwiki.bridge.event.WikiCreatedEvent

Constructor using a custom EventFilter.

WikiDeletedEvent - Class in org.xwiki.bridge.event

An event triggered after a wiki is deleted.

WikiDeletedEvent() - Constructor for class org.xwiki.bridge.event.WikiDeletedEvent

Constructor initializing the event filter with an AlwaysMatchingEventFilter, meaning that this event will match any other document delete event.

WikiDeletedEvent(String) - Constructor for class org.xwiki.bridge.event.WikiDeletedEvent

Constructor initializing the event filter with a FixedNameEventFilter, meaning that this event will match only events affecting the same wiki.

WikiDeletedEvent(EventFilter) - Constructor for class org.xwiki.bridge.event.WikiDeletedEvent

Constructor using a custom EventFilter.

WikiEvent - Interface in org.xwiki.bridge.event

COmmon interface for all wiki related events.

A C D E F G H I O P S T W