org.eclipse.xtext.builder.builderState
Interface IBuilderState

All Superinterfaces:

IResourceDescription.Event.Source, IResourceDescriptions, ISelectable

All Known Implementing Classes:

AbstractBuilderState, ClusteringBuilderState

public interface IBuilderState
extends IResourceDescriptions, IResourceDescription.Event.Source

Author:

Sven Efftinge - Initial contribution and API, Sebastian Zarnekow

Nested Class Summary

Nested classes/interfaces inherited from interface org.eclipse.xtext.resource.IResourceDescriptions

IResourceDescriptions.IContextAware, IResourceDescriptions.NullImpl

Method Summary

com.google.common.collect.ImmutableList<IResourceDescription.Delta>	clean(java.util.Set<org.eclipse.emf.common.util.URI> toBeRemoved, org.eclipse.core.runtime.IProgressMonitor monitor) Remove the descriptions for the given resource-uris from the IResourceDescriptions.
com.google.common.collect.ImmutableList<IResourceDescription.Delta>	update(BuildData buildData, org.eclipse.core.runtime.IProgressMonitor monitor) Updated the underlying IResourceDescriptions according to the passed URIs.

Methods inherited from interface org.eclipse.xtext.resource.IResourceDescriptions

getAllResourceDescriptions, getResourceDescription

Methods inherited from interface org.eclipse.xtext.resource.ISelectable

getExportedObjects, getExportedObjects, getExportedObjectsByObject, getExportedObjectsByType, isEmpty

Methods inherited from interface org.eclipse.xtext.resource.IResourceDescription.Event.Source

addListener, removeListener

Method Detail

update

com.google.common.collect.ImmutableList<IResourceDescription.Delta> update(BuildData buildData,
                                                                           org.eclipse.core.runtime.IProgressMonitor monitor)

Updated the underlying IResourceDescriptions according to the passed URIs. It updates transitively affected IResourceDescription as well. The change to the underlying IResourceDescriptions is guaranteed to be atomic.

Parameters:

toBeAddedOrUpdated - a map containing URI to String, where the String is the external representation of the underlying storage.

toBeRemoved - the uris to be removed.

monitor - the progress monitor to use for reporting progress to the user. It is the caller's responsibility to call done() on the given monitor. Accepts null, indicating that no progress should be reported and that the operation cannot be canceled.

Returns:

a list of changes in the form of deltas.

clean

com.google.common.collect.ImmutableList<IResourceDescription.Delta> clean(java.util.Set<org.eclipse.emf.common.util.URI> toBeRemoved,
                                                                          org.eclipse.core.runtime.IProgressMonitor monitor)

Remove the descriptions for the given resource-uris from the IResourceDescriptions. The clean-operation is not transitive. The change to the underlying IResourceDescriptions is guaranteed to be atomic.

Parameters:

toBeRemoved - the uris or the cleaned resources.

monitor - the progress monitor to use for reporting progress to the user. It is the caller's responsibility to call done() on the given monitor. Accepts null, indicating that no progress should be reported and that the operation cannot be canceled.

Returns:

a list of changes in the form of deltas.