com.brinkus.labs.neo4j.health.type

Class Health.Builder

java.lang.Object

com.brinkus.labs.neo4j.health.type.Health.Builder

Enclosing class:

Health

public static class Health.Builder
extends Object

Builder for creating immutable Health instances.

Constructor Summary

Constructors

Constructor and Description
Builder() Create new Builder instance.

Method Summary

Modifier and Type	Method and Description
Health	build() Create a new Health instance with the previously specified code and details.
Health.Builder	down() Set status to HealthStatus.DOWN.
Health.Builder	outOfService() Set status to HealthStatus.OUT_OF_SERVICE.
Health.Builder	status(HealthStatus status) Set status to given HealthStatus instance.
Health.Builder	status(HealthStatusCode statusCode) Set status to given statusCode.
Health.Builder	unknown() Set status to HealthStatus.UNKNOWN status.
Health.Builder	up() Set status to HealthStatus.UP status.
Health.Builder	withDetail(String key, Object data) Record detail using key and value.
Health.Builder	withException(Exception ex) Record detail for given Exception.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Create new Builder instance.

Method Detail

withException

public Health.Builder withException(Exception ex)

Record detail for given Exception.

Parameters:

ex - the exception

Returns:

this Health.Builder instance

withDetail

public Health.Builder withDetail(String key,
                                 Object data)

Record detail using key and value.

Parameters:

key - the detail key

data - the detail data

Returns:

this Health.Builder instance

unknown

public Health.Builder unknown()

Set status to HealthStatus.UNKNOWN status.

Returns:

this Health.Builder instance

up

public Health.Builder up()

Set status to HealthStatus.UP status.

Returns:

this Health.Builder instance

down

public Health.Builder down()

Set status to HealthStatus.DOWN.

Returns:

this Health.Builder instance

outOfService

public Health.Builder outOfService()

Set status to HealthStatus.OUT_OF_SERVICE.

Returns:

this Health.Builder instance

status

public Health.Builder status(HealthStatusCode statusCode)

Set status to given statusCode.

Parameters:

statusCode - the status code

Returns:

this Health.Builder instance

status

public Health.Builder status(HealthStatus status)

Set status to given HealthStatus instance.

Parameters:

status - the status

Returns:

this Health.Builder instance

build

public Health build()

Create a new Health instance with the previously specified code and details.

Returns:

a new Health instance