de.skuzzle.tinyplugz

Interface TinyPlugzConfigurator.DefineProperties

Enclosing class:

TinyPlugzConfigurator

public static interface TinyPlugzConfigurator.DefineProperties

Part of the fluent configurator API. Used to define configuration properties and the plugins to be used.

Author:

Simon Taddiken

Method Summary

Modifier and Type	Method and Description
TinyPlugzConfigurator.DefineProperties	withClasspathProperties() Adds properties read from file from the class path.
TinyPlugzConfigurator.DefineProperties	withClasspathProperties(String resourceName) Adds properties read from the class path using the given resource name.
TinyPlugzConfigurator.DeployTinyPlugz	withPlugins(Consumer<PluginSource> source) Provides the PluginSource via the given consumer for adding plugins which should be deployed.
TinyPlugzConfigurator.DefineProperties	withProperties(Map<? extends Object,? extends Object> values) Specifies a multiple properties to insert into the map which will be passed to TinyPlugz.initialize(java.util.Collection, ClassLoader, Map) .
TinyPlugzConfigurator.DefineProperties	withProperty(String name) Specifies a property without value.
TinyPlugzConfigurator.DefineProperties	withProperty(String name, Object value) Specifies a single property to insert into the map which will be passed to TinyPlugz.initialize(java.util.Collection, ClassLoader, Map) .

Method Detail

withClasspathProperties

TinyPlugzConfigurator.DefineProperties withClasspathProperties()

Adds properties read from file from the class path.

Returns:

A fluent builder object for further configuration.

Throws:

IllegalStateException - If the file can not be found.

withClasspathProperties

TinyPlugzConfigurator.DefineProperties withClasspathProperties(String resourceName)

Adds properties read from the class path using the given resource name.

Parameters:

resourceName - Name of the properties file resource.

Returns:

A fluent builder object for further configuration.

Throws:

IllegalStateException - If the file can not be found.

withProperty

TinyPlugzConfigurator.DefineProperties withProperty(String name,
                                                    Object value)

Specifies a single property to insert into the map which will be passed to TinyPlugz.initialize(java.util.Collection, ClassLoader, Map) .

Parameters:

name - Name of the property.

value - Value of the property.

Returns:

A fluent builder object for further configuration.

withProperty

TinyPlugzConfigurator.DefineProperties withProperty(String name)

Specifies a property without value. It will automatically get assigned a non-null value.

Parameters:

name - Name of the property.

Returns:

A fluent builder object for further configuration.

withProperties

TinyPlugzConfigurator.DefineProperties withProperties(Map<? extends Object,? extends Object> values)

Specifies a multiple properties to insert into the map which will be passed to TinyPlugz.initialize(java.util.Collection, ClassLoader, Map) .

Parameters:

values - Mappings to add.

Returns:

A fluent builder object for further configuration.

withPlugins

TinyPlugzConfigurator.DeployTinyPlugz withPlugins(Consumer<PluginSource> source)

Provides the PluginSource via the given consumer for adding plugins which should be deployed.

Parameters:

source - Consumer for modifying a PluginSourcce.

Returns:

A fluent builder object for further configuration.