rsb

Class ParticipantCreateArgs<ConcreteClass extends ParticipantCreateArgs<?>>

java.lang.Object

rsb.ParticipantCreateArgs<ConcreteClass>

Type Parameters:

ConcreteClass - The specific subclass that needs to be returned in setters for the method chaining pattern so that subclass setters are still available after using one of the setters in this class.

Direct Known Subclasses:

InformerCreateArgs, ListenerCreateArgs, LocalServerCreateArgs, RemoteServerCreateArgs

public abstract class ParticipantCreateArgs<ConcreteClass extends ParticipantCreateArgs<?>>
extends Object

A parameter object used to specify the various parameters that are required to construct new Participant instances. This class is intended for method chaining. Subclasses exist for each participant type.

Author:

swrede, jwienke, jmoringe

Constructor Summary

Constructors

Constructor and Description
ParticipantCreateArgs()

Method Summary

Methods

Modifier and Type	Method and Description
ParticipantConfig	getConfig() Returns the ParticipantConfig to be used for the new Participant.
Participant	getParent() Returns the parent Participant of the Participant to create.
Scope	getScope() Returns the Scope to be used for the new Participant.
ConcreteClass	setConfig(ParticipantConfig config) Sets the ParticipantConfig to be used for the Participant .
ConcreteClass	setParent(Participant parent) Sets the parent Participant of the Participant to create.
ConcreteClass	setScope(Scope scope) Sets the Scope to be used for the Participant.

Methods inherited from class java.lang.Object

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

Constructor Detail

ParticipantCreateArgs

public ParticipantCreateArgs()

Method Detail

setConfig

public ConcreteClass setConfig(ParticipantConfig config)

Sets the ParticipantConfig to be used for the Participant .

Parameters:

config - new config to use. Can be null in case the default configuration shall be used.

Returns:

this instance for method chaining.

setScope

public ConcreteClass setScope(Scope scope)

Sets the Scope to be used for the Participant.

Parameters:

scope - new scope to use. Must not be null.

Returns:

this instance for method chaining.

getConfig

public ParticipantConfig getConfig()

Returns the ParticipantConfig to be used for the new Participant.

Returns:

the config

getScope

public Scope getScope()

Returns the Scope to be used for the new Participant.

Returns:

the scope

getParent

public Participant getParent()

Returns the parent Participant of the Participant to create.

Returns:

the parent of the Participant to create or null if no parent.

setParent

public ConcreteClass setParent(Participant parent)

Sets the parent Participant of the Participant to create.

Parameters:

parent - the parent to set or null for no parent

Returns:

this instance for method chaining