org.springframework.roo.project

Class AbstractPathResolvingStrategy

java.lang.Object

org.springframework.roo.project.AbstractPathResolvingStrategy

All Implemented Interfaces:

PathResolvingStrategy

Direct Known Subclasses:

DefaultPathResolvingStrategy, MavenPathResolvingStrategy

public abstract class AbstractPathResolvingStrategy
extends Object
implements PathResolvingStrategy

Convenient superclass for PathResolvingStrategy implementations.

Since:

1.2.0

Author:

Andrew Swan

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	ROOT_MODULE

Constructor Summary

Constructors

Constructor and Description
AbstractPathResolvingStrategy()

Method Summary

Modifier and Type	Method and Description
protected void	activate(org.osgi.service.component.ComponentContext context)
protected abstract PhysicalPath	getApplicablePhysicalPath(String identifier)
String	getFriendlyName(String identifier) Converts the presented canonical path into a human-friendly name.
LogicalPath	getPath(String identifier) Attempts to determine which Path the specified canonical path falls under.
Collection<LogicalPath>	getPaths()
protected abstract Collection<LogicalPath>	getPaths(boolean sourceOnly) Obtains the Paths.
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()
Collection<LogicalPath>	getSourcePaths()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.roo.project.PathResolvingStrategy

getCanonicalPath, getCanonicalPath, getFocusedCanonicalPath, getFocusedIdentifier, getFocusedPath, getFocusedRoot, getIdentifier, getIdentifier, getPath, getRoot, isActive

Field Detail

ROOT_MODULE

protected static final String ROOT_MODULE

See Also:

Constant Field Values

Constructor Detail

AbstractPathResolvingStrategy

public AbstractPathResolvingStrategy()

Method Detail

activate

protected void activate(org.osgi.service.component.ComponentContext context)

getApplicablePhysicalPath

protected abstract PhysicalPath getApplicablePhysicalPath(String identifier)

getFriendlyName

public String getFriendlyName(String identifier)

Description copied from interface: PathResolvingStrategy

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

Specified by:

getFriendlyName in interface PathResolvingStrategy

Parameters:

identifier - to resolve (required)

Returns:

a human-friendly name for the identifier (required)

getPath

public LogicalPath getPath(String identifier)

Description copied from interface: PathResolvingStrategy

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

Specified by:

getPath in interface PathResolvingStrategy

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

Specified by:

getPaths in interface PathResolvingStrategy

See Also:

PathResolver.getPaths()

getPaths

protected abstract Collection<LogicalPath> getPaths(boolean sourceOnly)

Obtains the Paths.

Parameters:

requireSource - true to return only paths containing Java source code, or false to return all paths

Returns:

the matching paths (never null)

getRelativeSegment

public String getRelativeSegment(String identifier)

Description copied from interface: PathResolvingStrategy

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 PathResolvingStrategy

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

Specified by:

getRoot in interface PathResolvingStrategy

Returns:

the directory where Roo was launched

getSourcePaths

public Collection<LogicalPath> getSourcePaths()

Specified by:

getSourcePaths in interface PathResolvingStrategy

See Also:

PathResolver.getSourcePaths()