Package org.pkl.core.externalreader

Interface ExternalReaderProcess

All Superinterfaces:

AutoCloseable

public interface ExternalReaderProcess
extends AutoCloseable

An external process that reads Pkl modules and resources.

Method Summary

Modifier and Type	Method	Description
void	close()	Closes this process, releasing any associated resources.
@Nullable ModuleReaderSpec	getModuleReaderSpec(String scheme)	Returns the spec, if available, of this process's module reader with the given scheme.
ExternalModuleResolver	getModuleResolver(long evaluatorId)	Returns a resolver for modules provided via this reader.
@Nullable ResourceReaderSpec	getResourceReaderSpec(String scheme)	Returns the spec, if available, of this process's resource reader with the given scheme.
ExternalResourceResolver	getResourceResolver(long evaluatorId)	Returns a resolver for resources provided via this reader.
static ExternalReaderProcess	of(PklEvaluatorSettings.ExternalReader spec)	Creates a new ExternalReaderProcess from the given spec.

Method Details

of

static ExternalReaderProcess of(PklEvaluatorSettings.ExternalReader spec)

Creates a new ExternalReaderProcess from the given spec. No resources are allocated at this time.

getModuleResolver

ExternalModuleResolver getModuleResolver(long evaluatorId)
                                  throws ExternalReaderProcessException

Returns a resolver for modules provided via this reader.

Upon first call, this method may allocate resources, including spawning a child process.

Throws:

IllegalStateException - if this process has already been closed

ExternalReaderProcessException

getResourceResolver

ExternalResourceResolver getResourceResolver(long evaluatorId)
                                      throws ExternalReaderProcessException

Returns a resolver for resources provided via this reader.

Upon first call, this method may allocate resources, including spawning a child process.

Throws:

IllegalStateException - if this process has already been closed

ExternalReaderProcessException

getModuleReaderSpec

@Nullable
@Nullable ModuleReaderSpec getModuleReaderSpec(String scheme)
                                        throws IOException

Returns the spec, if available, of this process's module reader with the given scheme.

Throws:

IllegalStateException - if this process has already been closed

IOException - if an I/O error occurs

getResourceReaderSpec

@Nullable
@Nullable ResourceReaderSpec getResourceReaderSpec(String scheme)
                                            throws IOException

Returns the spec, if available, of this process's resource reader with the given scheme.

Throws:

IllegalStateException - if this process has already been closed

IOException - if an I/O error occurs

close

void close()

Closes this process, releasing any associated resources.

This method can be safely called multiple times. Subsequent calls have no effect.

Specified by:

close in interface AutoCloseable