com.xatkit.core.platform.io

Class EventInstanceBuilder

java.lang.Object

com.xatkit.core.platform.io.EventInstanceBuilder

public class EventInstanceBuilder
extends Object

A fluent EventInstance builder.

This class eases the creation of new EventInstances, and provides a fluent API to set the EventDefinition and output context parameter values. The builder checks that the created EventInstances are valid (i.e. they are associated to a registered EventDefinition and their output context parameter values correspond to existing ContextParameters.

Method Summary

Modifier and Type	Method and Description
com.xatkit.intent.EventInstance	build() Creates a new EventInstance from the provided information.
void	clear() Clears the builder and reset its internal fields.
String	getEventDefinitionName() Returns the name of the EventDefinition to bind to the created EventInstance.
Map<String,String>	getOutContextValues() Returns an unmodifiable Map containing the output context parameters to bind to the EventInstance.
static EventInstanceBuilder	newBuilder(EventDefinitionRegistry registry) Creates a new EventInstanceBuilder from the provided registry.
String	prettyPrintEventDefinition() Prints a pretty representation of the current EventDefinition to instantiate with this builder.
EventInstanceBuilder	setEventDefinitionName(String eventDefinitionName) Sets the name of the EventDefinition to bind to the created EventInstance.
EventInstanceBuilder	setOutContextValue(String contextKey, String contextValue) Sets the created EventInstance's output context parameter contextKey with the given contextValue.

Methods inherited from class java.lang.Object

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

Method Detail

newBuilder

public static EventInstanceBuilder newBuilder(EventDefinitionRegistry registry)

Creates a new EventInstanceBuilder from the provided registry.

The provided EventDefinitionRegistry is used to validate the EventDefinition name provided by setEventDefinitionName(String), and ensure that the created EventInstance is bound to a registered EventDefinition.

Parameters:

registry - the EventDefinitionRegistry used to validate the EventInstance's definition name

Returns:

the created EventInstanceBuilder

Throws:

NullPointerException - if the provided registry is null

setEventDefinitionName

public EventInstanceBuilder setEventDefinitionName(String eventDefinitionName)

Sets the name of the EventDefinition to bind to the created EventInstance.

The provided eventDefinitionName must match an existing EventDefinition name in the provided EventDefinitionRegistry.

Parameters:

eventDefinitionName - the name of the EventDefinition to bind to the created EventInstance

Returns:

the builder

Throws:

NullPointerException - if the provided eventDefinitionName is null

getEventDefinitionName

public String getEventDefinitionName()

Returns the name of the EventDefinition to bind to the created EventInstance.

Returns:

the name of the EventDefinition to bind to the created EventInstance

setOutContextValue

public EventInstanceBuilder setOutContextValue(String contextKey,
                                               String contextValue)

Sets the created EventInstance's output context parameter contextKey with the given contextValue.

The provided contextKey should match an existing ContextParameter name in the associated EventDefinition.

Parameters:

contextKey - the output context parameter name

contextValue - the output context parameter value

Returns:

the builder

Throws:

NullPointerException - if the provided contextKey or contextValue is null

getOutContextValues

public Map<String,String> getOutContextValues()

Returns an unmodifiable Map containing the output context parameters to bind to the EventInstance.

Returns:

an unmodifiable Map containing the output context parameters to bind to the EventInstance

build

public com.xatkit.intent.EventInstance build()

Creates a new EventInstance from the provided information.

This method validates the provided information before creating the EventInstance. The provided EventDefinition name is used to retrieve the associated EventDefinition from the registry, and the EventDefinition's ContextParameters are processed and matched against the provided output context parameters.

Note: the builder will be cleared after returning the created EventInstance in order to allow multiple EventInstance creations from the same EventInstanceBuilder (see clear()).

Returns:

the created EventInstance

Throws:

XatkitException - if there is no EventDefinition associated to the provided name, or if the EventDefinition does not define the ContextParameters representing the provided ones

See Also:

setEventDefinitionName(String), setOutContextValue(String, String), clear()

clear

public void clear()

Clears the builder and reset its internal fields.

Note: this method is automatically called after calling build().

prettyPrintEventDefinition

public String prettyPrintEventDefinition()

Prints a pretty representation of the current EventDefinition to instantiate with this builder.

This method provides a human-readable view of the builder content that is used for debugging purposes.

Returns:

a pretty representation of the current EventDefinition to instantiate with this builder