org.eclipse.xtext.web.server.model

Class XtextWebDocument

java.lang.Object

org.eclipse.xtext.web.server.model.XtextWebDocument

All Implemented Interfaces:

IXtextWebDocument

@FinalFieldsConstructor
public class XtextWebDocument
extends java.lang.Object
implements IXtextWebDocument

Container for an XtextResource.

Constructor Summary

Constructors

Constructor and Description
XtextWebDocument(java.lang.String resourceId, DocumentSynchronizer synchronizer)

Method Summary

Modifier and Type	Method and Description
void	clearCachedServiceResults() Clear any cached result of AbstractCachedService.
void	createNewStateId() A new state id should be created whenever the text content is changed.
<T extends IServiceResult> T	getCachedServiceResult(AbstractCachedService<T> service, org.eclipse.xtext.util.CancelIndicator cancelIndicator, boolean logCacheMiss)
org.eclipse.xtext.resource.XtextResource	getResource()
java.lang.String	getResourceId()
java.lang.String	getStateId()
java.lang.String	getText()
boolean	isDirty()
protected java.lang.String	refreshText()
void	setDirty(boolean dirty)
java.lang.String	setInput(org.eclipse.xtext.resource.XtextResource resource)
void	setText(java.lang.String text) Replace the text contents of the contained resource with the given text.
java.lang.String	toString()
void	updateText(java.lang.String text, int offset, int replaceLength) Update a part of the text.

Methods inherited from class java.lang.Object

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

Constructor Detail

XtextWebDocument

public XtextWebDocument(java.lang.String resourceId,
                        DocumentSynchronizer synchronizer)

Method Detail

clearCachedServiceResults

public void clearCachedServiceResults()

Clear any cached result of AbstractCachedService. This method is called whenever the text content of the resource is modified, but it may be necessary to clear the cached services in other cases, too.

getCachedServiceResult

public <T extends IServiceResult> T getCachedServiceResult(AbstractCachedService<T> service,
                                                           org.eclipse.xtext.util.CancelIndicator cancelIndicator,
                                                           boolean logCacheMiss)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

setInput

public java.lang.String setInput(org.eclipse.xtext.resource.XtextResource resource)

refreshText

protected java.lang.String refreshText()

getStateId

public java.lang.String getStateId()

Specified by:

getStateId in interface IXtextWebDocument

setText

public void setText(java.lang.String text)

Replace the text contents of the contained resource with the given text.

Specified by:

setText in interface IXtextWebDocument

updateText

public void updateText(java.lang.String text,
                       int offset,
                       int replaceLength)

Update a part of the text.

Specified by:

updateText in interface IXtextWebDocument

createNewStateId

public void createNewStateId()

A new state id should be created whenever the text content is changed. The client must know the correct state id in order to send proper requests. If a request with an outdated state id is received by the server, the request is rejected.

Specified by:

createNewStateId in interface IXtextWebDocument

getResourceId

@Pure
public java.lang.String getResourceId()

Specified by:

getResourceId in interface IXtextWebDocument

getResource

@Pure
public org.eclipse.xtext.resource.XtextResource getResource()

Specified by:

getResource in interface IXtextWebDocument

getText

@Pure
public java.lang.String getText()

Specified by:

getText in interface IXtextWebDocument

isDirty

@Pure
public boolean isDirty()

Specified by:

isDirty in interface IXtextWebDocument

setDirty

public void setDirty(boolean dirty)

Specified by:

setDirty in interface IXtextWebDocument