com.github.jlangch.venice.javainterop

Interface ILoadPaths

All Known Implementing Classes:

LoadPaths

public interface ILoadPaths

Defines load paths for Venice.

The Venice functions 'load-file' and 'load-resource' can be bound to load files and resources from restricted paths only. Load paths are part of Venice's Sandbox to control where files can be loaded from.

See Also:

LoadPathsFactory

Method Summary

Modifier and Type	Method and Description
java.util.List<java.io.File>	getPaths()
boolean	isUnlimitedAccess()
java.nio.ByteBuffer	loadBinaryResource(java.io.File file) Loads a binary resources file from the load paths
java.lang.String	loadTextResource(java.io.File file, java.lang.String encoding) Loads a text resources file from the load paths
java.lang.String	loadVeniceFile(java.io.File file) Load a Venice script file from the load paths

Method Detail

loadVeniceFile

java.lang.String loadVeniceFile(java.io.File file)

Load a Venice script file from the load paths

Parameters:

file - A Venice script file to load. Adds a '.venice' file extension implicitly if missing.

Returns:

The script or null if not found

loadBinaryResource

java.nio.ByteBuffer loadBinaryResource(java.io.File file)

Loads a binary resources file from the load paths

Parameters:

file - A file to load.

Returns:

The binary or null if not found

loadTextResource

java.lang.String loadTextResource(java.io.File file,
                                  java.lang.String encoding)

Loads a text resources file from the load paths

Parameters:

file - A file to load.

encoding - an optional text encoding like 'UTF-8'. The platform's default encoding is used on passing null

Returns:

The text resource or null if not found

getPaths

java.util.List<java.io.File> getPaths()

Returns:

the file paths associated with this ILoadPaths object

isUnlimitedAccess

boolean isUnlimitedAccess()

Returns:

true if the access to files is unlimited or false if the access is limited to the load paths.