Class ProjectRoot

java.lang.Object

com.github.javaparser.utils.ProjectRoot

public class ProjectRoot
extends Object

The structure of a Java project directory. It was originally created specifically to quickly configure the symbol solver. You can use it as a general container for project information.

A project has a root directory, and it has zero or more directories that contain source code.

To create a ProjectRoot use a CollectionStrategy, or instantiate ProjectRoot yourself.

Field Summary

Fields

Modifier and Type	Field	Description
private final Map<Path, SourceRoot>	cache
private final ParserConfiguration	parserConfiguration
private final Path	root

Constructor Summary

Constructors

Constructor	Description
ProjectRoot(Path root)
ProjectRoot(Path root, ParserConfiguration parserConfiguration)

Method Summary

Modifier and Type	Method	Description
void	addSourceRoot(Path path)
Path	getRoot()
Optional<SourceRoot>	getSourceRoot(Path sourceRoot)
List<SourceRoot>	getSourceRoots()
String	toString()

Methods inherited from class Object

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

Field Details

root

private final Path root

cache

private final Map<Path, SourceRoot> cache

parserConfiguration

private final ParserConfiguration parserConfiguration

Constructor Details

ProjectRoot

public ProjectRoot(Path root)

ProjectRoot

public ProjectRoot(Path root,
 ParserConfiguration parserConfiguration)

Method Details

getSourceRoot

public Optional<SourceRoot> getSourceRoot(Path sourceRoot)

getSourceRoots

public List<SourceRoot> getSourceRoots()

addSourceRoot

public void addSourceRoot(Path path)

getRoot

public Path getRoot()

toString

public String toString()

Overrides:

toString in class Object