org.eclipse.xtend.lib.macro.file

Interface FileLocations

All Known Subinterfaces:

CodeGenerationContext, RegisterGlobalsContext, TransformationContext, ValidationContext

All Known Implementing Classes:

FileLocationsImpl

@Beta
public interface FileLocations

A service which provides information about the location of a path.

Author:

Sven Efftinge

This interface is not intended to be implemented by clients.

This interface is not intended to be implemented by clients.

Method Summary

Methods

Modifier and Type	Method and Description
Path	getProjectFolder(Path path) Returns the project root for the given resource handle.
java.util.Set<Path>	getProjectSourceFolders(Path path)
Path	getSourceFolder(Path path) Returns the source folder the given handle is contained in or null if the given Path is not located in a source folder.
Path	getTargetFolder(Path sourceFolder) Returns the target folder for the given source folder or null if the given folder is not a source folder or doesn't have a configured target folder.

Method Detail

getSourceFolder

Path getSourceFolder(Path path)

Returns the source folder the given handle is contained in or null if the given Path is not located in a source folder.

Parameters:

path - an absolute path to a resource

Returns:

the source folder the given handle is contained in or null if the given Path is not located in a source folder.

See Also:

Path

getTargetFolder

Path getTargetFolder(Path sourceFolder)

Returns the target folder for the given source folder or null if the given folder is not a source folder or doesn't have a configured target folder.

Parameters:

sourceFolder - the source folder to find the configured target folder for.

Returns:

the target folder

getProjectFolder

Path getProjectFolder(Path path)

Returns the project root for the given resource handle.

Parameters:

path - an absolute path

Returns:

the project's root

getProjectSourceFolders

java.util.Set<Path> getProjectSourceFolders(Path path)

Parameters:

path - an absolute path

Returns:

the source folders of the project the given path is contained in

Since:

2.8