org.springframework.roo.project

Interface PathResolvingStrategy

All Known Implementing Classes:

AbstractPathResolvingStrategy, DefaultPathResolvingStrategy, MavenPathResolvingStrategy

public interface PathResolvingStrategy

A strategy for resolving logical Paths to physical file system locations.

Since:

1.2.0

Author:

James Tyrrell

Method Summary

Modifier and Type	Method and Description
String	getCanonicalPath(LogicalPath path, org.springframework.roo.model.JavaType javaType)
String	getCanonicalPath(String moduleName, Path path, org.springframework.roo.model.JavaType javaType)
String	getFocusedCanonicalPath(Path path, org.springframework.roo.model.JavaType javaType)
String	getFocusedIdentifier(Path path, String relativePath)
LogicalPath	getFocusedPath(Path path)
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 LogicalPath and relative path.
String	getIdentifier(String moduleName, Path path, String relativePath)
LogicalPath	getPath(String identifier) Attempts to determine which Path the specified canonical path falls under.
LogicalPath	getPath(String moduleName, Path path)
Collection<LogicalPath>	getPaths()
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()
String	getRoot(LogicalPath path)
Collection<LogicalPath>	getSourcePaths()
boolean	isActive() Indicates whether this strategy is active.

Method Detail

getCanonicalPath

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

Parameters:

path - the focus path

javaType - the type t

Returns:

getCanonicalPath

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

Parameters:

moduleName -

path -

javaType -

Returns:

getFocusedCanonicalPath

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

Parameters:

path -

javaType -

Returns:

getFocusedIdentifier

String getFocusedIdentifier(Path path,
                            String relativePath)

Parameters:

path -

relativePath -

Returns:

getFocusedPath

LogicalPath getFocusedPath(Path path)

See Also:

PathResolver.getFocusedPath(Path)

getFocusedRoot

String getFocusedRoot(Path path)

Parameters:

path -

Returns:

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 LogicalPath 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)

See Also:

PathResolver.getIdentifier(String, Path, String)

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 moduleName,
                    Path path)

See Also:

PathResolver.getPath(String, Path)

getPaths

Collection<LogicalPath> getPaths()

See Also:

PathResolver.getPaths()

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 directory where Roo was launched

getRoot

String getRoot(LogicalPath path)

See Also:

PathResolver.getRoot(LogicalPath)

getSourcePaths

Collection<LogicalPath> getSourcePaths()

See Also:

PathResolver.getSourcePaths()

isActive

boolean isActive()

Indicates whether this strategy is active. The PathResolver will typically expect exactly one strategy to be active at a time.

Returns:

see above