Package net.officefloor.plugin.managedobject.poll

Class StatePoller.Builder<S,F extends Enum<F>>

java.lang.Object

net.officefloor.plugin.managedobject.poll.StatePoller.Builder<S,F>

Enclosing class:

StatePoller<S,F extends Enum<F>>

public static class StatePoller.Builder<S,F extends Enum<F>>
extends Object

Builder for the StatePoller.

Method Summary

Modifier and Type	Method	Description
StatePoller<S,F>	build()	Builds the StatePoller.
StatePoller.Builder<S,F>	defaultPollInterval(long defaultPollInterval, TimeUnit unit)	Allows specifying the default poll interval.
StatePoller.Builder<S,F>	identifier(String identifier)	Allows providing an identifier in the log message to identify the StatePoller.
StatePoller.Builder<S,F>	logger(Logger logger)	Allows specifying the Logger.
StatePoller.Builder<S,F>	parameter(Function<StatePollContext<S>,Object> parameterFactory)	Allows providing a parameter to the ProcessState invoked from the ManagedObjectExecuteContext for polling.
StatePoller.Builder<S,F>	pollMargin(long margin, TimeUnit unit)	Allows specifying the poll margin.
StatePoller.Builder<S,F>	startup(Consumer<ManagedObjectStartupProcess> startupProcessDecorator)	Provides a decorator of the ManagedObjectStartupProcess.
StatePoller.Builder<S,F>	successLogLevel(Level successLogLevel)	Allows specifying the success log Level.

Methods inherited from class java.lang.Object

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

Method Details

defaultPollInterval

public StatePoller.Builder<S,F> defaultPollInterval(long defaultPollInterval,
 TimeUnit unit)

Allows specifying the default poll interval.

Parameters:

defaultPollInterval - Default poll interval.

unit - TimeUnit for the default poll interval.

Returns:

this.

pollMargin

public StatePoller.Builder<S,F> pollMargin(long margin,
 TimeUnit unit)

Allows specifying the poll margin. This is the margin before considering polling not triggering.

Parameters:

margin - Margin before assuming polling not triggering.

unit - TimeUnit.

Returns:

this.

successLogLevel

public StatePoller.Builder<S,F> successLogLevel(Level successLogLevel)

Allows specifying the success log Level.

Parameters:

successLogLevel - Success log Level. Providing null will reset to default.

Returns:

this.

logger

public StatePoller.Builder<S,F> logger(Logger logger)

Allows specifying the Logger.

Parameters:

logger - Logger. Providing null will reset to default.

Returns:

this.

parameter

public StatePoller.Builder<S,F> parameter(Function<StatePollContext<S>,Object> parameterFactory)

Allows providing a parameter to the ProcessState invoked from the ManagedObjectExecuteContext for polling.

Parameters:

parameterFactory - Factory for parameter.

Returns:

this.

identifier

public StatePoller.Builder<S,F> identifier(String identifier)

Allows providing an identifier in the log message to identify the StatePoller.

Parameters:

identifier - Identifier.

Returns:

this.

startup

public StatePoller.Builder<S,F> startup(Consumer<ManagedObjectStartupProcess> startupProcessDecorator)

Provides a decorator of the ManagedObjectStartupProcess.

Parameters:

startupProcessDecorator - Decorate of the ManagedObjectStartupProcess.

Returns:

this.

build

public StatePoller<S,F> build()

Builds the StatePoller.

Returns:

StatePoller.