org.eclipse.xtext.web.server.model

Class XtextWebDocumentAccess

java.lang.Object

org.eclipse.xtext.web.server.model.XtextWebDocumentAccess

public class XtextWebDocumentAccess
extends java.lang.Object

Accessor class for documents. Use readOnly(CancelableUnitOfWork) to read the content and properties of the document, and modify(CancelableUnitOfWork, CancelableUnitOfWork) to modify them. If this accessor has been created with a required state identifier, it will check the actual state identifier of the document before granting access, and throw an exception if it does not match.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	XtextWebDocumentAccess.Factory
protected static class	XtextWebDocumentAccess.ReadAccess

Constructor Summary

Constructors

Constructor and Description
XtextWebDocumentAccess()

Method Summary

Modifier and Type	Method and Description
protected void	checkStateId()
protected IXtextWebDocument	createReadAccess(XtextWebDocument document)
protected <T> T	doAccess(org.eclipse.xtext.util.concurrent.CancelableUnitOfWork<T,IXtextWebDocument> synchronousWork, boolean priority, boolean modify, org.eclipse.xtext.util.concurrent.CancelableUnitOfWork<?,IXtextWebDocument> asynchronousWork)
protected <T extends IServiceResult> T	getCachedServiceResult(AbstractCachedService<T> service, boolean logCacheMiss)
protected void	init(XtextWebDocument document, java.lang.String requiredStateId, boolean skipAsyncWork)
<T> T	modify(org.eclipse.xtext.util.concurrent.CancelableUnitOfWork<T,IXtextWebDocument> work) Execute the given work unit with read and write access and return its result.
<T> T	modify(org.eclipse.xtext.util.concurrent.CancelableUnitOfWork<T,IXtextWebDocument> work, org.eclipse.xtext.util.concurrent.CancelableUnitOfWork<?,IXtextWebDocument> asynchronousWork) Execute the given work unit with read and write access and return its result.
protected void	performPrecomputation(org.eclipse.xtext.util.CancelIndicator cancelIndicator)
<T> T	priorityReadOnly(org.eclipse.xtext.util.concurrent.CancelableUnitOfWork<T,IXtextWebDocument> work) Execute the given work unit with read-only access and return its result.
<T> T	readOnly(org.eclipse.xtext.util.concurrent.CancelableUnitOfWork<T,IXtextWebDocument> work) Execute the given work unit with read-only access and return its result.
protected void	setExecutorServiceProvider(org.eclipse.xtext.ide.ExecutorServiceProvider executorServiceProvider)

Methods inherited from class java.lang.Object

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

Constructor Detail

XtextWebDocumentAccess

public XtextWebDocumentAccess()

Method Detail

setExecutorServiceProvider

@Inject
protected void setExecutorServiceProvider(org.eclipse.xtext.ide.ExecutorServiceProvider executorServiceProvider)

init

protected void init(XtextWebDocument document,
                    java.lang.String requiredStateId,
                    boolean skipAsyncWork)

checkStateId

protected void checkStateId()
                     throws InvalidRequestException.InvalidDocumentStateException

Throws:

InvalidRequestException.InvalidDocumentStateException

readOnly

public <T> T readOnly(org.eclipse.xtext.util.concurrent.CancelableUnitOfWork<T,IXtextWebDocument> work)

Execute the given work unit with read-only access and return its result.

priorityReadOnly

public <T> T priorityReadOnly(org.eclipse.xtext.util.concurrent.CancelableUnitOfWork<T,IXtextWebDocument> work)

Execute the given work unit with read-only access and return its result. The work unit is handled with higher priority, i.e. currently running work units are canceled if they support cancellation.

modify

public <T> T modify(org.eclipse.xtext.util.concurrent.CancelableUnitOfWork<T,IXtextWebDocument> work,
                    org.eclipse.xtext.util.concurrent.CancelableUnitOfWork<?,IXtextWebDocument> asynchronousWork)

Execute the given work unit with read and write access and return its result. The work unit is handled with higher priority, i.e. currently running work units are canceled if they support cancellation. The second work unit asynchronousWork is executed in a separate thread after the first one has finished. It can be used for background work that should be applied to the document, but is not relevant for the current service request.

modify

public <T> T modify(org.eclipse.xtext.util.concurrent.CancelableUnitOfWork<T,IXtextWebDocument> work)

Execute the given work unit with read and write access and return its result. The work unit is handled with higher priority, i.e. currently running work units are canceled if they support cancellation.

doAccess

protected <T> T doAccess(org.eclipse.xtext.util.concurrent.CancelableUnitOfWork<T,IXtextWebDocument> synchronousWork,
                         boolean priority,
                         boolean modify,
                         org.eclipse.xtext.util.concurrent.CancelableUnitOfWork<?,IXtextWebDocument> asynchronousWork)

performPrecomputation

protected void performPrecomputation(org.eclipse.xtext.util.CancelIndicator cancelIndicator)

getCachedServiceResult

protected <T extends IServiceResult> T getCachedServiceResult(AbstractCachedService<T> service,
                                                              boolean logCacheMiss)

createReadAccess

protected IXtextWebDocument createReadAccess(XtextWebDocument document)

Since:

2.11