org.springframework.roo.project

Interface PathResolver

All Known Implementing Classes:

DelegatePathResolver

public interface PathResolver

Allows resolution between File, Path and canonical path Strings.

Add-ons should use this class as their primary mechanism to resolve paths in order to maximize future compatibility with any design refactoring, project structural enhancements or alternate build systems. Add-ons should generally avoid using File directly.

Since:

1.0

Author:

Ben Alex

Method Summary

Modifier and Type	Method and Description
String	getCanonicalPath(LogicalPath path, org.springframework.roo.model.JavaType javaType) Returns the canonical path to the given JavaType within the given LogicalPath
String	getCanonicalPath(String moduleName, Path path, org.springframework.roo.model.JavaType javaType) Returns the canonical path of the given JavaType in the given Path of the module.
String	getFocusedCanonicalPath(Path path, org.springframework.roo.model.JavaType javaType) Returns the canonical path of the given JavaType in the given Path of the currently focused module.
String	getFocusedIdentifier(Path path, String relativePath) Returns the canonical path of the given path relative to the given Path of the currently focused module.
LogicalPath	getFocusedPath(Path path) Returns the LogicalPath for the given Path within the currently focused module.
String	getFocusedRoot(Path path)
String	getFriendlyName(String identifier) Converts the presented canonical path into a human-friendly name.
String	getIdentifier(LogicalPath path, String relativePath) Produces a canonical path for the presented Path and relative path.
String	getIdentifier(String moduleName, Path path, String relativePath) Returns the canonical path of the given path relative to the given Path of the specified module.
LogicalPath	getPath(String identifier) Attempts to determine which Path the specified canonical path falls under.
LogicalPath	getPath(String modelName, Path path) Returns the LogicalPath for the given Path within the specified module.
Collection<LogicalPath>	getPaths() Returns all known paths within the user project.
String	getRelativeSegment(String identifier) Attempts to determine which Path the specified canonical path falls under, and then returns the relative portion of the file name.
String	getRoot() Returns the canonical path of the user project's root directory
String	getRoot(LogicalPath path) Returns the canonical path of the root of the given LogicalPath.
Collection<LogicalPath>	getSourcePaths() Returns the LogicalPaths of user project directories that can contain Java source code.

Method Detail

getCanonicalPath

String getCanonicalPath(LogicalPath path,
                        org.springframework.roo.model.JavaType javaType)

Returns the canonical path to the given JavaType within the given LogicalPath

Parameters:

path - the path to the type's base package (required)

javaType - the type for which to get the path (required)

Returns:

a valid canonical path (N.B. this file might not exist)

Since:

1.2.0

getCanonicalPath

String getCanonicalPath(String moduleName,
                        Path path,
                        org.springframework.roo.model.JavaType javaType)

Returns the canonical path of the given JavaType in the given Path of the module.

Parameters:

moduleName -

path -

javaType -

Returns:

Since:

2.0

getFocusedCanonicalPath

String getFocusedCanonicalPath(Path path,
                               org.springframework.roo.model.JavaType javaType)

Returns the canonical path of the given JavaType in the given Path of the currently focused module.

Parameters:

path -

javaType -

Returns:

Since:

1.2.0

getFocusedIdentifier

String getFocusedIdentifier(Path path,
                            String relativePath)

Returns the canonical path of the given path relative to the given Path of the currently focused module.

Parameters:

path -

relativePath -

Returns:

a canonical path

Since:

1.2.0

getFocusedPath

LogicalPath getFocusedPath(Path path)

Returns the LogicalPath for the given Path within the currently focused module.

Parameters:

path - the path within the currently focused module (required)

Returns:

a non-null instance

Since:

1.2.0

getFocusedRoot

String getFocusedRoot(Path path)

Parameters:

path -

Returns:

Since:

1.2.0

getFriendlyName

String getFriendlyName(String identifier)

Converts the presented canonical path into a human-friendly name.

Parameters:

identifier - to resolve (required)

Returns:

a human-friendly name for the identifier (required)

getIdentifier

String getIdentifier(LogicalPath path,
                     String relativePath)

Produces a canonical path for the presented Path and relative path.

Parameters:

path - to use (required)

relativePath - to use (cannot be null, but may be empty if referring to the path itself)

Returns:

the canonical path to the file (never null)

getIdentifier

String getIdentifier(String moduleName,
                     Path path,
                     String relativePath)

Returns the canonical path of the given path relative to the given Path of the specified module.

Parameters:

moduleName -

path -

relativePath -

Returns:

a canonical path

Since:

2.0

getPath

LogicalPath getPath(String identifier)

Attempts to determine which Path the specified canonical path falls under.

Parameters:

identifier - to lookup (required)

Returns:

the Path, or null if the identifier refers to a location not under a know path.

getPath

LogicalPath getPath(String modelName,
                    Path path)

Returns the LogicalPath for the given Path within the specified module.

Parameters:

moduleName - the specified module (required)

path - the path within the specified module (required)

Returns:

a non-null instance

Since:

2.0

getPaths

Collection<LogicalPath> getPaths()

Returns all known paths within the user project.

Returns:

a non-null list

getRelativeSegment

String getRelativeSegment(String identifier)

Attempts to determine which Path the specified canonical path falls under, and then returns the relative portion of the file name.

See FileDetails.getRelativeSegment(String) for related information.

Parameters:

identifier - to resolve (required)

Returns:

the relative segment (which may be an empty string if the identifier referred to the Path directly), or null if the identifier does not have a corresponding Path

getRoot

String getRoot()

Returns the canonical path of the user project's root directory

Returns:

a valid directory path

getRoot

String getRoot(LogicalPath path)

Returns the canonical path of the root of the given LogicalPath.

Parameters:

path - to lookup (required)

Returns:

null if the root path cannot be determined

getSourcePaths

Collection<LogicalPath> getSourcePaths()

Returns the LogicalPaths of user project directories that can contain Java source code.

Returns:

a non-null list