org.eclipse.xtext.builder

Class ParallelBuilderParticipant.ParallelBuildContext

java.lang.Object

org.eclipse.xtext.builder.ParallelBuilderParticipant.ParallelBuildContext

All Implemented Interfaces:

IXtextBuilderParticipant.IBuildContext

Enclosing class:

ParallelBuilderParticipant

protected static class ParallelBuilderParticipant.ParallelBuildContext
extends java.lang.Object
implements IXtextBuilderParticipant.IBuildContext

Encapsulate all the information for the processing of a single resource on its own thread.

Since:

2.9

This method is not intended to be referenced by clients.

This class is not intended to be referenced by clients.

Constructor Summary

Constructors

Constructor and Description

ParallelBuilderParticipant.ParallelBuildContext(IResourceDescription.Delta delta, IXtextBuilderParticipant.IBuildContext buildContextDelegate, java.util.Map<java.lang.String,OutputConfiguration> outputConfigurations, java.util.Map<OutputConfiguration,java.lang.Iterable<org.eclipse.core.resources.IMarker>> generatorMarkers, FileSystemAccessQueue fileSystemAccessQueue, java.util.Queue<ParallelBuilderParticipant.ParallelBuildContext> afterGenerateQueue, EclipseResourceFileSystemAccess2 delegate, org.eclipse.core.runtime.IProgressMonitor progressMonitor)

Method Summary

Methods

Modifier and Type	Method and Description
IXtextBuilderParticipant.BuildType	getBuildType() The current build type.
org.eclipse.core.resources.IProject	getBuiltProject() Returns the current project.
java.util.List<IResourceDescription.Delta>	getDeltas() Returns the list of resource deltas that was produced by this run of the incremental project builder.
IGeneratorContext	getGeneratorContext()
org.eclipse.emf.ecore.resource.ResourceSet	getResourceSet() The correctly configured resource set for this run of the incremental project builder.
org.eclipse.emf.common.util.URI	getURI()
boolean	isSourceLevelURI(org.eclipse.emf.common.util.URI uri) Returns true if the given uri points to a resource from the workspace rather than from an archive.
void	needRebuild() Request a rebuild after the this build run.

Methods inherited from class java.lang.Object

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

Constructor Detail

ParallelBuilderParticipant.ParallelBuildContext

public ParallelBuilderParticipant.ParallelBuildContext(IResourceDescription.Delta delta,
                                               IXtextBuilderParticipant.IBuildContext buildContextDelegate,
                                               java.util.Map<java.lang.String,OutputConfiguration> outputConfigurations,
                                               java.util.Map<OutputConfiguration,java.lang.Iterable<org.eclipse.core.resources.IMarker>> generatorMarkers,
                                               FileSystemAccessQueue fileSystemAccessQueue,
                                               java.util.Queue<ParallelBuilderParticipant.ParallelBuildContext> afterGenerateQueue,
                                               EclipseResourceFileSystemAccess2 delegate,
                                               org.eclipse.core.runtime.IProgressMonitor progressMonitor)

Method Detail

getURI

public org.eclipse.emf.common.util.URI getURI()

getBuiltProject

public org.eclipse.core.resources.IProject getBuiltProject()

Description copied from interface: IXtextBuilderParticipant.IBuildContext

Returns the current project.

Specified by:

getBuiltProject in interface IXtextBuilderParticipant.IBuildContext

Returns:

the currently built project. Never null.

getDeltas

public java.util.List<IResourceDescription.Delta> getDeltas()

Description copied from interface: IXtextBuilderParticipant.IBuildContext

Returns the list of resource deltas that was produced by this run of the incremental project builder. This list is the only safe way to obtain resources that were processed by this build run. These resources may be requested from the resource set by means of getResource.

Specified by:

getDeltas in interface IXtextBuilderParticipant.IBuildContext

Returns:

the list of deltas. Never null.

getResourceSet

public org.eclipse.emf.ecore.resource.ResourceSet getResourceSet()

Description copied from interface: IXtextBuilderParticipant.IBuildContext

The correctly configured resource set for this run of the incremental project builder. Clients should not assume that the list of resources in the resource set contains anything. However, they are free to dynamically load and unload resources from the resource set. Other changes should be avoided.

Specified by:

getResourceSet in interface IXtextBuilderParticipant.IBuildContext

Returns:

the configured resource set. Never null.

getBuildType

public IXtextBuilderParticipant.BuildType getBuildType()

Description copied from interface: IXtextBuilderParticipant.IBuildContext

The current build type.

Specified by:

getBuildType in interface IXtextBuilderParticipant.IBuildContext

Returns:

the current build type.

needRebuild

public void needRebuild()

Description copied from interface: IXtextBuilderParticipant.IBuildContext

Request a rebuild after the this build run. It is necessary to call IXtextBuilderParticipant.IBuildContext.needRebuild() if this participant generates file that need to be compiled or processed by another builder.

Specified by:

needRebuild in interface IXtextBuilderParticipant.IBuildContext

isSourceLevelURI

public boolean isSourceLevelURI(org.eclipse.emf.common.util.URI uri)

Description copied from interface: IXtextBuilderParticipant.IBuildContext

Returns true if the given uri points to a resource from the workspace rather than from an archive.

Specified by:

isSourceLevelURI in interface IXtextBuilderParticipant.IBuildContext

getGeneratorContext

public IGeneratorContext getGeneratorContext()