Package org.pkl.core.runtime

Interface ReaderBase

All Known Subinterfaces:

ModuleKey, ResourceReader

All Known Implementing Classes:

ModuleKeys.ExternalResolver, ModuleKeys.ProjectPackage

public interface ReaderBase

Method Summary

Modifier and Type	Method	Description
default boolean	hasElement(SecurityManager securityManager, URI elementUri)	Tells if this module key or resource reader has an element at elementUri.
default 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.
default List<PathElement>	listElements(SecurityManager securityManager, URI baseUri)	List elements within a base URI.
default URI	resolveUri(URI baseUri, URI uri)

Method Details

hasHierarchicalUris

boolean hasHierarchicalUris()
                     throws ExternalReaderProcessException,
IOException

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

Throws:

ExternalReaderProcessException

IOException

isGlobbable

boolean isGlobbable()
             throws ExternalReaderProcessException,
IOException

Tells if this module key or resource reader supports globbing.

Throws:

ExternalReaderProcessException

IOException

hasFragmentPaths

default boolean hasFragmentPaths()

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

hasElement

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

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

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

Throws:

IOException

SecurityManagerException

ExternalReaderProcessException

listElements

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

List elements within a base URI.

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

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

If 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

resolveUri

default URI resolveUri(URI baseUri,
 URI uri)
                throws IOException,
SecurityManagerException

Throws:

IOException

SecurityManagerException