org.jclouds.scriptbuilder.functionloader
Enum BasicFunctionLoader

java.lang.Object
  java.lang.Enum<BasicFunctionLoader>
      org.jclouds.scriptbuilder.functionloader.BasicFunctionLoader

All Implemented Interfaces:

Serializable, Comparable<BasicFunctionLoader>, FunctionLoader

public enum BasicFunctionLoader
extends Enum<BasicFunctionLoader>
implements FunctionLoader

A FunctionLoader implementation which loads the target function from the classpath.

Enum Constant Summary

INSTANCE

Method Summary

String	loadFunction(String function, OsFamily family) Loads a function from the classpath using the current or the Thread Context Class Loader.
static BasicFunctionLoader	valueOf(String name) Returns the enum constant of this type with the specified name.
static BasicFunctionLoader[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

INSTANCE

public static final BasicFunctionLoader INSTANCE

Method Detail

values

public static BasicFunctionLoader[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (BasicFunctionLoader c : BasicFunctionLoader.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static BasicFunctionLoader valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

loadFunction

public String loadFunction(String function,
                           OsFamily family)
                    throws FunctionNotFoundException

Loads a function from the classpath using the current or the Thread Context Class Loader.

Specified by:

loadFunction in interface FunctionLoader

Parameters:

function - The function name to load.

family - This operating system family of the function.

Returns:

The function as String

Throws:

FunctionNotFoundException