Package net.sf.eBus.config

Class EConfigure.McastNotifyBuilder

java.lang.Object

net.sf.eBus.config.EConfigure.McastNotifyBuilder

Enclosing class:

EConfigure

public static final class EConfigure.McastNotifyBuilder
extends Object

Builder used to create EConfigure.McastNotifyConfig instances. The single class constructor is private so a class instance is acquired by calling EConfigure.notificationBuilder().

Method Summary

Modifier and Type	Method	Description
EConfigure.McastNotifyConfig	build()	Returns a new multicast notification configuration created from the builder settings.
EConfigure.McastNotifyBuilder	feedType(EConfigure.MultifeedType type)	Sets notification multi-feed type to either LIST or QUERY.
EConfigure.McastNotifyBuilder	isDynamic(boolean flag)	Sets dynamic multi-feed flag to given value.
EConfigure.McastNotifyBuilder	messageClass(String name)	Sets the notification class and returns this multicast notification builder.
EConfigure.McastNotifyBuilder	subjectList(List<String> subjects)	Sets multi-feed subjects list.
EConfigure.McastNotifyBuilder	subjectQuery(String query)	Sets the subject query and returns this multicast notification builder.

Methods inherited from class java.lang.Object

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

Method Detail

feedType

public EConfigure.McastNotifyBuilder feedType(EConfigure.MultifeedType type)

Sets notification multi-feed type to either LIST or QUERY. This setting determines whether subjectList or subjectQuery method is used.

This setting is required.

Parameters:

type - multi-feed type.

Returns:

this McastNotifyBuilder instance.

Throws:

com.typesafe.config.ConfigException - if type is null.

messageClass

public EConfigure.McastNotifyBuilder messageClass(String name)

Sets the notification class and returns this multicast notification builder.

This setting is required for both list and query multi-feed types.

Parameters:

name - message class name.

Returns:

this McastNotifyBuilder instance.

Throws:

com.typesafe.config.ConfigException - if name is either null or an empty string.

subjectList

public EConfigure.McastNotifyBuilder subjectList(List<String> subjects)

Sets multi-feed subjects list. This value is ignored if multi-feed type is QUERY.

This setting is required if multicast feed type is set to EConfigure.MultifeedType.LIST.

Parameters:

subjects - multi-feed subjects list.

Returns:

this McastNotifyBuilder instance.

Throws:

com.typesafe.config.ConfigException - if subjects is either null or an empty list.

subjectQuery

public EConfigure.McastNotifyBuilder subjectQuery(String query)

Sets the subject query and returns this multicast notification builder. This value is ignored if multi-feed type is LIST.

This setting is required if multicast feed type is set to EConfigure.MultifeedType.QUERY.

Parameters:

query - subject query pattern.

Returns:

this McastNotifyBuilder instance.

Throws:

com.typesafe.config.ConfigException - if query is not a valid Pattern.

isDynamic

public EConfigure.McastNotifyBuilder isDynamic(boolean flag)

Sets dynamic multi-feed flag to given value. This value is ignored if multi-feed type is LIST.

This setting is optional and may be called only if the multicast feed type is EConfigure.MultifeedType.QUERY. Default setting is false.

Parameters:

flag - turn dynamic feed on or off.

Returns:

this McastNotifyBuilder instance.

build

public EConfigure.McastNotifyConfig build()

Returns a new multicast notification configuration created from the builder settings.

Returns:

multicast notification configuration.

Throws:

com.typesafe.config.ConfigException - if builder settings are invalid.