Interface LogRouter

All Superinterfaces:

AutoCloseable, LogLifecycle

All Known Subinterfaces:

LogRouter.RootRouter, LogRouter.Router

All Known Implementing Classes:

LogRouter.AbstractRouter

public sealed interface LogRouter
extends LogLifecycle
permits LogRouter.RootRouter, LogRouter.Router

Routes messages to a publisher by providing a LogRouter.Route from a logger name and level.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	LogRouter.AbstractRouter	A user supplied router usually for filtering or transforming purposes.
static interface	LogRouter.RootRouter	Root router is a router that has child routers.
static interface	LogRouter.Route	A route is similar to a SLF4J Logger or System Logger but has a much simpler contract.
static enum	LogRouter.RouteFlag	Router flags for adhoc router customization.
static interface	LogRouter.Router	Router routes messages to a publisher.

Method Summary

Modifier and Type	Method	Description
default LogEvent.Builder	eventBuilder(String loggerName, System.Logger.Level level)	Creates (or reuses in the case of logging off) an event builder.
static LogRouter.RootRouter	global()	Global router which is always available.
LogRouter.Route	route(String loggerName, System.Logger.Level level)	Finds a route.

Methods inherited from interface LogLifecycle

close, start

Modifier and Type	Method	Description
void	close()
void	start(LogConfig config)	Starts a component.

Method Details

route

LogRouter.Route route(String loggerName,
 System.Logger.Level level)

Finds a route.

Parameters:

loggerName - topic.

level - level.

Returns:

route never null.

eventBuilder

default LogEvent.Builder eventBuilder(String loggerName,
 System.Logger.Level level)

Creates (or reuses in the case of logging off) an event builder.

Parameters:

loggerName - logger name of the event.

level - level that the event should be set to.

Returns:

builder.

API Note

using the builder is slightly slower and possibly more garbage (if the builder is not marked for escape analysis) than just manually checking LogRouter.Route.isEnabled() and constructing the event using the LogEvent static "of" factory methods.

global

static LogRouter.RootRouter global()

Global router which is always available.

Returns:

global root router.