Package net.officefloor.woof

Class WoofLoaderSettings

java.lang.Object

net.officefloor.woof.WoofLoaderSettings

public class WoofLoaderSettings
extends Object

Settings for the WoofLoader.

Author:

Daniel Sagenschneider

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	WoofLoaderSettings.WoofLoaderConfiguration	Configuration for the WoofLoader.
static interface	WoofLoaderSettings.WoofLoaderConfigurer	Configurer for an Office.
static interface	WoofLoaderSettings.WoofLoaderConfigurerContext	WoofLoaderSettings.WoofLoaderConfigurer context.
static interface	WoofLoaderSettings.WoofLoaderRunnable<R,E extends Throwable>	Runs within a context.
static interface	WoofLoaderSettings.WoofLoaderRunnableContext	WoofLoaderSettings.WoofLoaderRunnable context.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_WOOF_PATH	Default path for WoOF configuration file.
static final String	OFFICE_ALIAS_NAME	Alias name for the Office.

Constructor Summary

Constructors

Constructor	Description
WoofLoaderSettings()

Method Summary

Modifier and Type	Method	Description
static <R, E extends Throwable> R	contextualLoad(WoofLoaderSettings.WoofLoaderRunnable<R,E> runnable)	Undertakes a contextual load.
static WoofLoaderSettings.WoofLoaderConfiguration	getWoofLoaderConfiguration(String officeName)	Obtains the WoofLoaderSettings.WoofLoaderConfiguration for an Office.

Methods inherited from class java.lang.Object

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

Field Details

OFFICE_ALIAS_NAME

public static final String OFFICE_ALIAS_NAME

Alias name for the Office.

See Also:

• Constant Field Values

DEFAULT_WOOF_PATH

public static final String DEFAULT_WOOF_PATH

Default path for WoOF configuration file.

See Also:

• Constant Field Values

Constructor Details

WoofLoaderSettings

public WoofLoaderSettings()

Method Details

getWoofLoaderConfiguration

public static WoofLoaderSettings.WoofLoaderConfiguration getWoofLoaderConfiguration(String officeName)

Obtains the WoofLoaderSettings.WoofLoaderConfiguration for an Office.

Parameters:

officeName - Name of Office.

Returns:

WoofLoaderSettings.WoofLoaderConfiguration for the Office.

contextualLoad

public static <R,
E extends Throwable> R contextualLoad(WoofLoaderSettings.WoofLoaderRunnable<R,E> runnable)
                                                throws E

Undertakes a contextual load.

Type Parameters:

R - Return type from WoofLoaderSettings.WoofLoaderRunnable.

E - Possible Throwable from WoofLoaderSettings.WoofLoaderRunnable.

Parameters:

runnable - WoofLoaderSettings.WoofLoaderRunnable to configure the contextual load.

Returns:

Returned object from WoofLoaderSettings.WoofLoaderRunnable.

Throws:

E - Potential failure.