org.springframework.roo.project

Class LogicalPath

java.lang.Object

org.springframework.roo.project.LogicalPath

public class LogicalPath
extends Object

A given Path within the context of a specific project module.

To obtain the physical location on the file system, pass an instance of this class to the PathResolver.

Since:

1.2.0

Author:

James Tyrrell

Field Summary

Fields

Modifier and Type	Field and Description
static String	MODULE_PATH_SEPARATOR The character that appears between the module name and the path name in the textual representation of a LogicalPath.
static String	PATH_SEPARATOR The character that separates "folders" in the textual representation of a LogicalPath.

Method Summary

Modifier and Type	Method and Description
int	compareTo(LogicalPath o)
boolean	equals(Object obj)
static LogicalPath	getInstance(Path path, String module) Creates an instance with the given path in the given module
static LogicalPath	getInstance(String modulePlusPath) Creates a LogicalPath by parsing the given concatenation of optional module name and mandatory path name.
String	getModule() Returns the name of the module containing this path, if any
String	getName() Returns the display name of this LogicalPath.
Path	getPath() Returns the path component of this LogicalPath
String	getPathRelativeToPom(Pom pom) Returns the physical path of this logical path relative to the given POM
int	hashCode()
boolean	isModuleRoot() Indicates whether this is the root of the owning module.
boolean	isProjectRoot() Indicates whether this is the root of the entire user project.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

MODULE_PATH_SEPARATOR

public static final String MODULE_PATH_SEPARATOR

The character that appears between the module name and the path name in the textual representation of a LogicalPath. This cannot be any character that could feasibly occur in a module name or Path name.

See Also:

Constant Field Values

PATH_SEPARATOR

public static final String PATH_SEPARATOR

The character that separates "folders" in the textual representation of a LogicalPath.

See Also:

Constant Field Values

Method Detail

getInstance

public static LogicalPath getInstance(Path path,
                                      String module)

Creates an instance with the given path in the given module

Parameters:

path - the path to set (required)

module - can be blank for none

Returns:

a non-null instance

getInstance

public static LogicalPath getInstance(String modulePlusPath)

Creates a LogicalPath by parsing the given concatenation of optional module name and mandatory path name.

Parameters:

modulePlusPath - a string consisting of an optional module name plus the MODULE_PATH_SEPARATOR plus the path, or more precisely: [module_name":"]path

compareTo

public int compareTo(LogicalPath o)

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

getModule

public String getModule()

Returns the name of the module containing this path, if any

Returns:

a non-null name (might be empty)

getName

public String getName()

Returns the display name of this LogicalPath.

Returns:

a non-blank name

getPath

public Path getPath()

Returns the path component of this LogicalPath

Returns:

a non-null path

getPathRelativeToPom

public String getPathRelativeToPom(Pom pom)

Returns the physical path of this logical path relative to the given POM

Parameters:

pom - can be null

Returns:

a non-null path

hashCode

public int hashCode()

Overrides:

hashCode in class Object

isModuleRoot

public boolean isModuleRoot()

Indicates whether this is the root of the owning module.

Returns:

see above

isProjectRoot

public boolean isProjectRoot()

Indicates whether this is the root of the entire user project.

Returns:

see above

toString

public final String toString()

Overrides:

toString in class Object