Package org.eclipse.xtext.ide.serializer.impl

Class ChangeSerializer

java.lang.Object

org.eclipse.xtext.ide.serializer.impl.ChangeSerializer

All Implemented Interfaces:

IChangeSerializer

public class ChangeSerializer
extends java.lang.Object
implements IChangeSerializer

Since:

2.13

Nested Class Summary

Nested classes/interfaces inherited from interface org.eclipse.xtext.ide.serializer.IChangeSerializer

IChangeSerializer.IModification<T extends org.eclipse.emf.common.notify.Notifier>

Constructor Summary

Constructors

Constructor	Description
ChangeSerializer()

Method Summary

Modifier and Type	Method	Description
<T extends org.eclipse.emf.common.notify.Notifier> void	addModification(T context, IChangeSerializer.IModification<T> modification)
protected <T extends org.eclipse.emf.common.notify.Notifier> void	apply(org.eclipse.emf.common.notify.Notifier context, IChangeSerializer.IModification<T> modification)
void	applyModifications(org.eclipse.xtext.util.IAcceptor<IEmfResourceChange> changeAcceptor)
protected void	beginRecordChanges(org.eclipse.emf.ecore.resource.Resource resource)
protected RecordingResourceUpdater	createResourceUpdater(org.eclipse.emf.ecore.resource.Resource resource)
protected RelatedResourceUpdater	createResourceUpdater(RelatedResourcesProvider.RelatedResource relatedResource)
protected void	endRecordChanges(org.eclipse.xtext.util.IAcceptor<IEmfResourceChange> changeAcceptor)
protected void	endRecordChanges(org.eclipse.xtext.util.IAcceptor<IEmfResourceChange> changeAcceptor, org.eclipse.core.runtime.IProgressMonitor monitor)
org.eclipse.xtext.formatting2.regionaccess.ITextRegionDiffBuilder	getModifiableDocument(org.eclipse.emf.ecore.resource.Resource resource)
protected <T> T	getService(org.eclipse.emf.common.util.URI uri, java.lang.Class<T> clazz)
protected <T> T	getService(org.eclipse.emf.ecore.resource.Resource resource, java.lang.Class<T> clazz)
protected java.util.List<IResourceSnapshot>	getSnapshots()
boolean	isUpdateCrossReferences()
boolean	isUpdateRelatedFiles()
protected void	resetState()
void	setProgressMonitor(org.eclipse.core.runtime.IProgressMonitor monitor)	If set, IChangeSerializer.addModification(Notifier, IModification) will report progress and check {#IProgressMonitor.isCanceled() on this monitor object.
void	setUpdateCrossReferences(boolean value)	If set to true (that's the default), cross references affected by changes made in IChangeSerializer.addModification(Notifier, IModification) will be updated.
void	setUpdateRelatedFiles(boolean value)	If set to true, (that's the default) and IChangeSerializer.isUpdateCrossReferences() is also set to true, IReferenceUpdater will also be called for files that are not directly changed by an IChangeSerializer.IModification but may contain cross references pointing to a changed files.

Methods inherited from class java.lang.Object

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

Constructor Detail

ChangeSerializer

public ChangeSerializer()

Method Detail

addModification

public <T extends org.eclipse.emf.common.notify.Notifier> void addModification(T context,
                                                                               IChangeSerializer.IModification<T> modification)

Specified by:

addModification in interface IChangeSerializer

applyModifications

public void applyModifications(org.eclipse.xtext.util.IAcceptor<IEmfResourceChange> changeAcceptor)

Specified by:

applyModifications in interface IChangeSerializer

apply

protected <T extends org.eclipse.emf.common.notify.Notifier> void apply(org.eclipse.emf.common.notify.Notifier context,
                                                                        IChangeSerializer.IModification<T> modification)

beginRecordChanges

protected void beginRecordChanges(org.eclipse.emf.ecore.resource.Resource resource)

createResourceUpdater

protected RelatedResourceUpdater createResourceUpdater(RelatedResourcesProvider.RelatedResource relatedResource)

createResourceUpdater

protected RecordingResourceUpdater createResourceUpdater(org.eclipse.emf.ecore.resource.Resource resource)

endRecordChanges

protected void endRecordChanges(org.eclipse.xtext.util.IAcceptor<IEmfResourceChange> changeAcceptor)

endRecordChanges

protected void endRecordChanges(org.eclipse.xtext.util.IAcceptor<IEmfResourceChange> changeAcceptor,
                                org.eclipse.core.runtime.IProgressMonitor monitor)

resetState

protected void resetState()

getModifiableDocument

public org.eclipse.xtext.formatting2.regionaccess.ITextRegionDiffBuilder getModifiableDocument(org.eclipse.emf.ecore.resource.Resource resource)

Specified by:

getModifiableDocument in interface IChangeSerializer

getService

protected <T> T getService(org.eclipse.emf.ecore.resource.Resource resource,
                           java.lang.Class<T> clazz)

getService

protected <T> T getService(org.eclipse.emf.common.util.URI uri,
                           java.lang.Class<T> clazz)

getSnapshots

protected java.util.List<IResourceSnapshot> getSnapshots()

isUpdateCrossReferences

public boolean isUpdateCrossReferences()

Specified by:

isUpdateCrossReferences in interface IChangeSerializer

See Also:

IChangeSerializer.setUpdateCrossReferences(boolean)

isUpdateRelatedFiles

public boolean isUpdateRelatedFiles()

Specified by:

isUpdateRelatedFiles in interface IChangeSerializer

See Also:

IChangeSerializer.setUpdateRelatedFiles(boolean)

setUpdateCrossReferences

public void setUpdateCrossReferences(boolean value)

Description copied from interface: IChangeSerializer

If set to true (that's the default), cross references affected by changes made in IChangeSerializer.addModification(Notifier, IModification) will be updated. This involves at least all cross references from files for which there is an IChangeSerializer.IModification. If IChangeSerializer.isUpdateRelatedFiles() is true, also all other cross references known by IResourceDescriptions are updated. Example: When a modification changes myElement.name from "foo" to "bar", all references pointing to "foo" are updated to "bar". Yes, that's a rename refactoring.

Specified by:

setUpdateCrossReferences in interface IChangeSerializer

See Also:

IReferenceUpdater, IChangeSerializer.setUpdateRelatedFiles(boolean)

setUpdateRelatedFiles

public void setUpdateRelatedFiles(boolean value)

Description copied from interface: IChangeSerializer

If set to true, (that's the default) and IChangeSerializer.isUpdateCrossReferences() is also set to true, IReferenceUpdater will also be called for files that are not directly changed by an IChangeSerializer.IModification but may contain cross references pointing to a changed files.

Specified by:

setUpdateRelatedFiles in interface IChangeSerializer

setProgressMonitor

public void setProgressMonitor(org.eclipse.core.runtime.IProgressMonitor monitor)

Description copied from interface: IChangeSerializer

If set, IChangeSerializer.addModification(Notifier, IModification) will report progress and check {#IProgressMonitor.isCanceled() on this monitor object.

Specified by:

setProgressMonitor in interface IChangeSerializer