ej.tool.addon

Interface JavaProject

public interface JavaProject

A Java project represents a view of a project resource in terms of Java elements such as project root folder, Ivy module, source folders and classpath.

Method Summary

Modifier and Type	Method and Description
List<File>	getClasspath() Gets this project classpath.
List<File>	getFolders(FolderKind... kinds) Gets project folders of the given kinds.
File	getIvyModule() Gets the path to the project Ivy module file.
File	getProjectFolder() Gets this project root folder.
boolean	isFolderKind(File folder, FolderKind kind) Gets if the given folder is of the given kind.

Method Detail

getClasspath

List<File> getClasspath()

Gets this project classpath.

Instances of File that denote file paths are JAR files, and instances that denote folder paths are binary folders, i.e. folders that contain .class files.

Returns:

a possibly empty list of pathnames denoting project classpath.

getFolders

List<File> getFolders(FolderKind... kinds)

Gets project folders of the given kinds.

Parameters:

kinds - all kinds of folder to get.

Returns:

a possibly empty list of folders that match given kinds.

getIvyModule

File getIvyModule()

Gets the path to the project Ivy module file.

Returns:

the path to the project Ivy module file. This method always returns a valid file.

getProjectFolder

File getProjectFolder()

Gets this project root folder.

Returns:

a pathname that denotes the project root folder. This method always returns a valid folder.

isFolderKind

boolean isFolderKind(File folder,
                     FolderKind kind)

Gets if the given folder is of the given kind.

Parameters:

folder - the folder to test.

kind - the kind of folder.

Returns:

true if folder is of the given kind, false otherwise.