Package io.cui.tools.logging

Class LogRecordModel

java.lang.Object

io.cui.tools.logging.LogRecordModel

All Implemented Interfaces:

LogRecord

public class LogRecordModel
extends Object
implements LogRecord

Represents a log-entry. Especially focuses on enforcing log-entry identifier, see getPrefix() and getIdentifier(). The template mechanism is the same as with CuiLogger, saying it accepts as well '%s' and '{}' as placeholder, even mixed. To simplify usage the prefix string will always be prepended on calling format(Object...)

Author:

Oliver Wolff

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	LogRecordModel.LogRecordModelBuilder

Method Summary

Modifier and Type	Method	Description
static LogRecordModel.LogRecordModelBuilder	builder()
String	format(Object... parameter)	Formats the template with the given object.
@NonNull Integer	getIdentifier()
protected String	getParsedMessageTemplate()
@NonNull String	getPrefix()
@NonNull String	getTemplate()
String	resolveIdentifierString()
Supplier<String>	supplier(Object... parameter)	Returns a Supplier view on the formatter

Methods inherited from class java.lang.Object

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

Method Detail

getParsedMessageTemplate

protected String getParsedMessageTemplate()

format

public String format(Object... parameter)

Description copied from interface: LogRecord

Formats the template with the given object. Important: it implicitly prepends the identifier, e.g. "CUI-100: " in front of the created message.

Specified by:

format in interface LogRecord

Parameters:

parameter - optional, used for filling the template

Returns:

the formated String.

supplier

public Supplier<String> supplier(Object... parameter)

Description copied from interface: LogRecord

Returns a Supplier view on the formatter

Specified by:

supplier in interface LogRecord

Parameters:

parameter - optional, used for filling the template

Returns:

a Supplier view on the formatter

resolveIdentifierString

public String resolveIdentifierString()

Specified by:

resolveIdentifierString in interface LogRecord

Returns:

the concatenated identifier String, e.g. CUI-100

builder

public static LogRecordModel.LogRecordModelBuilder builder()

getPrefix

@NonNull
public @NonNull String getPrefix()

Specified by:

getPrefix in interface LogRecord

Returns:

the prefix for identifying the log-entry, e.g. 'CUI'

getIdentifier

@NonNull
public @NonNull Integer getIdentifier()

Specified by:

getIdentifier in interface LogRecord

Returns:

the identifier for the concrete entry, e.g. '100'

getTemplate

@NonNull
public @NonNull String getTemplate()

Specified by:

getTemplate in interface LogRecord

Returns:

The message template for creating the log-message