org.msbotframework4j.logging

Interface BotLogEntryBuilder

public interface BotLogEntryBuilder

Builder for BotLogEntry

Author:

Maksim Kanev

Method Summary

Methods

Modifier and Type	Method and Description
BotLogEntryBuilder	append(boolean value) Appends a boolean value to the builder
BotLogEntryBuilder	append(char ch) Appends a char value to the builder
BotLogEntryBuilder	append(double value) Appends a double value to the builder
BotLogEntryBuilder	append(float value) Appends a float value to the builder
BotLogEntryBuilder	append(int value) Appends an int value to this builder.
BotLogEntryBuilder	append(long value) Appends a long value to the builder
BotLogEntryBuilder	append(Object obj) Appends an object to this builder.
BotLogEntryBuilder	append(String str) Appends a string to this builder.
BotLogEntryBuilder	append(String format, Object... objs) Calls String.format(String, Object...) and appends the result
BotLogEntryBuilder	appendFixedWidthPadLeft(Object obj, int width, char padChar) Appends an object to the builder padding on the left to a fixed width.
BotLogEntryBuilder	appendFixedWidthPadRight(Object obj, int width, char padChar) Appends an object to the builder padding on the right to a fixed length.
BotLogEntryBuilder	appendln(boolean value) Appends a boolean value followed by a new line to the builder.
BotLogEntryBuilder	appendln(char ch) Appends a char value followed by a new line to the builder.
BotLogEntryBuilder	appendln(double value) Appends a double value followed by a new line to the builder.
BotLogEntryBuilder	appendln(float value) Appends a float value followed by a new line to the builder.
BotLogEntryBuilder	appendln(int value) Appends an int value followed by a new line to the builder.
BotLogEntryBuilder	appendln(long value) Appends a long value followed by a new line to the builder.
BotLogEntryBuilder	appendln(Object obj) Appends an object followed by a new line to this builder
BotLogEntryBuilder	appendln(String str) Appends a string followed by a new line to this builder
BotLogEntryBuilder	appendln(String format, Object... objs) Calls String.format(String, Object...) and appends the result followed by a new line to this builder.
BotLogEntryBuilder	appendNewLine() Appends the new line string to this builder.
BotLogEntryBuilder	appendPadding(int length, char padChar) Appends the pad character to the builder the specified number of times.
BotLogEntryBuilder	appendSeparator(char separator) Appends a separator if the builder is currently non-empty.
BotLogEntryBuilder	appendWhitespaceSeparator() Appends a whitespace character to this builder.
void	push() Calls BotLogger.log(BotLogEntry) to write message to a logging stream
BotLogEntryBuilder	trim() Trims the builder by removing characters less than or equal to a space from the beginning and end.
BotLogEntryBuilder	withException(Throwable exception) Sets the exception that would be accompanied with this message
BotLogEntryBuilder	withSeverity(BotLogSeverity severity) Sets the severity level using BotLogEntry.setSeverity(BotLogSeverity)

Method Detail

appendWhitespaceSeparator

BotLogEntryBuilder appendWhitespaceSeparator()

Appends a whitespace character to this builder.

Returns:

this, to enable chaining

See Also:

appendSeparator(char)

appendSeparator

BotLogEntryBuilder appendSeparator(char separator)

Appends a separator if the builder is currently non-empty.

Parameters:

separator - the separator to use

Returns:

this, to enable chaining

See Also:

StrBuilder.appendSeparator(char)

append

BotLogEntryBuilder append(Object obj)

Appends an object to this builder.

Parameters:

obj - the object to append

Returns:

this, to enable chaining

See Also:

StrBuilder.append(Object)

append

BotLogEntryBuilder append(String str)

Appends a string to this builder.

Parameters:

str - the string to append

Returns:

this, to enable chaining

See Also:

StrBuilder.append(String)

append

BotLogEntryBuilder append(String format,
                        Object... objs)

Calls String.format(String, Object...) and appends the result

Parameters:

format - the format string

objs - the objects to use in the format string

Returns:

this, to enable chaining

See Also:

StrBuilder.append(String, Object...)

appendNewLine

BotLogEntryBuilder appendNewLine()

Appends the new line string to this builder.

Returns:

this, to enable chaining

See Also:

StrBuilder.appendNewLine()

append

BotLogEntryBuilder append(int value)

Appends an int value to this builder.

Parameters:

value - the value to append

Returns:

this, to enable chaining

See Also:

StrBuilder.append(int)

append

BotLogEntryBuilder append(long value)

Appends a long value to the builder

Parameters:

value - the value to append

Returns:

this, to enable chaining

See Also:

StrBuilder.append(long)

append

BotLogEntryBuilder append(float value)

Appends a float value to the builder

Parameters:

value - the value to append

Returns:

this, to enable chaining

See Also:

StrBuilder.append(float)

append

BotLogEntryBuilder append(double value)

Appends a double value to the builder

Parameters:

value - the value to append

Returns:

this, to enable chaining

See Also:

StrBuilder.append(double)

append

BotLogEntryBuilder append(boolean value)

Appends a boolean value to the builder

Parameters:

value - the value to append

Returns:

this, to enable chaining

See Also:

StrBuilder.append(boolean)

append

BotLogEntryBuilder append(char ch)

Appends a char value to the builder

Parameters:

ch - the value to append

Returns:

this, to enable chaining

See Also:

StrBuilder.append(char)

appendln

BotLogEntryBuilder appendln(Object obj)

Appends an object followed by a new line to this builder

Parameters:

obj - the object to append

Returns:

this, to enable chaining

See Also:

StrBuilder.appendln(Object)

appendln

BotLogEntryBuilder appendln(String str)

Appends a string followed by a new line to this builder

Parameters:

str - the string to append

Returns:

this, to enable chaining

See Also:

StrBuilder.appendln(String)

appendln

BotLogEntryBuilder appendln(String format,
                          Object... objs)

Calls String.format(String, Object...) and appends the result followed by a new line to this builder.

Parameters:

format - the format string

objs - the objects to use in the format string

Returns:

this, to enable chaining

See Also:

StrBuilder.appendln(String, Object...)

appendln

BotLogEntryBuilder appendln(boolean value)

Appends a boolean value followed by a new line to the builder.

Parameters:

value - the value to append

Returns:

this, to enable chaining

See Also:

StrBuilder.appendln(boolean)

appendln

BotLogEntryBuilder appendln(char ch)

Appends a char value followed by a new line to the builder.

Parameters:

ch - the value to append

Returns:

this, to enable chaining

See Also:

StrBuilder.appendln(char)

appendln

BotLogEntryBuilder appendln(int value)

Appends an int value followed by a new line to the builder.

Parameters:

value - the value to append

Returns:

this, to enable chaining

See Also:

StrBuilder.appendln(int)

appendln

BotLogEntryBuilder appendln(long value)

Appends a long value followed by a new line to the builder.

Parameters:

value - the value to append

Returns:

this, to enable chaining

See Also:

StrBuilder.appendln(long)

appendln

BotLogEntryBuilder appendln(float value)

Appends a float value followed by a new line to the builder.

Parameters:

value - the value to append

Returns:

this, to enable chaining

See Also:

StrBuilder.appendln(float)

appendln

BotLogEntryBuilder appendln(double value)

Appends a double value followed by a new line to the builder.

Parameters:

value - the value to append

Returns:

this, to enable chaining

See Also:

StrBuilder.appendln(double)

appendPadding

BotLogEntryBuilder appendPadding(int length,
                               char padChar)

Appends the pad character to the builder the specified number of times.

Parameters:

length - the length to append, negative means no append

padChar - the character to append

Returns:

this, to enable chaining

See Also:

StrBuilder.appendPadding(int, char)

appendFixedWidthPadLeft

BotLogEntryBuilder appendFixedWidthPadLeft(Object obj,
                                         int width,
                                         char padChar)

Appends an object to the builder padding on the left to a fixed width.

Parameters:

obj - the object to append, null uses null text

width - the fixed field width, zero or negative has no effect

padChar - the pad character to use

Returns:

this, to enable chaining

See Also:

StrBuilder.appendFixedWidthPadLeft(Object, int, char)

appendFixedWidthPadRight

BotLogEntryBuilder appendFixedWidthPadRight(Object obj,
                                          int width,
                                          char padChar)

Appends an object to the builder padding on the right to a fixed length.

Parameters:

obj - the object to append, null uses null text

width - the fixed field width, zero or negative has no effect

padChar - the pad character to use

Returns:

this, to enable chaining

See Also:

StrBuilder.appendFixedWidthPadRight(Object, int, char)

trim

BotLogEntryBuilder trim()

Trims the builder by removing characters less than or equal to a space from the beginning and end.

Returns:

this, to enable chaining

See Also:

StrBuilder.trim()

withSeverity

BotLogEntryBuilder withSeverity(BotLogSeverity severity)

Sets the severity level using BotLogEntry.setSeverity(BotLogSeverity)

Parameters:

severity - the severity level of BotLogEntry

Returns:

this, to enable chaining

withException

BotLogEntryBuilder withException(Throwable exception)

Sets the exception that would be accompanied with this message

Parameters:

exception - the Exception which would be accompanied with this message

Returns:

this, to enable chaining

push

void push()

Calls BotLogger.log(BotLogEntry) to write message to a logging stream