jmlparser-core/com.github.javaparser.utils/SourceRoot

SourceRoot

A collection of Java source files located in one directory and its subdirectories on the file system. The root directory corresponds to the root of the package structure of the source files within. Files can be parsed and written back one by one or all together. Note that the internal cache used is thread-safe.

methods called "tryToParse..." will return their result inside a "ParseResult", which supports parse successes and failures.
methods called "parse..." will return "CompilationUnit"s. If a file fails to parse, an exception is thrown.
methods ending in "...Parallelized" will speed up parsing by using multiple threads.

Constructors

SourceRoot

constructor(root: Path)

constructor(root: Path, parserConfiguration: ParserConfiguration)

Types

Callback

@FunctionalInterface

interface Callback

Properties

parserConfiguration

open var parserConfiguration: ParserConfiguration

printer

open var printer: (CompilationUnit) -> String

root

val root: Path

Functions

add

open fun add(compilationUnit: CompilationUnit): SourceRoot

open fun add(startPackage: String, filename: String, compilationUnit: CompilationUnit): SourceRoot

Add a newly created Java file to the cache of this source root.

getCache

open fun getCache(): List<ParseResult<CompilationUnit>>

The Java files that have been parsed by this source root object, or have been added manually.

getCompilationUnits

open fun getCompilationUnits(): List<CompilationUnit>

The CompilationUnits of the Java files that have been parsed succesfully by this source root object, or have been added manually.

parse

open fun parse(startPackage: String, callback: SourceRoot.Callback): SourceRoot

open fun parse(startPackage: String, filename: String): CompilationUnit

Parses a .java files under the source root and returns its CompilationUnit.

open fun parse(startPackage: String, configuration: ParserConfiguration, callback: SourceRoot.Callback): SourceRoot

Tries to parse all .java files in a package recursively and passes them one by one to the callback.

open fun parse(startPackage: String, filename: String, callback: SourceRoot.Callback): SourceRoot

Parses the provided .java file and passes it to the callback.

open fun parse(startPackage: String, filename: String, configuration: ParserConfiguration, callback: SourceRoot.Callback): SourceRoot

Locates the .java file with the provided package and file name, parses it and passes it to the callback.

parseParallelized

open fun parseParallelized(callback: SourceRoot.Callback): SourceRoot

Tries to parse all .java files recursively using multiple threads, and passes them one by one to the callback.

open fun parseParallelized(startPackage: String, callback: SourceRoot.Callback): SourceRoot

open fun parseParallelized(startPackage: String, configuration: ParserConfiguration, callback: SourceRoot.Callback): SourceRoot

Tries to parse all .java files in a package recursively using multiple threads, and passes them one by one to the callback.

saveAll

open fun saveAll(): SourceRoot

Save all previously parsed files back to where they were found.

open fun saveAll(encoding: Charset): SourceRoot

Save all previously parsed files back to where they were found, with the given encoding.

open fun saveAll(root: Path): SourceRoot

Save all previously parsed files back to a new path.

open fun saveAll(root: Path, encoding: Charset): SourceRoot

Saves all cached compilation units to the specified root directory.

toString

open fun toString(): String

tryToParse

open fun tryToParse(): List<ParseResult<CompilationUnit>>

Tries to parse all .java files under the source root recursively, and returns all files ever parsed with this source root.

open fun tryToParse(startPackage: String): List<ParseResult<CompilationUnit>>

Tries to parse all .java files in a package recursively, and returns all files ever parsed with this source root.

open fun tryToParse(startPackage: String, filename: String): ParseResult<CompilationUnit>

open fun tryToParse(startPackage: String, filename: String, configuration: ParserConfiguration): ParseResult<CompilationUnit>

Tries to parse a .java files under the source root and returns the ParseResult.

tryToParseParallelized

open fun tryToParseParallelized(): List<ParseResult<CompilationUnit>>

Tries to parse all .java files under the source root recursively using multiple threads, and returns all files ever parsed with this source root.

open fun tryToParseParallelized(startPackage: String): List<ParseResult<CompilationUnit>>

Tries to parse all .java files in a package recursively using multiple threads, and returns all files ever parsed with this source root.