org.guvnor.common.services.project.service

Interface ProjectResourceResolver<T extends Project>

All Known Subinterfaces:

ProjectService<T>

public interface ProjectResourceResolver<T extends Project>

Method Summary

Modifier and Type	Method and Description
boolean	isPom(Path resource) Return true if the file is the Project's pom.xml file
Package	resolveDefaultPackage(Project project)
Path	resolveDefaultPath(Package pkg, String resourceType) Given a package and a resource extension resolves the target path where the resource should be placed by default.
Package	resolveDefaultWorkspacePackage(Project project)
Package	resolvePackage(Path resource) Given a Resource path resolve it to the containing Package Path.
Set<Package>	resolvePackages(Package pkg)
Set<Package>	resolvePackages(Project project) Given a Project resolves the calculation of all the packages for this project.
Package	resolveParentPackage(Package pkg)
Project	resolveParentProject(Path resource)
T	resolveProject(Path resource) Given a Resource path resolve it to the containing Project Path.
Project	resolveToParentProject(Path resource)

Method Detail

resolveProject

T resolveProject(Path resource)

Given a Resource path resolve it to the containing Project Path. A Project path is the folder containing pom.xml

Parameters:

resource -

Returns:

Path to the folder containing the Project's pom.xml file or null if the resource was not in a Project

resolveParentProject

Project resolveParentProject(Path resource)

resolveToParentProject

Project resolveToParentProject(Path resource)

resolvePackages

Set<Package> resolvePackages(Project project)

Given a Project resolves the calculation of all the packages for this project.

Parameters:

project -

Returns:

Collection containing all the packages for the project.

resolvePackages

Set<Package> resolvePackages(Package pkg)

resolveDefaultPackage

Package resolveDefaultPackage(Project project)

resolveDefaultWorkspacePackage

Package resolveDefaultWorkspacePackage(Project project)

resolveParentPackage

Package resolveParentPackage(Package pkg)

resolveDefaultPath

Path resolveDefaultPath(Package pkg,
                        String resourceType)

Given a package and a resource extension resolves the target path where the resource should be placed by default. e.g. for a package org.kie and a drl extension, the by default target path will be src/main/resources/org/kie, and for a java extension with the same package the by default target path will be src/main/java/org/kie

Parameters:

pkg - A package within a project.

resourceType - a file extension.

Returns:

the expected by default path for the given extension.

isPom

boolean isPom(Path resource)

Return true if the file is the Project's pom.xml file

Parameters:

resource -

Returns:

resolvePackage

Package resolvePackage(Path resource)

Given a Resource path resolve it to the containing Package Path. A Package path is the folder containing the resource. The folder must be within a valid Project structure and at least reference /src/main/java, /src/main/resources, src/test/java or src/test/resources (or deeper).

Parameters:

resource -

Returns:

Path to the folder containing the resource file or null if the resource is not in a Package.