Module io.jstach.rainbowgum

Package io.jstach.rainbowgum

Interface LogRouter.Router

All Superinterfaces:

AutoCloseable, LogEventLogger, LogLifecycle, LogRouter

All Known Implementing Classes:

LogRouter.AbstractRouter

Enclosing interface:

LogRouter

public static sealed interface LogRouter.Router
extends LogRouter, LogEventLogger
permits LogRouter.AbstractRouter (not exhaustive)

Router routes messages to a publisher.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	LogRouter.Router.Builder	Router builder.
static interface	LogRouter.Router.RouterFactory	Creates a router.

Nested classes/interfaces inherited from interface io.jstach.rainbowgum.LogRouter

LogRouter.AbstractRouter, LogRouter.RootRouter, LogRouter.Route, LogRouter.RouteFlag, LogRouter.Router

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_ROUTER_NAME	The router name given if no router is explicitly declared.

Fields inherited from interface io.jstach.rainbowgum.LogLifecycle

SHUTDOWN

Method Summary

Modifier and Type	Method	Description
static LogRouter.Router.Builder	builder(String name, LogConfig config)	Creates a builder from config.
LevelResolver	levelResolver()	Level resolver.
default void	log(LogEvent event)	Logs events usually without filtering.
LogPublisher	publisher()	Log publisher.
default boolean	synchronous()	Whether or not the publisher is synchronous.

Methods inherited from interface io.jstach.rainbowgum.LogLifecycle

close, start

Methods inherited from interface io.jstach.rainbowgum.LogRouter

eventBuilder, route

Field Details

DEFAULT_ROUTER_NAME

static final String DEFAULT_ROUTER_NAME

The router name given if no router is explicitly declared.

See Also:

• Constant Field Values

Method Details

levelResolver

LevelResolver levelResolver()

Level resolver.

Returns:

level resolver.

publisher

LogPublisher publisher()

Log publisher.

Returns:

publisher.

synchronous

default boolean synchronous()

Whether or not the publisher is synchronous. A synchronous publisher generally blocks.

Returns:

true if the publisher is synchronous.

log

default void log(LogEvent event)

Description copied from interface: LogEventLogger

Logs events usually without filtering. There is no guarantee this call will check if the event should be filtered (threshold is too low) and in general does not on purpose!

Specified by:

log in interface LogEventLogger

Parameters:

event - event.

builder

static LogRouter.Router.Builder builder(String name,
 LogConfig config)

Creates a builder from config.

Parameters:

name - name of the route which the publisher will inherit.

config - config.

Returns:

builder.