Package io.atomix.utils.logging

Class LoggerContext.Builder

java.lang.Object

io.atomix.utils.logging.LoggerContext.Builder

All Implemented Interfaces:

Builder<LoggerContext>

Enclosing class:

LoggerContext

public static class LoggerContext.Builder
extends Object
implements Builder<LoggerContext>

Contextual logger builder.

Constructor Summary

Constructors

Constructor	Description
Builder(String name)

Method Summary

Modifier and Type	Method	Description
LoggerContext.Builder	add(String name, boolean value)	Adds a name/value pair to the formatted output in name=value format.
LoggerContext.Builder	add(String name, char value)	Adds a name/value pair to the formatted output in name=value format.
LoggerContext.Builder	add(String name, double value)	Adds a name/value pair to the formatted output in name=value format.
LoggerContext.Builder	add(String name, float value)	Adds a name/value pair to the formatted output in name=value format.
LoggerContext.Builder	add(String name, int value)	Adds a name/value pair to the formatted output in name=value format.
LoggerContext.Builder	add(String name, long value)	Adds a name/value pair to the formatted output in name=value format.
LoggerContext.Builder	add(String name, Object value)	Adds a name/value pair to the formatted output in name=value format.
LoggerContext.Builder	addValue(boolean value)	Adds an unnamed value to the formatted output.
LoggerContext.Builder	addValue(char value)	Adds an unnamed value to the formatted output.
LoggerContext.Builder	addValue(double value)	Adds an unnamed value to the formatted output.
LoggerContext.Builder	addValue(float value)	Adds an unnamed value to the formatted output.
LoggerContext.Builder	addValue(int value)	Adds an unnamed value to the formatted output.
LoggerContext.Builder	addValue(long value)	Adds an unnamed value to the formatted output.
LoggerContext.Builder	addValue(Object value)	Adds an unnamed value to the formatted output.
LoggerContext	build()	Builds the object.
LoggerContext.Builder	omitNullValues()	Configures the MoreObjects.ToStringHelper so Object.toString() will ignore properties with null value.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder(String name)

Method Detail

omitNullValues

@CanIgnoreReturnValue
public LoggerContext.Builder omitNullValues()

Configures the MoreObjects.ToStringHelper so Object.toString() will ignore properties with null value. The order of calling this method, relative to the add()/addValue() methods, is not significant.

add

@CanIgnoreReturnValue
public LoggerContext.Builder add(String name,
                                 Object value)

Adds a name/value pair to the formatted output in name=value format. If value is null, the string "null" is used, unless omitNullValues() is called, in which case this name/value pair will not be added.

add

@CanIgnoreReturnValue
public LoggerContext.Builder add(String name,
                                 boolean value)

Adds a name/value pair to the formatted output in name=value format.

add

@CanIgnoreReturnValue
public LoggerContext.Builder add(String name,
                                 char value)

Adds a name/value pair to the formatted output in name=value format.

add

@CanIgnoreReturnValue
public LoggerContext.Builder add(String name,
                                 double value)

Adds a name/value pair to the formatted output in name=value format.

add

@CanIgnoreReturnValue
public LoggerContext.Builder add(String name,
                                 float value)

Adds a name/value pair to the formatted output in name=value format.

add

@CanIgnoreReturnValue
public LoggerContext.Builder add(String name,
                                 int value)

Adds a name/value pair to the formatted output in name=value format.

add

@CanIgnoreReturnValue
public LoggerContext.Builder add(String name,
                                 long value)

Adds a name/value pair to the formatted output in name=value format.

addValue

@CanIgnoreReturnValue
public LoggerContext.Builder addValue(Object value)

Adds an unnamed value to the formatted output.

It is strongly encouraged to use add(String, Object) instead and give value a readable name.

addValue

@CanIgnoreReturnValue
public LoggerContext.Builder addValue(boolean value)

Adds an unnamed value to the formatted output.

It is strongly encouraged to use add(String, boolean) instead and give value a readable name.

addValue

@CanIgnoreReturnValue
public LoggerContext.Builder addValue(char value)

Adds an unnamed value to the formatted output.

It is strongly encouraged to use add(String, char) instead and give value a readable name.

addValue

@CanIgnoreReturnValue
public LoggerContext.Builder addValue(double value)

Adds an unnamed value to the formatted output.

It is strongly encouraged to use add(String, double) instead and give value a readable name.

addValue

@CanIgnoreReturnValue
public LoggerContext.Builder addValue(float value)

Adds an unnamed value to the formatted output.

It is strongly encouraged to use add(String, float) instead and give value a readable name.

addValue

@CanIgnoreReturnValue
public LoggerContext.Builder addValue(int value)

Adds an unnamed value to the formatted output.

It is strongly encouraged to use add(String, int) instead and give value a readable name.

addValue

@CanIgnoreReturnValue
public LoggerContext.Builder addValue(long value)

Adds an unnamed value to the formatted output.

It is strongly encouraged to use add(String, long) instead and give value a readable name.

build

public LoggerContext build()

Description copied from interface: Builder

Builds the object.

The returned object may be a new instance of the built class or a recycled instance, depending on the semantics of the builder implementation. Users should never assume that a builder allocates a new instance.

Specified by:

build in interface Builder<LoggerContext>

Returns:

The built object.