net.engio.mbassy.bus.config

Class BusConfiguration

java.lang.Object

net.engio.mbassy.bus.config.BusConfiguration

All Implemented Interfaces:

IBusConfiguration

public class BusConfiguration
extends Object
implements IBusConfiguration

The bus configuration holds various parameters that can be used to customize the bus' runtime behaviour.

Constructor Summary

Constructors

Constructor and Description
BusConfiguration()

Method Summary

Methods

Modifier and Type	Method and Description
IBusConfiguration	addConfigurationErrorHandler(ConfigurationErrorHandler handler) Add a handler that is called when a misconfiguration is detected.
IBusConfiguration	addFeature(Feature feature) Add a feature to the given configuration, replacing any existing feature of the same type.
<T extends Feature> T	getFeature(Class<T> feature) Get a registered feature by its type (class).
<T> T	getProperty(String name, T defaultValue) Read a property from this configuration.
void	handleError(ConfigurationError error) Calls all ConfigurationErrorHandlers
boolean	hasProperty(String name) Check whether a property has been set.
IBusConfiguration	setProperty(String name, Object value) Set a property which will be read by the message bus constructor.

Methods inherited from class java.lang.Object

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

Constructor Detail

BusConfiguration

public BusConfiguration()

Method Detail

setProperty

public IBusConfiguration setProperty(String name,
                            Object value)

Description copied from interface: IBusConfiguration

Set a property which will be read by the message bus constructor. Existing value will be overwritten. Null values are supported (checking for existence of property will return true even if set to null).

Specified by:

setProperty in interface IBusConfiguration

Parameters:

name - The name of the property. Note: Each implementation may support different properties.

value - The value of the property.

Returns:

A reference to this bus configuration.

getProperty

public <T> T getProperty(String name,
                T defaultValue)

Description copied from interface: IBusConfiguration

Read a property from this configuration.

Specified by:

getProperty in interface IBusConfiguration

Type Parameters:

T - The type of property

Parameters:

name - The name of the property to be read.

defaultValue - The value to be returned if property was not found

Returns:

The value associated with the given property name or defaultValue if not present

hasProperty

public boolean hasProperty(String name)

Description copied from interface: IBusConfiguration

Check whether a property has been set.

Specified by:

hasProperty in interface IBusConfiguration

Returns:

true if property was set (even if set to null) false otherwise

getFeature

public <T extends Feature> T getFeature(Class<T> feature)

Description copied from interface: IBusConfiguration

Get a registered feature by its type (class).

Specified by:

getFeature in interface IBusConfiguration

addFeature

public IBusConfiguration addFeature(Feature feature)

Description copied from interface: IBusConfiguration

Add a feature to the given configuration, replacing any existing feature of the same type.

Specified by:

addFeature in interface IBusConfiguration

Parameters:

feature - The feature to add

Returns:

A reference to this bus configuration.

addConfigurationErrorHandler

public IBusConfiguration addConfigurationErrorHandler(ConfigurationErrorHandler handler)

Description copied from interface: IBusConfiguration

Add a handler that is called when a misconfiguration is detected.

Specified by:

addConfigurationErrorHandler in interface IBusConfiguration

handleError

public void handleError(ConfigurationError error)

Description copied from interface: IBusConfiguration

Calls all ConfigurationErrorHandlers

Specified by:

handleError in interface IBusConfiguration