Package org.pkl.core

Class EvaluatorImpl

java.lang.Object

org.pkl.core.EvaluatorImpl

All Implemented Interfaces:

java.lang.AutoCloseable, Evaluator

public class EvaluatorImpl
extends java.lang.Object
implements Evaluator

Field Summary

Fields

Modifier and Type	Field	Description
protected StackFrameTransformer	frameTransformer
protected BufferedLogger	logger
protected ModuleResolver	moduleResolver
protected PackageResolver	packageResolver
protected org.graalvm.polyglot.Context	polyglotContext
protected SecurityManager	securityManager
protected @Nullable java.time.Duration	timeout
protected @Nullable java.util.concurrent.ScheduledExecutorService	timeoutExecutor

Constructor Summary

Constructors

Constructor

Description

EvaluatorImpl(StackFrameTransformer transformer, SecurityManager manager, Logger logger, java.util.Collection<ModuleKeyFactory> factories, java.util.Collection<ResourceReader> readers, java.util.Map<java.lang.String,java.lang.String> environmentVariables, java.util.Map<java.lang.String,java.lang.String> externalProperties, @Nullable java.time.Duration timeout, @Nullable java.nio.file.Path moduleCacheDir, @Nullable DeclaredDependencies projectDependencies, @Nullable java.lang.String outputFormat)

Method Summary

Modifier and Type	Method	Description
void	close()	Releases all resources held by this evaluator.
protected <T> T	doEvaluate(ModuleSource moduleSource, java.util.function.Function<VmTyped,T> doEvaluate)
PModule	evaluate(ModuleSource moduleSource)	Evaluates the module, returning the Java representation of the module object.
java.lang.Object	evaluateExpression(ModuleSource moduleSource, java.lang.String expression)	Evaluates the Pkl expression represented as expression, returning the Java representation of the result.
java.lang.String	evaluateExpressionString(ModuleSource moduleSource, java.lang.String expression)	Evaluates the Pkl expression, returning the stringified result.
java.util.Map<java.lang.String,FileOutput>	evaluateOutputFiles(ModuleSource moduleSource)	Evaluates a module's output.files property.
java.lang.String	evaluateOutputText(ModuleSource moduleSource)	Evaluates a module's output.text property.
java.lang.Object	evaluateOutputValue(ModuleSource moduleSource)	Evaluates a module's output.value property.
<T> T	evaluateOutputValueAs(ModuleSource moduleSource, PClassInfo<T> classInfo)	Evaluates the module's output.value property, and validates that its type matches the provided class info.
ModuleSchema	evaluateSchema(ModuleSource moduleSource)	Evalautes the module's schema, which describes the properties, methods, and classes of a module.
TestResults	evaluateTest(ModuleSource moduleSource, boolean overwrite)	Runs tests within the module, and returns the test results.

Methods inherited from class java.lang.Object

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

Field Detail

frameTransformer

protected final StackFrameTransformer frameTransformer

moduleResolver

protected final ModuleResolver moduleResolver

polyglotContext

protected final org.graalvm.polyglot.Context polyglotContext

timeout

protected final @Nullable java.time.Duration timeout

timeoutExecutor

protected final @Nullable java.util.concurrent.ScheduledExecutorService timeoutExecutor

securityManager

protected final SecurityManager securityManager

logger

protected final BufferedLogger logger

packageResolver

protected final PackageResolver packageResolver

Constructor Detail

EvaluatorImpl

public EvaluatorImpl(StackFrameTransformer transformer,
                     SecurityManager manager,
                     Logger logger,
                     java.util.Collection<ModuleKeyFactory> factories,
                     java.util.Collection<ResourceReader> readers,
                     java.util.Map<java.lang.String,java.lang.String> environmentVariables,
                     java.util.Map<java.lang.String,java.lang.String> externalProperties,
                     @Nullable java.time.Duration timeout,
                     @Nullable java.nio.file.Path moduleCacheDir,
                     @Nullable DeclaredDependencies projectDependencies,
                     @Nullable java.lang.String outputFormat)

Method Detail

evaluate

public PModule evaluate(ModuleSource moduleSource)

Description copied from interface: Evaluator

Evaluates the module, returning the Java representation of the module object.

Specified by:

evaluate in interface Evaluator

evaluateOutputText

public java.lang.String evaluateOutputText(ModuleSource moduleSource)

Description copied from interface: Evaluator

Evaluates a module's output.text property.

Specified by:

evaluateOutputText in interface Evaluator

evaluateOutputValue

public java.lang.Object evaluateOutputValue(ModuleSource moduleSource)

Description copied from interface: Evaluator

Evaluates a module's output.value property.

Specified by:

evaluateOutputValue in interface Evaluator

evaluateOutputFiles

public java.util.Map<java.lang.String,FileOutput> evaluateOutputFiles(ModuleSource moduleSource)

Description copied from interface: Evaluator

Evaluates a module's output.files property.

Specified by:

evaluateOutputFiles in interface Evaluator

evaluateExpression

public java.lang.Object evaluateExpression(ModuleSource moduleSource,
                                           java.lang.String expression)

Description copied from interface: Evaluator

Evaluates the Pkl expression represented as expression, returning the Java representation of the result.

The following table describes how Pkl types are represented in Java:

Pkl type	Java type
Null	PNull
String	String
Boolean	Boolean
Int	Long
Float	Double
Typed, Dynamic	PObject (PModule if the object is a module)
Mapping, Map	Map
Listing, List	List
Set	Set
Pair	Pair
Regex	Pattern
DataSize	DataSize
Duration	Duration
Class	PClass
TypeAlias	TypeAlias

The following Pkl types have no Java representation, and an error is thrown if an expression computes to a value of these types:

• IntSeq
• Function

Specified by:

evaluateExpression in interface Evaluator

evaluateExpressionString

public java.lang.String evaluateExpressionString(ModuleSource moduleSource,
                                                 java.lang.String expression)

Description copied from interface: Evaluator

Evaluates the Pkl expression, returning the stringified result.

This is equivalent to wrapping the expression with .toString()

Specified by:

evaluateExpressionString in interface Evaluator

evaluateSchema

public ModuleSchema evaluateSchema(ModuleSource moduleSource)

Description copied from interface: Evaluator

Evalautes the module's schema, which describes the properties, methods, and classes of a module.

Specified by:

evaluateSchema in interface Evaluator

evaluateTest

public TestResults evaluateTest(ModuleSource moduleSource,
                                boolean overwrite)

Description copied from interface: Evaluator

Runs tests within the module, and returns the test results.

This requires that the target module be a test module; it must either amend or extend module "pkl:test". Otherwise, a type mismatch error is thrown.

This method will write possibly pcf-expected.pkl and pcf-actual.pcf files as a sibling of the test module. The overwrite parameter causes the evaluator to overwrite pcf-expected.pkl files if they currently exist.

Specified by:

evaluateTest in interface Evaluator

evaluateOutputValueAs

public <T> T evaluateOutputValueAs(ModuleSource moduleSource,
                                   PClassInfo<T> classInfo)

Description copied from interface: Evaluator

Evaluates the module's output.value property, and validates that its type matches the provided class info.

Specified by:

evaluateOutputValueAs in interface Evaluator

close

public void close()

Description copied from interface: Evaluator

Releases all resources held by this evaluator. If an evaluate method is currently executing, this method blocks until cancellation of that execution has completed.

Once an evaluator has been closed, it can no longer be used, and calling evaluate methods will throw IllegalStateException. However, objects previously returned by evaluate methods remain valid.

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in interface Evaluator

doEvaluate

protected <T> T doEvaluate(ModuleSource moduleSource,
                           java.util.function.Function<VmTyped,T> doEvaluate)