Package org.pkl.core.project

Class Project

java.lang.Object

org.pkl.core.project.Project

public final class Project
extends Object

Java representation of module pkl.Project.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Project.EvaluatorSettings	Deprecated, for removal: This API element is subject to removal in a future version.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
List<PObject>	getAnnotations()
DeclaredDependencies	getDependencies()
PklEvaluatorSettings	getEvaluatorSettings()
Map<String,Project>	getLocalProjectDependencies()
@Nullable Package	getPackage()
URI	getProjectBaseUri()
Path	getProjectDir()
URI	getProjectFileUri()
Project.EvaluatorSettings	getSettings()	Deprecated, for removal: This API element is subject to removal in a future version.
List<Path>	getTests()
int	hashCode()
static Project	load(Evaluator evaluator, ModuleSource moduleSource)
static Project	load(ModuleSource moduleSource)	Loads a project from the given source.
static Project	loadFromPath(Path path)	Convenience method to load a project with the default security manager, no timeout, and the default stack frame transformer.
static Project	loadFromPath(Path path, SecurityManager securityManager, Duration timeout)	Convenience method to load a project with the default stack frame transformer.
static Project	loadFromPath(Path path, SecurityManager securityManager, Duration timeout, StackFrameTransformer stackFrameTransformer, Map<String,String> envVars)	Loads Project data from the given Path.
static Project	parseProject(PObject module)

Methods inherited from class java.lang.Object

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

Method Details

loadFromPath

public static Project loadFromPath(Path path,
 SecurityManager securityManager,
 @Nullable
 Duration timeout,
 StackFrameTransformer stackFrameTransformer,
 Map<String,String> envVars)

Loads Project data from the given Path.

Evaluates a module's output.value to allow for embedding a project within a template.

Throws:

PklException - if an error occurred while evaluating the project file.

loadFromPath

public static Project loadFromPath(Path path,
 SecurityManager securityManager,
 @Nullable
 Duration timeout)

Convenience method to load a project with the default stack frame transformer.

loadFromPath

public static Project loadFromPath(Path path)

Convenience method to load a project with the default security manager, no timeout, and the default stack frame transformer.

load

public static Project load(ModuleSource moduleSource)

Loads a project from the given source.

load

public static Project load(Evaluator evaluator,
 ModuleSource moduleSource)

parseProject

public static Project parseProject(PObject module)
                            throws URISyntaxException

Throws:

URISyntaxException

getPackage

@Nullable
public @Nullable Package getPackage()

getSettings

@Deprecated(forRemoval=true)
public Project.EvaluatorSettings getSettings()

Deprecated, for removal: This API element is subject to removal in a future version.

Use getEvaluatorSettings() instead.

getEvaluatorSettings

public PklEvaluatorSettings getEvaluatorSettings()

getProjectFileUri

public URI getProjectFileUri()

getTests

public List<Path> getTests()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getDependencies

public DeclaredDependencies getDependencies()

getLocalProjectDependencies

public Map<String,Project> getLocalProjectDependencies()

getProjectBaseUri

public URI getProjectBaseUri()

getProjectDir

public Path getProjectDir()

getAnnotations

public List<PObject> getAnnotations()