Top Description Methods
reactor.blockhound.integration

public Interface BlockHoundIntegration

extends Comparable<BlockHoundIntegration>
Known Direct Implementers
reactor.blockhound.integration.LoggingIntegration, reactor.blockhound.integration.ReactorIntegration, reactor.blockhound.integration.RxJava2Integration, reactor.blockhound.integration.StandardOutputIntegration
Imports
reactor.blockhound.BlockHound
An interface that defines the contract for the BlockHound integrations. BlockHoundIntegration#applyTo(BlockHound.Builder) will receive an instance of the builder that is being installed. One can override Comparable#compareTo(Object) to ensure the order in case one needs to run an integration before or after another.

Method Summary

Modifier and TypeMethod and Description
public void
applyTo(BlockHound.Builder
an instance of BlockHound.Builder that is being installed
builder)

Lets an integration apply the customizations (see BlockHound.Builder) before BlockHound is installed.

public default int
compareTo(BlockHoundIntegration
the object to be compared.
o)

Implements java.lang.Comparable.compareTo.

Compares this object with the specified object for order.
public default int

Returns:

The BlockHoundIntegration plugin priority, 0 by default.
getPriority()

Returns the default priority level for this integration.

Method Detail

applyToback to summary
public void applyTo(BlockHound.Builder builder)

Lets an integration apply the customizations (see BlockHound.Builder) before BlockHound is installed.

Parameters
builder:BlockHound.Builder

an instance of BlockHound.Builder that is being installed

compareToback to summary
public default int compareTo(BlockHoundIntegration o)

Implements java.lang.Comparable.compareTo.

Doc from java.lang.Comparable.compareTo.

Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

The implementor must ensure signum(x.compareTo(y)) == -signum(y.compareTo(x)) for all x and y. (This implies that x.compareTo(y) must throw an exception if and only if y.compareTo(x) throws an exception.)

The implementor must also ensure that the relation is transitive: (x.compareTo(y) > 0 && y.compareTo(z) > 0) implies x.compareTo(z) > 0.

Finally, the implementor must ensure that x.compareTo(y)==0 implies that signum(x.compareTo(z)) == signum(y.compareTo(z)), for all z.

Parameters
o:BlockHoundIntegration

the object to be compared.

Returns:int

a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

Annotations
@Override
getPriorityback to summary
public default int getPriority()

Returns the default priority level for this integration. The priority level controls the ordering of the BlockHoundIntegration plugins. Plugins which do not provide a priority are sorted using natural ordering, and their applyTo(BlockHound.Builder) method will be called using the order in which the plugins are loaded.

Returns:int

The BlockHoundIntegration plugin priority, 0 by default.

See Also
compareTo(BlockHoundIntegration)