agi.foundation.infrastructure

(agi.foundation.core-2024r3.jar)

Class HierarchicalLogger

java.lang.Object

agi.foundation.infrastructure.HierarchicalLogger

All Implemented Interfaces:

IDisposable, AutoCloseable

public final class HierarchicalLogger
extends Object
implements IDisposable

A simple hierarchical logging mechanism. Multiple sub-tasks (indicated by a call to HierarchicalLogger.push()) can log simultaneously from different threads and the output will be serialized in the log file.

Constructor Summary

Constructors

Constructor and Description
HierarchicalLogger(String fileName) Initializes a new instance to log to a specified file.
HierarchicalLogger(Writer writer) Initializes a new instance to log to a specified Writer.

Method Summary

Modifier and Type	Method and Description
void	dispose() Finishes logging for this sub-task and writes its output to either the log file or its parent sub-task.
boolean	getReportFunctionExplorerDetails() Gets a value indicating whether to report details from the Function Explorers as well.
HierarchicalLogger	pop() Finishes logging for this sub-task and writes its output to either the log file or its parent sub-task.
HierarchicalLogger	push() Begins a new sub-task.
void	setReportFunctionExplorerDetails(boolean value) Sets a value indicating whether to report details from the Function Explorers as well.
void	writeLine(String line) Writes a line of text to the log.
void	writeLine(String line, Object... arg) Writes a line of text to the log.

Methods inherited from class java.lang.Object

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

Methods inherited from interface agi.foundation.compatibility.IDisposable

close

Constructor Detail

HierarchicalLogger

public HierarchicalLogger(@Nonnull
                          String fileName)

Initializes a new instance to log to a specified file.

Parameters:

fileName - The name of the file to which to log.

HierarchicalLogger

public HierarchicalLogger(@Nonnull
                          Writer writer)

Initializes a new instance to log to a specified Writer.

Parameters:

writer - The stream to which to log.

Method Detail

dispose

public final void dispose()

Finishes logging for this sub-task and writes its output to either the log file or its parent sub-task.

Specified by:

dispose in interface IDisposable

push

public final HierarchicalLogger push()

Begins a new sub-task. Multiple sub-tasks can log in parallel and their output will be serialized in the log file. In other words, the log file will contain the entire output from one sub-task followed by the entire output from the next sub-task. You must call HierarchicalLogger.pop() or IDisposable.close() on the returned instance when the sub-task completes.

Returns:

A new logger than can be used to log data for the sub-task.

pop

public final HierarchicalLogger pop()

Finishes logging for this sub-task and writes its output to either the log file or its parent sub-task.

Returns:

The logged for the parent sub-task.

writeLine

public final void writeLine(String line)

Writes a line of text to the log.

Parameters:

line - The line to write to the log.

writeLine

public final void writeLine(String line,
                            Object... arg)

Writes a line of text to the log.

Parameters:

line - The line to write to the log, is the dame format as string.Format() would take.

arg - List of arguments agreeing with the formatting in line.

getReportFunctionExplorerDetails

public final boolean getReportFunctionExplorerDetails()

Gets a value indicating whether to report details from the Function Explorers as well. Default is false.

setReportFunctionExplorerDetails

public final void setReportFunctionExplorerDetails(boolean value)

Sets a value indicating whether to report details from the Function Explorers as well. Default is false.