org.macroing.cit.logger

Class LoggerMessage

java.lang.Object

org.macroing.cit.logger.LoggerMessage

All Implemented Interfaces:

org.macroing.cit.messaging.Message

public final class LoggerMessage
extends java.lang.Object
implements org.macroing.cit.messaging.Message

A Message extension containing various information about a log from a Logger.

This class is immutable and thus suitable for concurrent use without external synchronization.

Since:

1.0.0

Author:

Jörgen Lundgren

Method Summary

Modifier and Type	Method and Description
java.util.Optional<java.lang.Throwable>	getCause() Returns the optional cause.
Level	getLevel() Returns the Level used for the log.
org.macroing.cit.messaging.Message	getMessage() Returns the Message that contains the text for the log.
java.lang.String	getName() Returns the name of the Logger.
static LoggerMessage	newInstance(java.lang.String name, org.macroing.cit.messaging.Message message, Level level) Returns a new LoggerMessage.
static LoggerMessage	newInstance(java.lang.String name, org.macroing.cit.messaging.Message message, Level level, java.lang.Throwable cause) Returns a new LoggerMessage.
static LoggerMessage	newInstance(java.lang.String name, java.lang.String message, Level level) Returns a new LoggerMessage.
static LoggerMessage	newInstance(java.lang.String name, java.lang.String message, Level level, java.lang.Throwable cause) Returns a new LoggerMessage.
java.lang.String	toString() Returns a String representation of this LoggerMessage instance.

Methods inherited from class java.lang.Object

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

Method Detail

getLevel

public Level getLevel()

Returns the Level used for the log.

Returns:

the Level used for the log

getMessage

public org.macroing.cit.messaging.Message getMessage()

Returns the Message that contains the text for the log.

Returns:

the Message that contains the text for the log

getCause

public java.util.Optional<java.lang.Throwable> getCause()

Returns the optional cause.

Returns:

the optional cause

getName

public java.lang.String getName()

Returns the name of the Logger.

Returns:

the name of the Logger

toString

public java.lang.String toString()

Returns a String representation of this LoggerMessage instance.

Overrides:

toString in class java.lang.Object

Returns:

a String representation of this LoggerMessage instance

newInstance

public static LoggerMessage newInstance(java.lang.String name,
                                        org.macroing.cit.messaging.Message message,
                                        Level level)

Returns a new LoggerMessage.

If either name, message or level are null, a NullPointerException will be thrown.

Parameters:

name - the name of the Logger

message - the Message that contains the text for the log

level - the Level used for the log

Returns:

a new LoggerMessage

Throws:

java.lang.NullPointerException - thrown if, and only if, either name, message or level are null

newInstance

public static LoggerMessage newInstance(java.lang.String name,
                                        org.macroing.cit.messaging.Message message,
                                        Level level,
                                        java.lang.Throwable cause)

Returns a new LoggerMessage.

If either name, message, level or cause are null, a NullPointerException will be thrown.

Parameters:

name - the name of the Logger

message - the Message that contains the text for the log

level - the Level used for the log

cause - the cause

Returns:

a new LoggerMessage

Throws:

java.lang.NullPointerException - thrown if, and only if, either name, message, level or cause are null

newInstance

public static LoggerMessage newInstance(java.lang.String name,
                                        java.lang.String message,
                                        Level level)

Returns a new LoggerMessage.

If either name, message or level are null, a NullPointerException will be thrown.

Parameters:

name - the name of the Logger

message - the String that contains the text for the log

level - the Level used for the log

Returns:

a new LoggerMessage

Throws:

java.lang.NullPointerException - thrown if, and only if, either name, message or level are null

newInstance

public static LoggerMessage newInstance(java.lang.String name,
                                        java.lang.String message,
                                        Level level,
                                        java.lang.Throwable cause)

Returns a new LoggerMessage.

If either name, message, level or cause are null, a NullPointerException will be thrown.

Parameters:

name - the name of the Logger

message - the String that contains the text for the log

level - the Level used for the log

cause - the cause

Returns:

a new LoggerMessage

Throws:

java.lang.NullPointerException - thrown if, and only if, either name, message, level or cause are null