Package org.pkl.core.module

Class ModuleKeys.ProjectPackage

java.lang.Object

org.pkl.core.module.ModuleKeys.ProjectPackage

All Implemented Interfaces:

ModuleKey, ReaderBase

Enclosing class:

ModuleKeys

public static class ModuleKeys.ProjectPackage
extends Object

Represents a module imported via the projectpackage scheme.

The projectpackage scheme is what project-local dependencies resolve to when imported using dependency notation (for example, import "@foo/bar.pkl"). This scheme is an internal implementation detail, and we do not expect a module to declare this.

Field Summary

Fields

Modifier and Type	Field	Description
protected final PackageAssetUri	packageAssetUri

Method Summary

Modifier and Type	Method	Description
protected Map<String,? extends Dependency>	getDependencies()
URI	getUri()	Returns the absolute URI of this module.
boolean	hasElement(SecurityManager securityManager, URI elementUri)	Tells if this module key or resource reader has an element at elementUri.
boolean	hasFragmentPaths()	Tells if relative paths of this URI should be resolved from URI.getFragment(), rather than URI.getPath().
boolean	hasHierarchicalUris()	Tells if the URIs represented by this module key or resource reader should be interpreted as hierarchical.
boolean	isGlobbable()	Tells if this module key or resource reader supports globbing.
boolean	isLocal()	Tells if the modules represented by this module key is local to the environment.
List<PathElement>	listElements(SecurityManager securityManager, URI baseUri)	List elements within a base URI.
ResolvedModuleKey	resolve(SecurityManager securityManager)	Resolves this module to a canonical form suitable for loading and caching the module.
URI	resolveUri(URI baseUri, URI importUri)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.pkl.core.module.ModuleKey

getFileCacheLocation, isCached, resolveUri

Field Details

packageAssetUri

protected final PackageAssetUri packageAssetUri

Method Details

resolve

public ResolvedModuleKey resolve(SecurityManager securityManager)
                          throws IOException,
SecurityManagerException

Description copied from interface: ModuleKey

Resolves this module to a canonical form suitable for loading and caching the module. This may involve I/O. Throws FileNotFoundException if this module cannot be found.

Throws:

IOException

SecurityManagerException

listElements

public List<PathElement> listElements(SecurityManager securityManager,
 URI baseUri)
                               throws IOException,
SecurityManagerException,
ExternalReaderProcessException

Description copied from interface: ReaderBase

List elements within a base URI.

This method is called by the GlobResolver when resolving glob expressions if ReaderBase.isGlobbable() returns true.

This method does not need to be implemented if ReaderBase.isGlobbable() returns false.

If ReaderBase.hasHierarchicalUris() returns false, URI is effectively an empty URI and should be ignored. In this case, this method is expected to list all elements represented by this reader.

Throws:

IOException

SecurityManagerException

ExternalReaderProcessException

hasElement

public boolean hasElement(SecurityManager securityManager,
 URI elementUri)
                   throws IOException,
SecurityManagerException,
ExternalReaderProcessException

Description copied from interface: ReaderBase

Tells if this module key or resource reader has an element at elementUri.

This method only needs to be implemented if ReaderBase.hasHierarchicalUris() returns true, and if either ReaderBase.isGlobbable() or ModuleKey.isLocal() returns true.

Throws:

IOException

SecurityManagerException

ExternalReaderProcessException

getDependencies

protected Map<String,? extends Dependency> getDependencies()
                                                    throws IOException,
SecurityManagerException

Throws:

IOException

SecurityManagerException

hasHierarchicalUris

public boolean hasHierarchicalUris()

Description copied from interface: ReaderBase

Tells if the URIs represented by this module key or resource reader should be interpreted as hierarchical.

Specified by:

hasHierarchicalUris in interface ReaderBase

hasFragmentPaths

public boolean hasFragmentPaths()

Description copied from interface: ReaderBase

Tells if relative paths of this URI should be resolved from URI.getFragment(), rather than URI.getPath().

Specified by:

hasFragmentPaths in interface ReaderBase

isLocal

public boolean isLocal()

Description copied from interface: ModuleKey

Tells if the modules represented by this module key is local to the environment.

A module that is local, and also ReaderBase.hasHierarchicalUris(), supports triple-dot imports.

As a best practice, a module key should be considered local if its source can be loaded in a low latency environment (for example, from disk or from memory). On the flip-side, a module loaded from a remove server should not be considered local.

Specified by:

isLocal in interface ModuleKey

isGlobbable

public boolean isGlobbable()

Description copied from interface: ReaderBase

Tells if this module key or resource reader supports globbing.

Specified by:

isGlobbable in interface ReaderBase

getUri

public URI getUri()

Description copied from interface: ModuleKey

Returns the absolute URI of this module. This URI is used for identifying the module in user facing messages, for example stack traces. Typically, this URI contains all information necessary for resolving and loading the module.

Specified by:

getUri in interface ModuleKey

resolveUri

public URI resolveUri(URI baseUri,
 URI importUri)
               throws IOException,
SecurityManagerException

Specified by:

resolveUri in interface ReaderBase

Throws:

IOException

SecurityManagerException