StructuredLogFormatterFactory (spring-boot 3.4.0)

java.lang.Object

org.springframework.boot.logging.structured.StructuredLogFormatterFactory<E>

Type Parameters:: E - the log even type

public class StructuredLogFormatterFactory<E> extends Object

Factory that can be used to create a fully instantiated StructuredLogFormatter for either a common format or a fully-qualified class name.

Since:

3.4.0

See Also:

StructuredLogFormatter

Nested Class Summary

Nested Classes

Modifier and Type

Class

Description

static interface

StructuredLogFormatterFactory.CommonFormatterFactory<E>

Factory used to create a StructuredLogFormatter for a given CommonStructuredLogFormat.

static class

StructuredLogFormatterFactory.CommonFormatters<E>

Callback used for configure the StructuredLogFormatterFactory.CommonFormatterFactory to use for a given CommonStructuredLogFormat.
Constructor Summary

Constructors

Constructor

Description

StructuredLogFormatterFactory(Class<E> logEventType, org.springframework.core.env.Environment environment, Consumer<Instantiator.AvailableParameters> availableParameters, Consumer<StructuredLogFormatterFactory.CommonFormatters<E>> commonFormatters)

Create a new StructuredLogFormatterFactory instance.
Method Summary

Modifier and Type

Method

Description

StructuredLogFormatter<E>

get(String format)

Get a new StructuredLogFormatter instance for the specified format.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details
- StructuredLogFormatterFactory
  
  public StructuredLogFormatterFactory(Class<E> logEventType, org.springframework.core.env.Environment environment, Consumer<Instantiator.AvailableParameters> availableParameters, Consumer<StructuredLogFormatterFactory.CommonFormatters<E>> commonFormatters)
  
  Create a new StructuredLogFormatterFactory instance.
  
  Parameters:
  
  logEventType - the log event type
  
  environment - the Spring Environment
  
  availableParameters - callback used to configure available parameters for the specific logging system
  
  commonFormatters - callback used to define supported common formatters
Method Details
- get
  
  public StructuredLogFormatter<E> get(String format)
  
  Get a new StructuredLogFormatter instance for the specified format.
  
  Parameters:
  
  format - the format requested (either a CommonStructuredLogFormat ID or a fully-qualified class name)
  
  Returns:
  
  a new StructuredLogFormatter instance
  
  Throws:
  
  IllegalArgumentException - if the format is unknown