de.skuzzle.tinyplugz

Interface TinyPlugzConfigurator.DefineProperties

All Superinterfaces:

TinyPlugzConfigurator.DeployTinyPlugz

Enclosing class:

TinyPlugzConfigurator

public static interface TinyPlugzConfigurator.DefineProperties
extends TinyPlugzConfigurator.DeployTinyPlugz

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
TinyPlugz	deploy() Finally deploys the TinyPlugz instance using the configured values.
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<PluginSourceBuilder> source) Provides the PluginSourceBuilder via the given consumer for adding plugins which should be deployed.
TinyPlugzConfigurator.DeployTinyPlugz	withPlugins(PluginSource source) Uses the given plugin source.
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(PluginSource, 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(PluginSource, ClassLoader, Map) .
TinyPlugzConfigurator.DefineProperties	withSystemProperties() Makes all system properties available in the map passed to TinyPlugz.initialize(PluginSource, ClassLoader, Map).

Methods inherited from interface de.skuzzle.tinyplugz.TinyPlugzConfigurator.DeployTinyPlugz

createInstance

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(PluginSource, 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.

withSystemProperties

TinyPlugzConfigurator.DefineProperties withSystemProperties()

Makes all system properties available in the map passed to TinyPlugz.initialize(PluginSource, ClassLoader, Map).

Returns:

A fluent builder object for further configuration.

Since:

0.2.0

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(PluginSource, ClassLoader, Map) .

Parameters:

values - Mappings to add.

Returns:

A fluent builder object for further configuration.

withPlugins

TinyPlugzConfigurator.DeployTinyPlugz withPlugins(Consumer<PluginSourceBuilder> source)

Provides the PluginSourceBuilder 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.

withPlugins

TinyPlugzConfigurator.DeployTinyPlugz withPlugins(PluginSource source)

Uses the given plugin source.

Parameters:

source - The plugins.

Returns:

A fluent builder object for further configuration.

Since:

0.2.0

deploy

TinyPlugz deploy()

Finally deploys the TinyPlugz instance using the configured values. The configured instance will be globally accessible using TinyPlugz.getInstance().

When calling this method, only plugins from the folder specified using the option Options.PLUGIN_FOLDER will be loaded. If this option is not specified, TinyPlugz will be deployed without any plugins.

Specified by:

deploy in interface TinyPlugzConfigurator.DeployTinyPlugz

Returns:

The configured instance.

Since:

0.2.0