Package org.pkl.core.module

Class ModuleKeys

java.lang.Object

org.pkl.core.module.ModuleKeys

public final class ModuleKeys
extends Object

Utilities for creating and using ModuleKeys.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ModuleKeys.ProjectPackage	Represents a module imported via the projectpackage scheme.

Method Summary

Modifier and Type	Method	Description
static ModuleKey	cached(ModuleKey delegate, String text)	Creates a module key that behaves like delegate, except that it returns text as its loaded source.
static ModuleKey	classPath(URI uri, ClassLoader classLoader)	Creates a module key for a modulepath: module to be resolved with the given class loader.
static ModuleKey	file(URI uri)	Creates a module key for a file: module.
static ModuleKey	genericUrl(URI url)	Creates a module key for the module with the given URL.
static ModuleKey	http(URI url)	Creates a module key for http: and https: uris.
static boolean	isBaseModule(ModuleKey module)	Tells if the given module is the standard library module with URI pkl:base.
static boolean	isStdLibModule(ModuleKey module)	Tells if the given module is a standard library module.
static ModuleKey	modulePath(URI uri, ModulePathResolver resolver)	Creates a module key for a modulepath: module to be resolved with the given resolver.
static ModuleKey	pkg(URI uri)	Creates a module key for the given package.
static ModuleKey	projectpackage(URI uri)
static ModuleKey	standardLibrary(URI uri)	Creates a module key for the standard library module with the given URI.
static ModuleKey	synthetic(URI uri, String sourceText)	Creates a module key identified by the given URI and backed by the given source code.
static ModuleKey	synthetic(URI uri, URI importBaseUri, URI resolvedUri, String sourceText, boolean isCached)	Creates a module key identified by the given URI and backed by the given source code.

Methods inherited from class java.lang.Object

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

Method Details

isStdLibModule

public static boolean isStdLibModule(ModuleKey module)

Tells if the given module is a standard library module. Standard library modules ship with the language and have a URI of the form pkl:<simple module name>.

isBaseModule

public static boolean isBaseModule(ModuleKey module)

Tells if the given module is the standard library module with URI pkl:base.

synthetic

public static ModuleKey synthetic(URI uri,
 String sourceText)

Creates a module key identified by the given URI and backed by the given source code. Shorthand for synthetic(uri, uri, uri, sourceText, false.

synthetic

public static ModuleKey synthetic(URI uri,
 URI importBaseUri,
 URI resolvedUri,
 String sourceText,
 boolean isCached)

Creates a module key identified by the given URI and backed by the given source code. Module imports will be resolved against the given importBaseUri. If isCached is true, the resulting module will be cached with uri and resolvedUri used as cache keys.

standardLibrary

public static ModuleKey standardLibrary(URI uri)

Creates a module key for the standard library module with the given URI. The URI for a standard library module is pkl:<simple module name>. For example, the URI for the base library module is pkl:base.

file

public static ModuleKey file(URI uri)

Creates a module key for a file: module.

modulePath

public static ModuleKey modulePath(URI uri,
 ModulePathResolver resolver)

Creates a module key for a modulepath: module to be resolved with the given resolver.

classPath

public static ModuleKey classPath(URI uri,
 ClassLoader classLoader)

Creates a module key for a modulepath: module to be resolved with the given class loader.

genericUrl

public static ModuleKey genericUrl(URI url)

Creates a module key for the module with the given URL.

http

public static ModuleKey http(URI url)

Creates a module key for http: and https: uris.

pkg

public static ModuleKey pkg(URI uri)
                     throws URISyntaxException

Creates a module key for the given package.

Throws:

URISyntaxException

projectpackage

public static ModuleKey projectpackage(URI uri)
                                throws URISyntaxException

Throws:

URISyntaxException

cached

public static ModuleKey cached(ModuleKey delegate,
 String text)

Creates a module key that behaves like delegate, except that it returns text as its loaded source.