org.forgerock.cuppa.model

Class Hook

java.lang.Object

org.forgerock.cuppa.model.Hook

public final class Hook
extends java.lang.Object

Models a function that is executed before or after a test is run.

A Hook is usually created using Cuppa.before(HookFunction), Cuppa.after(HookFunction), Cuppa.beforeEach(HookFunction) or Cuppa.afterEach(HookFunction) but can be constructed directly.

Field Summary

Fields

Modifier and Type	Field and Description
java.util.Optional<java.lang.String>	description An optional description.
HookFunction	function A function to be executed (possibly more than once).
java.lang.Class<?>	testClass The class that the hook was defined in.
HookType	type The type of the hook.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
int	hashCode()
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

type

public final HookType type

The type of the hook.

testClass

public final java.lang.Class<?> testClass

The class that the hook was defined in.

description

public final java.util.Optional<java.lang.String> description

An optional description.

function

public final HookFunction function

A function to be executed (possibly more than once).

Method Detail

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object