Class PatternConfigBuilder

java.lang.Object

io.jstach.rainbowgum.pattern.format.PatternConfigBuilder

All Implemented Interfaces:

LogBuilder<PatternConfigBuilder, PatternConfig>

public final class PatternConfigBuilder
extends Object
implements LogBuilder<PatternConfigBuilder, PatternConfig>

Builder to create PatternConfig.

Properties retrieved from LogProperties

Property Pattern	Type	Required	Default	Description
"logging.pattern.config.{name}.zoneId"	String (converted)	false	null
"logging.pattern.config.{name}.lineSeparator"	String	false	null
"logging.pattern.config.{name}.ansiDisabled"	Boolean	false	null
"logging.pattern.config.{name}.sequenceNumberStart"	String (converted)	false	null

Constructor Summary

Constructors

Constructor	Description
PatternConfigBuilder(String name)	Create a builder for io.jstach.rainbowgum.pattern.format.PatternConfig .

Method Summary

Modifier and Type	Method	Description
PatternConfigBuilder	ansiDisabled(@Nullable Boolean ansiDisabled)	Sets ansiDisabled.
PatternConfig	build()	Creates io.jstach.rainbowgum.pattern.format.PatternConfig from this builder.
PatternConfigBuilder	fromProperties(LogProperties properties)	Will try to convert string key values to parameters needed by the builder.
PatternConfigBuilder	lineSeparator(@Nullable String lineSeparator)	Sets lineSeparator.
PatternConfigBuilder	propertyFunction(@Nullable Function<String, @Nullable String> propertyFunction)	Sets propertyFunction.
String	propertyPrefix()	The interpolated property prefix: "logging.pattern.config.{name}.".
PatternConfigBuilder	sequenceNumberStart(@Nullable Long sequenceNumberStart)	Sets sequenceNumberStart.
PatternConfigBuilder	startTime(@Nullable Instant startTime)	Sets startTime.
void	toProperties(BiConsumer<String,String> consumer)	Turns the builder into java.util.Properties like Map skipping values that are null.
PatternConfigBuilder	zoneId(@Nullable ZoneId zoneId)	Sets zoneId.

Methods inherited from class Object

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

Methods inherited from interface LogBuilder

fromProperties

Modifier and Type	Method	Description
default PatternConfigBuilder	fromProperties(LogProperties properties, LogProviderRef ref)	Will try to convert string key values to parameters needed by the builder.

Constructor Details

PatternConfigBuilder

public PatternConfigBuilder(String name)

Create a builder for io.jstach.rainbowgum.pattern.format.PatternConfig .

Parameters:

name - will fill {name} in logging.pattern.config.{name}..

Method Details

propertyFunction

public PatternConfigBuilder propertyFunction(@Nullable Function<String, @Nullable String> propertyFunction)

Sets propertyFunction. Default is null.

Parameters:

propertyFunction - not configurable through properties

Returns:

this builder.

startTime

public PatternConfigBuilder startTime(@Nullable Instant startTime)

Sets startTime. Default is null.

Parameters:

startTime - not configurable through properties

Returns:

this builder.

zoneId

public PatternConfigBuilder zoneId(@Nullable ZoneId zoneId)

Sets zoneId. Default is null.

Parameters:

zoneId - "logging.pattern.config.{name}.zoneId" = java.time.ZoneId

Returns:

this builder.

lineSeparator

public PatternConfigBuilder lineSeparator(@Nullable String lineSeparator)

Sets lineSeparator. Default is null.

Parameters:

lineSeparator - "logging.pattern.config.{name}.lineSeparator" = java.lang.String

Returns:

this builder.

ansiDisabled

public PatternConfigBuilder ansiDisabled(@Nullable Boolean ansiDisabled)

Sets ansiDisabled. Default is null.

Parameters:

ansiDisabled - "logging.pattern.config.{name}.ansiDisabled" = java.lang.Boolean

Returns:

this builder.

sequenceNumberStart

public PatternConfigBuilder sequenceNumberStart(@Nullable Long sequenceNumberStart)

Sets sequenceNumberStart. Default is null.

Parameters:

sequenceNumberStart - "logging.pattern.config.{name}.sequenceNumberStart" = java.lang.Long

Returns:

this builder.

build

public PatternConfig build()

Creates io.jstach.rainbowgum.pattern.format.PatternConfig from this builder.

Returns:

io.jstach.rainbowgum.pattern.format.PatternConfig .

fromProperties

public PatternConfigBuilder fromProperties(LogProperties properties)

Description copied from interface: LogBuilder

Will try to convert string key values to parameters needed by the builder.

Specified by:

fromProperties in interface LogBuilder<PatternConfigBuilder, PatternConfig>

Parameters:

properties - log properties

Returns:

this.

toProperties

public void toProperties(BiConsumer<String,String> consumer)

Turns the builder into java.util.Properties like Map skipping values that are null.

Parameters:

consumer - apply is called where first arg is key and second is value.

propertyPrefix

public String propertyPrefix()

The interpolated property prefix: "logging.pattern.config.{name}.".

Specified by:

propertyPrefix in interface LogBuilder<PatternConfigBuilder, PatternConfig>

Returns:

resolved prefix which should end with a ".".

See Also:

• LogConfigurable.prefix()