Package io.spine.logging.flogger.parser

Class MessageParser

java.lang.Object

io.spine.logging.flogger.parser.MessageParser

Direct Known Subclasses:

BraceStyleMessageParser, PrintfMessageParser

public abstract class MessageParser
extends Object

Base class from which any specific message parsers are derived (e.g. PrintfMessageParser and BraceStyleMessageParser).

See Also:

Original Java code of Google Flogger

Field Summary

Fields

Modifier and Type	Field	Description
static int	MAX_ARG_COUNT	The maximum allowed index (this should correspond to the MAX_ALLOWED_WIDTH in FormatOptions because at times it is ambiguous as to which is being parsed).

Constructor Summary

Constructors

Constructor	Description
MessageParser()

Method Summary

Modifier and Type	Method	Description
protected abstract <T> void	parseImpl(MessageBuilder<T> builder)	Abstract parse method implemented by specific subclasses to modify parsing behavior.
abstract void	unescape(StringBuilder out, String message, int start, int end)	Appends the unescaped literal representation of the given message string (assumed to be escaped according to this parser's escaping rules).

Methods inherited from class java.lang.Object

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

Field Detail

MAX_ARG_COUNT

public static final int MAX_ARG_COUNT

The maximum allowed index (this should correspond to the MAX_ALLOWED_WIDTH in FormatOptions because at times it is ambiguous as to which is being parsed).

See Also:

Constant Field Values

Constructor Detail

MessageParser

public MessageParser()

Method Detail

parseImpl

protected abstract <T> void parseImpl(MessageBuilder<T> builder)
                               throws ParseException

Abstract parse method implemented by specific subclasses to modify parsing behavior.

Note that when extending parsing behavior, it is expected that specific parsers such as DefaultPrintfMessageParser or DefaultBraceStyleMessageParser will be sub-classed. Extending this class directly is only necessary when an entirely new type of format needs to be supported (which should be extremely rare).

Implementations of this method are required to invoke the MessageBuilder.addParameterImpl(int, int, io.spine.logging.flogger.parameter.Parameter) method of the supplied builder once for each parameter place-holder in the message.

Throws:

ParseException

unescape

public abstract void unescape(StringBuilder out,
                              String message,
                              int start,
                              int end)

Appends the unescaped literal representation of the given message string (assumed to be escaped according to this parser's escaping rules). This method is designed to be invoked from a callback method in a MessageBuilder instance.

Parameters:

out - the destination into which to append characters

message - the escaped log message

start - the start index (inclusive) in the log message

end - the end index (exclusive) in the log message