org.springframework.roo.project

Class DelegatePathResolver

java.lang.Object

org.springframework.roo.project.DelegatePathResolver

All Implemented Interfaces:

PathResolver

@Service
 @Reference(name="pathResolvingStrategy",
           strategy=EVENT,
           policy=DYNAMIC,
           referenceInterface=PathResolvingStrategy.class,
           cardinality=OPTIONAL_MULTIPLE)
public class DelegatePathResolver
extends Object
implements PathResolver

Abstract PathResolver implementation.

Subclasses should be created for common build system structures.

Since:

1.0

Author:

Ben Alex

Constructor Summary

Constructors

Constructor and Description
DelegatePathResolver()

Method Summary

Modifier and Type	Method and Description
protected void	bindPathResolvingStrategy(PathResolvingStrategy strategy)
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 moduleName, 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.
protected void	unbindPathResolvingStrategy(PathResolvingStrategy strategy)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DelegatePathResolver

public DelegatePathResolver()

Method Detail

bindPathResolvingStrategy

protected void bindPathResolvingStrategy(PathResolvingStrategy strategy)

getCanonicalPath

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

Description copied from interface: PathResolver

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

Specified by:

getCanonicalPath in interface PathResolver

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)

getCanonicalPath

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

Description copied from interface: PathResolver

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

Specified by:

getCanonicalPath in interface PathResolver

Returns:

getFocusedCanonicalPath

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

Description copied from interface: PathResolver

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

Specified by:

getFocusedCanonicalPath in interface PathResolver

Returns:

getFocusedIdentifier

public String getFocusedIdentifier(Path path,
                                   String relativePath)

Description copied from interface: PathResolver

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

Specified by:

getFocusedIdentifier in interface PathResolver

Returns:

a canonical path

getFocusedPath

public LogicalPath getFocusedPath(Path path)

Description copied from interface: PathResolver

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

Specified by:

getFocusedPath in interface PathResolver

Parameters:

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

Returns:

a non-null instance

getFocusedRoot

public String getFocusedRoot(Path path)

Specified by:

getFocusedRoot in interface PathResolver

Returns:

getFriendlyName

public String getFriendlyName(String identifier)

Description copied from interface: PathResolver

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

Specified by:

getFriendlyName in interface PathResolver

Parameters:

identifier - to resolve (required)

Returns:

a human-friendly name for the identifier (required)

getIdentifier

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

Description copied from interface: PathResolver

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

Specified by:

getIdentifier in interface PathResolver

Returns:

a canonical path

getIdentifier

public String getIdentifier(LogicalPath path,
                            String relativePath)

Description copied from interface: PathResolver

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

Specified by:

getIdentifier in interface PathResolver

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)

getPath

public LogicalPath getPath(String moduleName,
                           Path path)

Description copied from interface: PathResolver

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

Specified by:

getPath in interface PathResolver

path - the path within the specified module (required)

Returns:

a non-null instance

getPath

public LogicalPath getPath(String identifier)

Description copied from interface: PathResolver

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

Specified by:

getPath in interface PathResolver

Parameters:

identifier - to lookup (required)

Returns:

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

getPaths

public Collection<LogicalPath> getPaths()

Description copied from interface: PathResolver

Returns all known paths within the user project.

Specified by:

getPaths in interface PathResolver

Returns:

a non-null list

getRelativeSegment

public String getRelativeSegment(String identifier)

Description copied from interface: PathResolver

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.

Specified by:

getRelativeSegment in interface PathResolver

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

public String getRoot()

Description copied from interface: PathResolver

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

Specified by:

getRoot in interface PathResolver

Returns:

a valid directory path

getRoot

public String getRoot(LogicalPath path)

Description copied from interface: PathResolver

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

Specified by:

getRoot in interface PathResolver

Parameters:

path - to lookup (required)

Returns:

null if the root path cannot be determined

getSourcePaths

public Collection<LogicalPath> getSourcePaths()

Description copied from interface: PathResolver

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

Specified by:

getSourcePaths in interface PathResolver

Returns:

a non-null list

unbindPathResolvingStrategy

protected void unbindPathResolvingStrategy(PathResolvingStrategy strategy)