ca.randolf.io

Class Log.Entry

Object

ca.randolf.io.Log.Entry

Enclosing class:

Log

public class Log.Entry
extends Object

Log entry object. This is used internally for more efficient handling of log entries on the single internal queue.

Constructor Summary

Constructors

Constructor and Description
Entry(int type, String pre, String msg) Instantiate an Entry for the Log. The timestamp is initialized automatically to the current time and date.
Entry(int type, String pre, java.time.ZonedDateTime dt, String msg) Instantiate an Entry for the Log using a specific timestamp.

Method Summary

Modifier and Type	Method and Description
String	toString() Provide log-suitable-formatted output version of this object. If the pre-amble portion is NULL, then it is excluded (along with its delimiting space). If the message portion is NULL, then it is excluded (along with its delimiting space).
String	toStringN() Provide log-suitable-formatted output version of this object. If the pre-amble portion is NULL, then it is excluded (along with its delimiting space). If the message portion is NULL, then it is excluded (along with its delimiting space).

Methods inherited from class Object

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

Constructor Detail

Entry

public Entry(int type,
             String pre,
             String msg)

Instantiate an Entry for the Log. The timestamp is initialized automatically to the current time and date.

Parameters:

type - Must be Log.LOG (akin to stdout) or Log.ERR (akin to stderr)

pre - Log pre-amble (the portion before the timestamp)

msg - Log message (the portion after the timestamp)

Throws:

TypeNotPresentException - If the type is invalid

Entry

public Entry(int type,
             String pre,
             java.time.ZonedDateTime dt,
             String msg)

Instantiate an Entry for the Log using a specific timestamp.

Parameters:

type - Must be Log.LOG (akin to stdout) or Log.ERR (akin to stderr)

pre - Log pre-amble (the portion before the timestamp)

dt - Timestamp

msg - Log message (the portion after the timestamp)

Throws:

TypeNotPresentException - If the type is invalid

Method Detail

toString

public String toString()

Provide log-suitable-formatted output version of this object. If the pre-amble portion is NULL, then it is excluded (along with its delimiting space). If the message portion is NULL, then it is excluded (along with its delimiting space).

Overrides:

toString in class Object

Returns:

String output

toStringN

public String toStringN()

Provide log-suitable-formatted output version of this object. If the pre-amble portion is NULL, then it is excluded (along with its delimiting space). If the message portion is NULL, then it is excluded (along with its delimiting space).

Returns:

String output with System.lineSeparator() appended.