org.safs.projects.common.projects.pojo

Class POJOProject

java.lang.Object

org.safs.projects.common.projects.pojo.POJOProject

public class POJOProject
extends java.lang.Object

This is a POJO implementation if a Project similar to the Eclipse IProject. This implementation will be used by a project that does not use something like Eclipse. Those projects should call the init() method. For projects that use something like Eclipse, they will likely use a subclass that will hold an Eclipse IProject and will delegate calls to it. They are not required to call the init() method.

Constructor Summary

Constructors

Constructor and Description
POJOProject(java.lang.String projectName)

Method Summary

Modifier and Type	Method and Description
java.io.File	getBinDir() Returns the "bin" directory at the root of this project.
POJOFolder	getFolder(java.lang.String path) Gets the location of a path relative to the root of this project.
POJOPath	getLocation() Gets the location of this project as a POJOPath.
java.lang.String	getName()
POJOPackageFragment[]	getPackageFragments() Get package fragments.
java.io.File	getProjectDir() Get the File which corresponds to the root of the project.
java.lang.String	getSrcDir() Should only be used for the SAMPLE project at this moment.
static void	init(java.io.File workspaceDir) Called to supply the directory of the workspace root.

Methods inherited from class java.lang.Object

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

Constructor Detail

POJOProject

public POJOProject(java.lang.String projectName)

Method Detail

init

public static void init(java.io.File workspaceDir)

Called to supply the directory of the workspace root.

Parameters:

workspaceDir -

getName

public java.lang.String getName()

getLocation

public POJOPath getLocation()

Gets the location of this project as a POJOPath. Subclasses are expected to overwrite this method and call a delegate's getLocation method (such as Eclipse's IProject).

Returns:

the POJOPath of the location of the project.

getFolder

public POJOFolder getFolder(java.lang.String path)

Gets the location of a path relative to the root of this project. Subclasses are expected to overwrite this method and call a delegate's getFolder method (such as Eclipse's IProject).

Parameters:

path - relative path under this project's root.

Returns:

the POJOFolder corresponding to the input path.

getBinDir

public java.io.File getBinDir()

Returns the "bin" directory at the root of this project.

Returns:

getSrcDir

public java.lang.String getSrcDir()

Should only be used for the SAMPLE project at this moment. Returns the path to the source directory.

Returns:

getPackageFragments

public POJOPackageFragment[] getPackageFragments()
                                          throws java.lang.Exception

Get package fragments. The implementation of the POJOProject super class will return an array of size one with a POJOPackageFragment that corresponds to the directory name of the first directory listed under the source directory. It is guaranteed to only work with the SAMPLE project for now. Subclasses are expected to overwrite this method and call a delegate's getPackageFragments method (such as Eclipse's IProject).

Returns:

Throws:

java.lang.Exception

getProjectDir

public java.io.File getProjectDir()

Get the File which corresponds to the root of the project.

Returns: