org.eclipse.xtext.web.server.model

Class UpdateDocumentService

java.lang.Object

org.eclipse.xtext.web.server.model.UpdateDocumentService

public class UpdateDocumentService
extends java.lang.Object

Service class for document updates. This service only makes sense with a stateful server, where the server-side document representation is updated after each modification. This can greatly improve response times compared to the stateless alternative, where the full text content is sent with each service request.

Constructor Summary

Constructors

Constructor and Description
UpdateDocumentService()

Method Summary

Modifier and Type	Method and Description
DocumentStateResult	getStateId(XtextWebDocumentAccess document) Return the current state identifier.
DocumentStateResult	updateDeltaText(XtextWebDocumentAccess document, java.lang.String deltaText, int offset, int replaceLength) Update the state identifier and return it.
DocumentStateResult	updateFullText(XtextWebDocumentAccess document, java.lang.String fullText) Update the state identifier and return it.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

UpdateDocumentService

public UpdateDocumentService()

Method Detail

updateFullText

public DocumentStateResult updateFullText(XtextWebDocumentAccess document,
                                          java.lang.String fullText)
                                   throws InvalidRequestException

Update the state identifier and return it. A background process is started where the given text is assigned to the document and the services registered in PrecomputedServiceRegistry are invoked.

Throws:

InvalidRequestException

updateDeltaText

public DocumentStateResult updateDeltaText(XtextWebDocumentAccess document,
                                           java.lang.String deltaText,
                                           int offset,
                                           int replaceLength)
                                    throws InvalidRequestException

Update the state identifier and return it. A background process is started where the given text change is applied to the document and the services registered in PrecomputedServiceRegistry are invoked.

Throws:

InvalidRequestException

getStateId

public DocumentStateResult getStateId(XtextWebDocumentAccess document)
                               throws InvalidRequestException

Return the current state identifier. If the services registered in PrecomputedServiceRegistry are not cached yet, they are invoked in a background process.

Throws:

InvalidRequestException