org.forgerock.cuppa.model

Class HookBuilder

java.lang.Object

org.forgerock.cuppa.model.HookBuilder

public final class HookBuilder
extends java.lang.Object

A mutable builder that constructs Hook instances.

Constructor Summary

Constructors

Constructor and Description
HookBuilder()

Method Summary

Modifier and Type	Method and Description
Hook	build() Constructs a Hook using the values set on this builder.
HookBuilder	setDescription(java.util.Optional<java.lang.String> description) Sets the description of the hook.
HookBuilder	setFunction(HookFunction function) Sets the function to be executed.
HookBuilder	setTestClass(java.lang.Class<?> testClass) Sets the class that the hook was defined in.
HookBuilder	setType(HookType type) Sets the type of the hook.

Methods inherited from class java.lang.Object

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

Constructor Detail

HookBuilder

public HookBuilder()

Method Detail

setType

public HookBuilder setType(HookType type)

Sets the type of the hook.

Parameters:

type - The type.

Returns:

this HookBuilder.

setTestClass

public HookBuilder setTestClass(java.lang.Class<?> testClass)

Sets the class that the hook was defined in.

Parameters:

testClass - The class.

Returns:

this HookBuilder.

setDescription

public HookBuilder setDescription(java.util.Optional<java.lang.String> description)

Sets the description of the hook.

Parameters:

description - The description.

Returns:

this HookBuilder.

setFunction

public HookBuilder setFunction(HookFunction function)

Sets the function to be executed.

Parameters:

function - The function.

Returns:

this HookBuilder.

build

public Hook build()

Constructs a Hook using the values set on this builder.

Returns:

A new Hook.