org.openquark.cal.runtime
Interface ResourceAccess

All Known Implementing Classes:

BasicCALWorkspace, BasicCALWorkspace.Discrete, BasicCALWorkspace.Nullary, CALWorkspace

public interface ResourceAccess

This interface represents the mechanism through which the CAL runtime is to access resources in the current environment (e.g. from the workspace, or from Eclipse). On the CAL side, access to resources is provided by the Resource module.

Author:

Joseph Wong

Method Summary

InputStream

getUserResource(String moduleNameAsString, String name, String extension, Locale locale) Returns an InputStream for the named user resource in the specified locale.

Method Detail

getUserResource

InputStream getUserResource(String moduleNameAsString,
                            String name,
                            String extension,
                            Locale locale)

Returns an InputStream for the named user resource in the specified locale. Note that this method does not implement any locale-fallback mechanism - it is up to the caller to do so.

Parameters:

moduleNameAsString - the name of the module associated with the user resource.

name - the name of the resource, not including any file extensions. Cannot contain the character '_'.

extension - the file extension for the user resource.

locale - the locale for which the resource is to be fetched.

Returns:

an InputStream for the user resource, or null if the resource cannot be found.