Package com.illumon.iris.db.util.scripts

Class ClasspathScriptPathLoader

java.lang.Object

com.illumon.iris.db.util.scripts.ClasspathScriptPathLoader

All Implemented Interfaces:

ScriptPathLoader

public class ClasspathScriptPathLoader
extends Object
implements ScriptPathLoader

Constructor Summary

Constructors

Constructor	Description
ClasspathScriptPathLoader()

Method Summary

Modifier and Type	Method	Description
void	close()	Free resources associated with this loader.
Set<String>	getAvailableScriptDisplayPaths()
Set<String>	getAvailableScriptRelativePaths()
String	getScriptBodyByDisplayPath(String displayPath)
String	getScriptBodyByRelativePath(String relativePath)
void	lock()	Acquire a read lock.
void	refresh()	Refresh the loader internally.
void	unlock()	Release a previously acquired read lock.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.illumon.iris.db.util.scripts.ScriptPathLoader

getAvailableScriptDisplayPaths, getAvailableScriptRelativePaths, getScriptBodyByDisplayPath, getScriptBodyByRelativePath, getState, makeState

Constructor Details

ClasspathScriptPathLoader

public ClasspathScriptPathLoader()

Method Details

lock

public void lock()

Description copied from interface: ScriptPathLoader

Acquire a read lock. Use before invoking any of the get* methods, and hold for as long as consistency is required for this loader.

Specified by:

lock in interface ScriptPathLoader

unlock

public void unlock()

Description copied from interface: ScriptPathLoader

Release a previously acquired read lock.

Specified by:

unlock in interface ScriptPathLoader

getAvailableScriptDisplayPaths

public Set<String> getAvailableScriptDisplayPaths()

Specified by:

getAvailableScriptDisplayPaths in interface ScriptPathLoader

Returns:

The display paths currently available from this loader.

getAvailableScriptRelativePaths

public Set<String> getAvailableScriptRelativePaths()

Specified by:

getAvailableScriptRelativePaths in interface ScriptPathLoader

Returns:

The relative paths currently available from this loader.

getScriptBodyByDisplayPath

public String getScriptBodyByDisplayPath(String displayPath)
                                  throws IOException

Specified by:

getScriptBodyByDisplayPath in interface ScriptPathLoader

Parameters:

displayPath - The display path to load a script for.

Returns:

The body of the requested script.

Throws:

IOException - If a problem occurred reading the script body.

getScriptBodyByRelativePath

public String getScriptBodyByRelativePath(String relativePath)
                                   throws IOException

Specified by:

getScriptBodyByRelativePath in interface ScriptPathLoader

Parameters:

relativePath - The relative path to load a script for.

Returns:

The body of the requested script.

Throws:

IOException - If a problem occurred reading the script body.

refresh

public void refresh()

Description copied from interface: ScriptPathLoader

Refresh the loader internally. Will respect existing read locks.

Specified by:

refresh in interface ScriptPathLoader

close

public void close()

Description copied from interface: ScriptPathLoader

Free resources associated with this loader.

Specified by:

close in interface ScriptPathLoader