Package io.spine.logging.flogger.backend

Class MetadataKeyValueHandlers

java.lang.Object

io.spine.logging.flogger.backend.MetadataKeyValueHandlers

public final class MetadataKeyValueHandlers
extends Object

A helper class providing the default callbacks and handlers for processing metadata as key/value pairs. It is expected that most text-based logger backends will format unknown metadata using the handlers from this class.

See Also:

Original Java code of Google Flogger

Method Summary

Modifier and Type	Method	Description
static MetadataHandler.Builder<FloggerMetadataKey.KeyValueHandler>	getDefaultBuilder(Set<FloggerMetadataKey<?>> ignored)	Returns a new MetadataHandler.Builder which handles all non-ignored metadata keys by dispatching their values to the key itself.
static MetadataHandler<FloggerMetadataKey.KeyValueHandler>	getDefaultHandler(Set<FloggerMetadataKey<?>> ignored)	Returns a new MetadataHandler which handles all non-ignored metadata keys by dispatching their values to the key itself.
static MetadataHandler.RepeatedValueHandler<Object,FloggerMetadataKey.KeyValueHandler>	getDefaultRepeatedValueHandler()	Returns a singleton value handler which dispatches metadata to a FloggerMetadataKey.KeyValueHandler.
static MetadataHandler.ValueHandler<Object,FloggerMetadataKey.KeyValueHandler>	getDefaultValueHandler()	Returns a singleton value handler which dispatches metadata to a FloggerMetadataKey.KeyValueHandler.

Methods inherited from class java.lang.Object

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

Method Detail

getDefaultValueHandler

public static MetadataHandler.ValueHandler<Object,FloggerMetadataKey.KeyValueHandler> getDefaultValueHandler()

Returns a singleton value handler which dispatches metadata to a FloggerMetadataKey.KeyValueHandler.

getDefaultRepeatedValueHandler

public static MetadataHandler.RepeatedValueHandler<Object,FloggerMetadataKey.KeyValueHandler> getDefaultRepeatedValueHandler()

Returns a singleton value handler which dispatches metadata to a FloggerMetadataKey.KeyValueHandler.

getDefaultBuilder

public static MetadataHandler.Builder<FloggerMetadataKey.KeyValueHandler> getDefaultBuilder(Set<FloggerMetadataKey<?>> ignored)

Returns a new MetadataHandler.Builder which handles all non-ignored metadata keys by dispatching their values to the key itself. This is convenient for generic metadata processing when used in conjunction with something like KeyValueFormatter.

The returned builder can be built immediately or customized further to handler some keys specially (e.g. allowing keys/values to modify logging behaviour).

Returns:

a builder configured with the default key/value handlers and ignored keys.

getDefaultHandler

public static MetadataHandler<FloggerMetadataKey.KeyValueHandler> getDefaultHandler(Set<FloggerMetadataKey<?>> ignored)

Returns a new MetadataHandler which handles all non-ignored metadata keys by dispatching their values to the key itself. This is convenient for generic metadata processing when used in conjunction with something like KeyValueFormatter.

Returns:

a handler configured with the default key/value handlers and ignored keys.