com.github.jlangch.venice.impl.util.io

Class LoadPaths

java.lang.Object

com.github.jlangch.venice.impl.util.io.LoadPaths

All Implemented Interfaces:

ILoadPaths

public class LoadPaths
extends java.lang.Object
implements ILoadPaths

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
static LoadPaths	of(java.util.List<java.io.File> paths, boolean unlimitedAccess)

Methods inherited from class java.lang.Object

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

Method Detail

of

public static LoadPaths of(java.util.List<java.io.File> paths,
                           boolean unlimitedAccess)

loadVeniceFile

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

Description copied from interface: ILoadPaths

Load a Venice script file from the load paths

Specified by:

loadVeniceFile in interface ILoadPaths

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

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

Description copied from interface: ILoadPaths

Loads a binary resources file from the load paths

Specified by:

loadBinaryResource in interface ILoadPaths

Parameters:

file - A file to load.

Returns:

The binary or null if not found

loadTextResource

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

Description copied from interface: ILoadPaths

Loads a text resources file from the load paths

Specified by:

loadTextResource in interface ILoadPaths

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

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

Specified by:

getPaths in interface ILoadPaths

Returns:

the file paths associated with this ILoadPaths object

isUnlimitedAccess

public boolean isUnlimitedAccess()

Specified by:

isUnlimitedAccess in interface ILoadPaths

Returns:

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