org.eclipse.xtext.workspace

Interface IProjectConfig

All Known Implementing Classes:

FileProjectConfig, UnknownProjectConfig

public interface IProjectConfig

A project is both a container for source folders as well as a physical location that outputs can be generated to. In Eclipse, Maven and Gradle the concept is called a "Project". In IntelliJ it is called a "Module"

Method Summary

Modifier and Type	Method and Description
ISourceFolder	findSourceFolderContaining(org.eclipse.emf.common.util.URI member) Finds the source folder that physically contains this member or null if none was found.
java.lang.String	getName()
org.eclipse.emf.common.util.URI	getPath() The (platform dependent) physical location of the project.
java.util.Set<? extends ISourceFolder>	getSourceFolders()
IWorkspaceConfig	getWorkspaceConfig()
default boolean	isIndexOnly() During the build, projects are indexed, validated and compiled.

Method Detail

getName

java.lang.String getName()

getPath

org.eclipse.emf.common.util.URI getPath()

The (platform dependent) physical location of the project. The path will always end in a trailing separator. It will never be null.

getSourceFolders

java.util.Set<? extends ISourceFolder> getSourceFolders()

Returns:

a set of all source folders

findSourceFolderContaining

ISourceFolder findSourceFolderContaining(org.eclipse.emf.common.util.URI member)

Finds the source folder that physically contains this member or null if none was found.

getWorkspaceConfig

IWorkspaceConfig getWorkspaceConfig()

Returns:

the workspace config

isIndexOnly

default boolean isIndexOnly()

During the build, projects are indexed, validated and compiled. The return of this method configures whether this project is validated and compiled or not.

Returns:

true if this project is indexed only

Since:

2.21