Module io.jstach.rainbowgum

Package io.jstach.rainbowgum

Class RainbowGum.Builder

java.lang.Object

io.jstach.rainbowgum.RainbowGum.Builder

Enclosing interface:

RainbowGum

public static class RainbowGum.Builder
extends Object

RainbowGum Builder.

Method Summary

Modifier and Type	Method	Description
RainbowGum	build()	Builds an un-started RainbowGum.
Optional<RainbowGum>	optional()	For returning an optional for the LogProvider contract.
Optional<RainbowGum>	optional(Function<? super LogConfig,Boolean> condition)	For returning an optional for the LogProvider contract.
RainbowGum.Builder	route(LogRouter.Router route)	Adds a router.
RainbowGum.Builder	route(String name, Consumer<LogRouter.Router.Builder> consumer)	Adds a route by using a consumer of the route builder.
RainbowGum.Builder	route(Consumer<LogRouter.Router.Builder> consumer)	Adds a route by using a consumer of the route builder.
RainbowGum	set()	Builds, starts and sets the RainbowGum as the global one picked up by logging facades.
void	unset()	Removes the currently set Rainbow Gum which will close it if one exists and will be replaced by the default provision process if RainbowGum.of() is called before set().

Methods inherited from class java.lang.Object

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

Method Details

route

public RainbowGum.Builder route(LogRouter.Router route)

Adds a router.

Parameters:

route - a router.

Returns:

builder.

route

public RainbowGum.Builder route(String name,
 Consumer<LogRouter.Router.Builder> consumer)

Adds a route by using a consumer of the route builder.

Parameters:

name - name of router.

consumer - consumer is passed router builder. The consumer does not need to call LogRouter.Router.builder(String,LogConfig)

Returns:

builder.

See Also:

• LogRouter.Router.Builder

route

public RainbowGum.Builder route(Consumer<LogRouter.Router.Builder> consumer)

Adds a route by using a consumer of the route builder.

Parameters:

consumer - consumer is passed router builder. The consumer does not need to call LogRouter.Router.builder(String,LogConfig)

Returns:

builder.

See Also:

• LogRouter.Router.Builder

build

public RainbowGum build()

Builds an un-started RainbowGum.

Returns:

an un-started RainbowGum.

set

public RainbowGum set()

Builds, starts and sets the RainbowGum as the global one picked up by logging facades.

Returns:

started and set rainbow that can be used in a try-close.

unset

public void unset()

Removes the currently set Rainbow Gum which will close it if one exists and will be replaced by the default provision process if RainbowGum.of() is called before set().

API Note

This is largely an internal detail for unit testing the provision process.

optional

public Optional<RainbowGum> optional()

For returning an optional for the LogProvider contract.

Returns:

optional that always has a rainbow gum.

API Note

this method is for ergonomics.

optional

public Optional<RainbowGum> optional(Function<? super LogConfig,Boolean> condition)

For returning an optional for the LogProvider contract.

Parameters:

condition - condition to check if this rainbow gum should be used.

Returns:

optional rainbow gum.

API Note

this method is for ergonomics.