org.eclipse.xtext.builder.impl

Class QueuedBuildData

java.lang.Object

org.eclipse.xtext.builder.impl.QueuedBuildData

public class QueuedBuildData
extends java.lang.Object

An extensible implementation that allows third party plugins to contribute deltas for changes which should be processed by the Xtext builder in subsequent runs. Clients who want to contribute plain deltas should use queueChanges(List) or #queueChange(Delta) to announce a delta. If a client wants to announce a special kind of delta, a IQueuedBuildDataContribution could be necessary that can handle this contribution.

Author:

Sebastian Zarnekow - Initial contribution and API

See Also:

IQueuedBuildDataContribution

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	QueuedBuildData.CompositeContribution A composite structure for contributions.
static class	QueuedBuildData.NullContribution

Constructor Summary

Constructors

Constructor and Description
QueuedBuildData(IStorage2UriMapper mapper)
QueuedBuildData(IStorage2UriMapper mapper, IQueuedBuildDataContribution contribution) Public for testing purpose

Method Summary

Methods

Modifier and Type	Method and Description
void	createCheckpoint()
void	discardCheckpoint()
java.lang.Iterable<org.eclipse.emf.common.util.URI>	getAllRemainingURIs()
java.util.Collection<IResourceDescription.Delta>	getAndRemovePendingDeltas()
java.util.Queue<org.eclipse.emf.common.util.URI>	getQueue(java.lang.String projectName)
boolean	isEmpty(java.lang.String projectName)
boolean	needRebuild(org.eclipse.core.resources.IProject project) Returns true if rebuild is required; otherwise false.
void	queueChange(IResourceDescription.Delta delta)
void	queueChanges(java.util.List<IResourceDescription.Delta> deltas)
void	queueURI(org.eclipse.emf.common.util.URI uri)
void	queueURIs(java.util.Collection<org.eclipse.emf.common.util.URI> uris)
void	reset()
void	reset(org.eclipse.core.resources.IProject project)
void	rollback()

Methods inherited from class java.lang.Object

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

Constructor Detail

QueuedBuildData

@Inject
public QueuedBuildData(IStorage2UriMapper mapper)

QueuedBuildData

public QueuedBuildData(IStorage2UriMapper mapper,
               IQueuedBuildDataContribution contribution)

Public for testing purpose

This method is not intended to be referenced by clients.

This constructor is not intended to be referenced by clients.

Method Detail

reset

public void reset()

reset

public void reset(org.eclipse.core.resources.IProject project)

needRebuild

public boolean needRebuild(org.eclipse.core.resources.IProject project)

Returns true if rebuild is required; otherwise false.

Parameters:

project - the project that may have to be rebuild.

Returns:

true if rebuild is required; otherwise false. Default is false.

See Also:

IQueuedBuildDataContribution.needsRebuild(IProject, Collection)

queueChanges

public void queueChanges(java.util.List<IResourceDescription.Delta> deltas)

queueChange

public void queueChange(IResourceDescription.Delta delta)

queueURIs

public void queueURIs(java.util.Collection<org.eclipse.emf.common.util.URI> uris)

queueURI

public void queueURI(org.eclipse.emf.common.util.URI uri)

getAndRemovePendingDeltas

public java.util.Collection<IResourceDescription.Delta> getAndRemovePendingDeltas()

isEmpty

public boolean isEmpty(java.lang.String projectName)

getQueue

public java.util.Queue<org.eclipse.emf.common.util.URI> getQueue(java.lang.String projectName)

getAllRemainingURIs

public java.lang.Iterable<org.eclipse.emf.common.util.URI> getAllRemainingURIs()

createCheckpoint

public void createCheckpoint()

discardCheckpoint

public void discardCheckpoint()

rollback

public void rollback()