org.springframework.roo.project

Enum Path

java.lang.Object

java.lang.Enum<Path>

org.springframework.roo.project.Path

All Implemented Interfaces:

Serializable, Comparable<Path>

public enum Path
extends Enum<Path>

Common file paths used in Maven projects.

PathResolvers can convert these paths to and from physical locations.

Since:

1.0

Author:

Ben Alex, Juan Carlos García

Enum Constant Summary

Enum Constants

Enum Constant and Description
ROOT The module's root directory.
ROOT_ROO_CONFIG The module's base directory for production Roo project configuration-related resource files.
SPRING_CONFIG_ROOT The module's base directory for production Spring-related resource files.
SRC_MAIN Main path that will contain JAVA and RESOURCES folder
SRC_MAIN_JAVA The module sub-path containing production Java source code.
SRC_MAIN_RES Alternative to SRC_MAIN_RESOURCES
SRC_MAIN_RESOURCES The module sub-path containing production resource files.
SRC_MAIN_WEBAPP The module sub-path containing web resource files.
SRC_TEST_JAVA The module sub-path containing test Java source code.
SRC_TEST_RESOURCES The module sub-path containing test resource files.

Method Summary

Modifier and Type	Method and Description
String	getDefaultLocation() Returns the default location of this path relative to the module's root directory
PhysicalPath	getModulePath(Pom pom) Returns the PhysicalPath of this Path within the module to which the given POM belongs.
LogicalPath	getModulePathId(String moduleName) Returns the LogicalPath for this path in the given module
String	getPathRelativeToPom(Pom pom) Returns the physical path of this logical Path relative to the given POM.
PhysicalPath	getRootModulePath(String projectDirectory) Returns the PhysicalPath of this Path within the root module, when no POM exists to customise its location.
boolean	isJavaSource() Indicates whether this path contains Java source code
static Path	valueOf(String name) Returns the enum constant of this type with the specified name.
static Path[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ROOT

public static final Path ROOT

The module's root directory.

SPRING_CONFIG_ROOT

public static final Path SPRING_CONFIG_ROOT

The module's base directory for production Spring-related resource files.

ROOT_ROO_CONFIG

public static final Path ROOT_ROO_CONFIG

The module's base directory for production Roo project configuration-related resource files.

SRC_MAIN

public static final Path SRC_MAIN

Main path that will contain JAVA and RESOURCES folder

SRC_MAIN_JAVA

public static final Path SRC_MAIN_JAVA

The module sub-path containing production Java source code.

SRC_MAIN_RESOURCES

public static final Path SRC_MAIN_RESOURCES

The module sub-path containing production resource files.

SRC_MAIN_RES

public static final Path SRC_MAIN_RES

Alternative to SRC_MAIN_RESOURCES

SRC_MAIN_WEBAPP

public static final Path SRC_MAIN_WEBAPP

The module sub-path containing web resource files.

SRC_TEST_JAVA

public static final Path SRC_TEST_JAVA

The module sub-path containing test Java source code.

SRC_TEST_RESOURCES

public static final Path SRC_TEST_RESOURCES

The module sub-path containing test resource files.

Method Detail

values

public static Path[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (Path c : Path.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static Path valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getDefaultLocation

public String getDefaultLocation()

Returns the default location of this path relative to the module's root directory

Returns:

a relative file path, e.g. "src/main/java"

getModulePath

public PhysicalPath getModulePath(Pom pom)

Returns the PhysicalPath of this Path within the module to which the given POM belongs.

Parameters:

pom - the POM of the module in question (required)

Returns:

a non-null instance

getModulePathId

public LogicalPath getModulePathId(String moduleName)

Returns the LogicalPath for this path in the given module

Parameters:

moduleName - can be blank for the root or only module

Returns:

a non-null instance

getPathRelativeToPom

public String getPathRelativeToPom(Pom pom)

Returns the physical path of this logical Path relative to the given POM. This implementation simply delegates to getDefaultLocation(); individual enum values can override this.

Parameters:

pom - can be null

Returns:

getRootModulePath

public PhysicalPath getRootModulePath(String projectDirectory)

Returns the PhysicalPath of this Path within the root module, when no POM exists to customise its location.

Parameters:

projectDirectory - the root directory of the user project

Returns:

a non-null instance

isJavaSource

public boolean isJavaSource()

Indicates whether this path contains Java source code

Returns:

false if it only contains other types of source code, e.g. XML config files, JSPX files, property files, etc.