Package dev.getelements.elements.rt

Interface ResourceLoader

All Superinterfaces:

AutoCloseable

public interface ResourceLoader
extends AutoCloseable

Loads instances of Resource based on Path instances. Typically instances of this work in conjunction with an AssetLoader to load the raw bytes from storage and then into memory.

Method Summary

Modifier and Type	Method	Description
void	close()	Closes the ResourceLoader and cleaning up any resources.
default Resource	load(InputStream is)	Loads the Resource from the InputStream in non-verbose mode.
Resource	load(InputStream is, boolean verbose)	Loads a Resource from the supplied InputStream.
Resource	load(String moduleName, Attributes attributes, Object... args)	Loads the Resource specified by the supplied module name.
default Resource	load(String modulePath, Object... args)	Performs the same operation as load(String, Attributes, Object...) using Attributes.EMPTY as the specified Attributes.
default Resource	load(ReadableByteChannel rbc)	Loads the Resource from the ReadableByteChannel in non-verbose mode.
Resource	load(ReadableByteChannel rbc, boolean verbose)	Loads a Resource from the supplied ReadableByteChannel.

Method Details

load

default Resource load(InputStream is)
               throws ResourcePersistenceException

Loads the Resource from the InputStream in non-verbose mode.

Parameters:

is - the InputStream from which to load the Resource

Returns:

the Resource

Throws:

ResourcePersistenceException

load

default Resource load(ReadableByteChannel rbc)
               throws ResourcePersistenceException

Loads the Resource from the ReadableByteChannel in non-verbose mode.

Parameters:

rbc - the InputStream from which to load the Resource

Returns:

the Resource

Throws:

ResourcePersistenceException

load

Resource load(InputStream is,
 boolean verbose)
       throws ResourcePersistenceException

Loads a Resource from the supplied InputStream. The contents of the InputStream should be generated form a call to Resource.serialize(OutputStream).

Parameters:

is - the InputStream from which to load the Resource

verbose - indicates if the resource shoudl be loaded verbosely.

Returns:

the loaded Resource

Throws:

ResourcePersistenceException - if the resource was corrupted of failed to load for some reason

load

Resource load(ReadableByteChannel rbc,
 boolean verbose)
       throws ResourcePersistenceException

Loads a Resource from the supplied ReadableByteChannel. The contents of the InputStream should be generated form a call to Resource.serialize(OutputStream) or Resource.serialize(WritableByteChannel).

Parameters:

rbc - the InputStream from which to load the Resource

verbose - indicates if the resource shoudl be loaded verbosely.

Returns:

the loaded Resource

Throws:

ResourcePersistenceException - if the resource was corrupted of failed to load for some reason

load

default Resource load(String modulePath,
 Object... args)
               throws ModuleNotFoundException

Performs the same operation as load(String, Attributes, Object...) using Attributes.EMPTY as the specified Attributes.

Throws:

ModuleNotFoundException

load

Resource load(String moduleName,
 Attributes attributes,
 Object... args)
       throws ModuleNotFoundException

Loads the Resource specified by the supplied module name. The supplied module name is specific to the particular implementation of the ResourceLoader, but should be a unique identifier specifying the unit or module of code to load. Since a Resource can be represented by any number of languages, the string passed is highly specific to the underlying implementation's semantics.

Parameters:

moduleName - the module name

attributes - Attributes assocaited with the Resource

args - various initialization arguments to be passed to the underlying Resource

Returns:

the Resource instance, never null

Throws:

ModuleNotFoundException - if the source for the Resource cannot be found.

close

void close()

Closes the ResourceLoader and cleaning up any resources. Any open Resource instances may be closed, but this is not a guarantee. All resources open should be closed before closing this ResourceLoader. Using Resources after closing this instance, or closing this instance while resources are open should be considered undefined behavior. This also closes the resources which may be associated with this ResourceLoader. Invoking this method twice on the same object should also be considered undefined behavior.

Specified by:

close in interface AutoCloseable