org.epics.pvmanager

Class WriteRecipeBuilder

java.lang.Object

org.epics.pvmanager.WriteRecipeBuilder

public class WriteRecipeBuilder
extends Object

A builder for WriteRecipe.

Author:

carcassi

Constructor Summary

Constructors

Constructor and Description
WriteRecipeBuilder() A new builder

Method Summary

Methods

Modifier and Type	Method and Description
WriteRecipeBuilder	addChannel(String channelName, WriteCache<?> writeCache) Adds a channel and its write cache to the recipe.
WriteRecipe	build(WriteFunction<Exception> exceptionWriteFunction, ConnectionCollector connectionCollector) Builds the recipe.

Methods inherited from class java.lang.Object

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

Constructor Detail

WriteRecipeBuilder

public WriteRecipeBuilder()

A new builder

Method Detail

addChannel

public WriteRecipeBuilder addChannel(String channelName,
                            WriteCache<?> writeCache)

Adds a channel and its write cache to the recipe.

Parameters:

channelName - the name of the channel

writeCache - the cache that will store the value to write

Returns:

this builder

build

public WriteRecipe build(WriteFunction<Exception> exceptionWriteFunction,
                ConnectionCollector connectionCollector)

Builds the recipe.

To finish building the recipe, one needs to specify where to send errors and where to send the connection status changes.

Parameters:

exceptionWriteFunction - where exception should be routed

connectionCollector - where connection status should be routed

Returns:

a new WriteRecipe