org.eclipse.xtext.builder

Interface IXtextBuilderParticipant.IBuildContext

All Known Implementing Classes:

BuildContext

Enclosing interface:

IXtextBuilderParticipant

public static interface IXtextBuilderParticipant.IBuildContext

The build context provides information that may be used by the participant. This context is shared among all registered builder participants thus the deltas URI's are not necessarily matching the expected file extension.

This interface is not intended to be implemented by clients.

This interface is not intended to be implemented by clients.

This class is not intended to be subclassed by clients.

This interface is not intended to be extended by clients.

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.
org.eclipse.emf.ecore.resource.ResourceSet	getResourceSet() The correctly configured resource set for this run of the incremental project builder.
void	needRebuild() Request a rebuild after the this build run.

Method Detail

getBuiltProject

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

Returns the current project.

Returns:

the currently built project. Never null.

getDeltas

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

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.

Returns:

the list of deltas. Never null.

getResourceSet

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

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.

Returns:

the configured resource set. Never null.

getBuildType

IXtextBuilderParticipant.BuildType getBuildType()

The current build type.

Returns:

the current build type.

needRebuild

void needRebuild()

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